|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
com.ibm.dse.gui.SpPanel
The SpPanel class is an abstract class with a common behavior for the CoordinatedPanel and the EmbeddedPanel.
Nested Class Summary | |
---|---|
(package private) class |
SpPanel.ErrorBeanLabel
|
Nested classes inherited from class javax.swing.JPanel |
---|
javax.swing.JPanel.AccessibleJPanel |
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 | |
---|---|
protected static java.lang.String |
NULL_VALUE
Representation of null value for a data exchanger. |
protected static boolean |
refreshing
If the panel is being refreshed or not. |
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 java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
SpPanel()
This constructor creates a SpPanel object. |
|
SpPanel(boolean isDoubleBuffered)
This constructor creates a SpPanel object. |
|
SpPanel(java.awt.LayoutManager layout)
This constructor creates a SpPanel object. |
|
SpPanel(java.awt.LayoutManager layout,
boolean isDoubleBuffered)
This constructor creates a SpPanel object. |
Method Summary | |
---|---|
java.awt.Component |
add(java.awt.Component comp)
When adding a component to the panel, the panel registers itself as interested in the Key events generated by the component. |
java.awt.Component |
add(java.awt.Component comp,
int index)
When adding a component to the panel, the panel registers itself as interested in the Key events generated by the component. |
void |
add(java.awt.Component comp,
java.lang.Object constraints)
When adding a component to the panel, the panel registers itself as interested in the Key events generated by the component. |
void |
add(java.awt.Component comp,
java.lang.Object constraints,
int index)
When adding a component to the panel, the panel registers itself as interested in the Key events generated by the component. |
java.awt.Component |
add(java.lang.String name,
java.awt.Component comp)
Adds the specified component to this container. |
void |
changeComponentOrientation(java.awt.ComponentOrientation o)
Set the language-sensitive orientation that is to be used to order the elements within this component. |
void |
clear(java.lang.String typeClear)
Clears all the components in the panel according to the clear option passed as argument. |
protected boolean |
clearDataDirection(java.lang.String typeClear,
java.lang.String typeDataExchanger)
Returns if typeDataExchanger clear option is affected by typeClear clear option. |
protected void |
clearDataExchangersScrolls(java.lang.String typeClear)
Clears all the scroll panes in the panel according to the clear option passed as argument. |
protected void |
enableListScrolls(boolean isEnabled)
Enables all the scroll panes in the panel according to the boolean passed as argument. |
SpButton |
get_ClearButton()
Gets the clearButton property (com.ibm.dse.gui.SpButton) value. |
SpButton |
get_OkButton()
Gets the okButton property (com.ibm.dse.gui.SpButton) value. |
SpButton |
get_RepeatButton()
Gets the repeatButton property (com.ibm.dse.gui.SpButton) value. |
boolean |
getActivatedOkKey()
Gets the activatedOkKey property (boolean) value. |
boolean |
getClearOutputData()
Gets the clearOutputData property (boolean) value. |
protected java.util.Vector |
getComponents(java.lang.Class c)
Gets all components (and components inside their components) instance of Class c |
boolean |
getEditable()
Gets the editable property (boolean) value. |
java.util.Vector |
getEnableStateElements()
Gets the enableStateElements property (java.util.Vector) value. |
ErrorVisualBean |
getErrorBean()
Gets the errorBean property (com.ibm.dse.gui.ErrorVisualBean) value. |
javax.swing.JLabel |
getErrorLabel()
Deprecated. (use getErrorBean()) |
java.lang.String |
getHelpID()
Gets the helpID property (java.lang.String) value. |
java.lang.String |
getHelpID(java.awt.Component c)
Gets the helpID property (java.lang.String) value. |
java.util.Vector |
getOutsiders()
Gets the outsiders property (java.util.Vector) value. |
static SpPanel |
getSpPanel(java.awt.Component c)
Returns the panel that contains the component passed as argument. |
static SpPanel |
getSpPanelParent(java.awt.Component c)
Returns the panel that contains the component passed as argument. |
void |
handleDSECoordinationEvent(DSECoordinationEvent event)
Contains the appropriate actions to be executed when DSECoordinationEvent has been triggered. |
void |
handleErrorMessage(ErrorMessageEvent eme)
Manages the appropriate actions when an ErrorMessageEvent has been sent. |
void |
init()
Registers itself as key listener. |
void |
key(java.awt.event.KeyEvent e)
Manages the appropriate actions in case key is 'help key' or 'ok key' or 'tab key'. |
void |
keyPressed(java.awt.event.KeyEvent e)
Method to handle events for the KeyListener interface. |
void |
keyReleased(java.awt.event.KeyEvent e)
Method to handle events for the KeyListener interface. |
void |
keyTyped(java.awt.event.KeyEvent e)
Method to handle events for the KeyListener interface. |
void |
manageHelp(java.awt.Component c)
Invoked when a help key has been pressed in some SpPanel Component "c".Gets the HelpID property from this component and executes DSECoordinatedPanel manageHelp method with HelpID property. |
protected void |
register(java.awt.Component c)
Registers the component passed as argument as appropriate: In case is a DataExchanger, it is registered in the DSECoordinatedPanel associated to the panel In case is a JTabbedPane, JPanel or JScrollPane, their internal components are registered In case is a SpErrorLabel, the errorLabel property is updated In case is a Clear or Repeat button, the clearButton or repeatButton properties are updated |
void |
registerOutsider(Outsider outsider)
Registers the outsider in the DSECoordinatedPanel associated to the panel. |
void |
repeat()
Retrieves all the components values in the panel since the last operation execution. |
void |
repeatDataExchangersScrolls()
Retrieves all the components values of components located in scrollPanes in the panel since the last operation execution. |
protected void |
saveEnabledStateComponents()
Saves the enabling state for each component in the panel. |
void |
set_ClearButton(SpButton clearButton)
Sets the clearButton property (com.ibm.dse.gui.SpButton) value. |
void |
set_RepeatButton(SpButton repeatButton)
Sets the repeatButton property (com.ibm.dse.gui.SpButton) value. |
void |
setActivatedOkKey(boolean activatedOkKey)
Sets the activatedOkKey property (boolean) value. |
void |
setClearOutputData(boolean clearOutputData)
Sets the clearOutputData property (boolean) value. |
void |
setEditable(boolean isEditable)
Makes editable or not all the components that compose the panel. |
void |
setEnabled(boolean isEnabled)
Makes enabled or not all the components that compose the panel. |
void |
setEnableStateElements(java.util.Vector enableStateElements)
Sets the enableStateElements property (java.util.Vector) value. |
void |
setErrorBean(ErrorVisualBean errorBean)
Sets the errorBean property (com.ibm.dse.gui.ErrorVisualBean) value. |
void |
setErrorLabel(javax.swing.JLabel errorLabel)
Deprecated. (use setErrorBean(ErrorVisualBean)) |
void |
setHelpID(java.lang.String helpID)
Sets the helpID property (java.lang.String) value. |
void |
setVisible(boolean isVisible)
Makes visible or not all the components that compose the panel. |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, isValidateRoot, 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, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update |
Methods inherited from class java.awt.Container |
---|
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, setLayout, 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, setComponentOrientation, 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 |
Field Detail |
protected static boolean refreshing
protected static java.lang.String NULL_VALUE
Constructor Detail |
public SpPanel()
public SpPanel(java.awt.LayoutManager layout)
layout
- java.awt.LayoutManagerpublic SpPanel(java.awt.LayoutManager layout, boolean isDoubleBuffered)
layout
- java.awt.LayoutManagerisDoubleBuffered
- booleanpublic SpPanel(boolean isDoubleBuffered)
isDoubleBuffered
- booleanMethod Detail |
public java.awt.Component add(java.awt.Component comp)
comp
- the component to be added
public java.awt.Component add(java.awt.Component comp, int index)
comp
- the component to be addedindex
- the position at which to insert the component,or -1
to insert the component at the end.
public void add(java.awt.Component comp, java.lang.Object constraints)
comp
- the component to be addedconstraints
- an object expressing layout contraints for this componentLayoutManager
public void add(java.awt.Component comp, java.lang.Object constraints, int index)
comp
- the component to be addedconstraints
- an object expressing layout contraints for this componentindex
- the position at which to insert the component,or -1
to insert the component at the end.LayoutManager
public java.awt.Component add(java.lang.String name, java.awt.Component comp)
public void changeComponentOrientation(java.awt.ComponentOrientation o)
public void clear(java.lang.String typeClear)
typeClear
- String, the clear optionprotected boolean clearDataDirection(java.lang.String typeClear, java.lang.String typeDataExchanger)
typeClear
- String, a clear optiontypeDataExchanger
- String, the data exchanger clear option
protected void clearDataExchangersScrolls(java.lang.String typeClear)
typeClear
- String, the clear optionprotected void enableListScrolls(boolean isEnabled)
isEnabled
- booleanpublic SpButton get_ClearButton()
#setClearButton
public SpButton get_OkButton()
#setOkButton
public SpButton get_RepeatButton()
#setRepeatButton
public boolean getActivatedOkKey()
getActivatedOkKey
in interface GUIComponent
setActivatedOkKey(boolean)
public boolean getClearOutputData()
setClearOutputData(boolean)
protected java.util.Vector getComponents(java.lang.Class c)
c
- java.lang.Class
public boolean getEditable()
setEditable(boolean)
public java.util.Vector getEnableStateElements()
setEnableStateElements(java.util.Vector)
public ErrorVisualBean getErrorBean()
setErrorBean(com.ibm.dse.gui.ErrorVisualBean)
public javax.swing.JLabel getErrorLabel()
public java.lang.String getHelpID()
setHelpID(java.lang.String)
public java.lang.String getHelpID(java.awt.Component c)
setHelpID(java.lang.String)
public java.util.Vector getOutsiders()
#setOutsiders
public static SpPanel getSpPanel(java.awt.Component c)
c
- java.awt.Component, a component
public static SpPanel getSpPanelParent(java.awt.Component c)
c
- java.awt.Component, a component
public void handleDSECoordinationEvent(DSECoordinationEvent event)
event
- DSECoordinationEventpublic void handleErrorMessage(ErrorMessageEvent eme)
handleErrorMessage
in interface ErrorMessageListener
eme
- com.ibm.dse.gui.ErrorMessageEventpublic void init()
public void key(java.awt.event.KeyEvent e)
public void keyPressed(java.awt.event.KeyEvent e)
keyPressed
in interface java.awt.event.KeyListener
e
- java.awt.event.KeyEventpublic void keyReleased(java.awt.event.KeyEvent e)
keyReleased
in interface java.awt.event.KeyListener
e
- java.awt.event.KeyEventpublic void keyTyped(java.awt.event.KeyEvent e)
keyTyped
in interface java.awt.event.KeyListener
e
- java.awt.event.KeyEventpublic void manageHelp(java.awt.Component c)
protected void register(java.awt.Component c)
c
- Component, the component to be registeredpublic void registerOutsider(Outsider outsider)
outsider
- Outsiderpublic void repeat()
public void repeatDataExchangersScrolls()
protected void saveEnabledStateComponents()
public void set_ClearButton(SpButton clearButton)
clearButton
- boolean, the new value for the property#getClearButton
public void set_RepeatButton(SpButton repeatButton)
repeatButton
- boolean, the new value for the property#getRepeatButton
public void setActivatedOkKey(boolean activatedOkKey)
setActivatedOkKey
in interface GUIComponent
activatedOkKey
- boolean, the new value for the propertygetActivatedOkKey()
public void setClearOutputData(boolean clearOutputData)
clearOutputData
- boolean, the new value for the propertygetClearOutputData()
public void setEditable(boolean isEditable)
public void setEnabled(boolean isEnabled)
public void setEnableStateElements(java.util.Vector enableStateElements)
enableStateElements
- boolean, the new value for the propertygetEnableStateElements()
public void setErrorBean(ErrorVisualBean errorBean)
errorBean
- The new value for the property.getErrorBean()
public void setErrorLabel(javax.swing.JLabel errorLabel)
errorLabel
- JLabel, the new value for the propertypublic void setHelpID(java.lang.String helpID)
helpID
- String, the new value for the propertygetHelpID()
public void setVisible(boolean isVisible)
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |