IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class SpErrorList

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JScrollPane
                  extended bycom.ibm.dse.gui.SpErrorList
All Implemented Interfaces:
javax.accessibility.Accessible, ErrorVisualBean, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.ScrollPaneConstants, java.io.Serializable

public class SpErrorList
extends javax.swing.JScrollPane
implements ErrorVisualBean

The SpErrorList class (JScrollPane subclass with a JList) is a Bean that provides a error text list. It can be located in a DSECoordinatedPanel (Operation Panel or DSEPanel) or in an Embedded Panel. When an error happens, the error messages are automatically displayed in this list.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JScrollPane
javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.ScrollPaneConstants
COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
SpErrorList()
          This constructor creates a SpErrorList object.
SpErrorList(java.awt.Component view)
          This constructor creates a SpErrorList object.
SpErrorList(java.awt.Component view, int vsbPolicy, int hsbPolicy)
          This constructor creates a SpErrorList object.
SpErrorList(int vsbPolicy, int hsbPolicy)
          This constructor creates a SpErrorList object.
 
Method Summary
 java.awt.Color getBackgroundColorList()
          Gets the backgroundColorList property (java.awt.Color) value.
 java.awt.Color getForegroundColorList()
          Gets the foregroundColorList property (java.awt.Color) value.
 java.lang.String[] getListText()
          Returns the list of errors text string that the Visual Bean is Showing.
 java.awt.Color getSelectionBackgroundList()
          Gets the selectionBackgroundList property (java.awt.Color) value.
 java.awt.Color getSelectionForegroundList()
          Gets the selectionForegroundList property (java.awt.Color) value.
 java.lang.String getText()
          Returns the first error text string that the Visual Bean is Showing.
static void main(java.lang.String[] args)
          main entrypoint - starts the part when it is run as an application
 void setBackgroundColorList(java.awt.Color backgroundColorList)
          Sets the backgroundColorList property (java.awt.Color) value.
 void setComponentOrientation(java.awt.ComponentOrientation o)
          Set the language-sensitive orientation that is to be used to order the elements or text within this component.
 void setForegroundColorList(java.awt.Color foregroundColorList)
          Sets the foregroundColorList property (java.awt.Color) value.
 void setListText(java.lang.String[] listText)
          Defines the several lines (errors) of text this component will display.
 void setSelectionBackgroundList(java.awt.Color selectionBackgroundList)
          Sets the selectionBackgroundList property (java.awt.Color) value.
 void setSelectionForegroundList(java.awt.Color selectionForegroundList)
          Sets the selectionForegroundList property (java.awt.Color) value.
 void setText(java.lang.String text)
          Defines the single line (error) of text this component will display.
 
Methods inherited from class javax.swing.JScrollPane
createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SpErrorList

public SpErrorList()
This constructor creates a SpErrorList object.


SpErrorList

public SpErrorList(int vsbPolicy,
                   int hsbPolicy)
This constructor creates a SpErrorList object.

Parameters:
vsbPolicy - int
hsbPolicy - int

SpErrorList

public SpErrorList(java.awt.Component view)
This constructor creates a SpErrorList object.

Parameters:
view - java.awt.Component

SpErrorList

public SpErrorList(java.awt.Component view,
                   int vsbPolicy,
                   int hsbPolicy)
This constructor creates a SpErrorList object.

Parameters:
view - java.awt.Component
vsbPolicy - int
hsbPolicy - int
Method Detail

getBackgroundColorList

public java.awt.Color getBackgroundColorList()
Gets the backgroundColorList property (java.awt.Color) value.

Returns:
The backgroundColorList property value.
See Also:
setBackgroundColorList(java.awt.Color)

getForegroundColorList

public java.awt.Color getForegroundColorList()
Gets the foregroundColorList property (java.awt.Color) value.

Returns:
The foregroundColorList property value.
See Also:
setForegroundColorList(java.awt.Color)

getListText

public java.lang.String[] getListText()
Returns the list of errors text string that the Visual Bean is Showing.

Specified by:
getListText in interface ErrorVisualBean
Returns:
String - the list of errors text property value

getSelectionBackgroundList

public java.awt.Color getSelectionBackgroundList()
Gets the selectionBackgroundList property (java.awt.Color) value.

Returns:
The selectionBackgroundList property value.
See Also:
setSelectionBackgroundList(java.awt.Color)

getSelectionForegroundList

public java.awt.Color getSelectionForegroundList()
Gets the selectionForegroundList property (java.awt.Color) value.

Returns:
The selectionForegroundList property value.
See Also:
setSelectionForegroundList(java.awt.Color)

getText

public java.lang.String getText()
Returns the first error text string that the Visual Bean is Showing.

Specified by:
getText in interface ErrorVisualBean
Returns:
String - the first error text property value

main

public static void main(java.lang.String[] args)
main entrypoint - starts the part when it is run as an application

Parameters:
args - java.lang.String[]

setBackgroundColorList

public void setBackgroundColorList(java.awt.Color backgroundColorList)
Sets the backgroundColorList property (java.awt.Color) value.

Parameters:
backgroundColorList - The new value for the property.
See Also:
getBackgroundColorList()

setComponentOrientation

public void setComponentOrientation(java.awt.ComponentOrientation o)
Set the language-sensitive orientation that is to be used to order the elements or text within this component. Language-sensitive LayoutManager and Component subclasses will use this property to determine how to lay out and draw components.

At construction time, a component's orientation is set to ComponentOrientation.UNKNOWN, indicating that it has not been specified explicitly. The UNKNOWN orientation behaves the same as ComponentOrientation.LEFT_TO_RIGHT.

To set the orientation of a single component, use this method. To apply a ResourceBundle's orientation to an entire component hierarchy, use java.awt.Window.applyResourceBundle.


setForegroundColorList

public void setForegroundColorList(java.awt.Color foregroundColorList)
Sets the foregroundColorList property (java.awt.Color) value.

Parameters:
foregroundColorList - The new value for the property.
See Also:
getForegroundColorList()

setListText

public void setListText(java.lang.String[] listText)
Defines the several lines (errors) of text this component will display. If the value of text is null or empty string, nothing is displayed.

Specified by:
setListText in interface ErrorVisualBean
Parameters:
listText - String[], the new value for the several lines (errors) of text

setSelectionBackgroundList

public void setSelectionBackgroundList(java.awt.Color selectionBackgroundList)
Sets the selectionBackgroundList property (java.awt.Color) value.

Parameters:
selectionBackgroundList - The new value for the property.
See Also:
getSelectionBackgroundList()

setSelectionForegroundList

public void setSelectionForegroundList(java.awt.Color selectionForegroundList)
Sets the selectionForegroundList property (java.awt.Color) value.

Parameters:
selectionForegroundList - The new value for the property.
See Also:
getSelectionForegroundList()

setText

public void setText(java.lang.String text)
Defines the single line (error) of text this component will display. If the value of text is null or empty string, nothing is displayed.

Specified by:
setText in interface ErrorVisualBean
Parameters:
text - String, the new value for the single line (error) of text

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005