com.ibm.dse.gui
Class OperationPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.ibm.dse.gui.SpPanel
                                |
                                +--com.ibm.dse.gui.DSECoordinatedPanel
                                      |
                                      +--com.ibm.dse.gui.OperationPanel
Direct Known Subclasses:
EJViewer

public class OperationPanel
extends DSECoordinatedPanel

The OperationPanel class represents the external panel that should be used in views. It can contain the visual components as SpTextField, SpLabel,... and also the embedded panels. The Operation property is used to link the view with the model.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Fields inherited from class com.ibm.dse.gui.DSECoordinatedPanel
aExceptionInOperationListener, executeNextView, externalizer
 
Fields inherited from class com.ibm.dse.gui.SpPanel
NULL_VALUE, refreshing
 
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.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
OperationPanel()
          This constructor creates an OperationPanel object.
OperationPanel(boolean isDoubleBuffered)
          This constructor creates an OperationPanel object.
OperationPanel(java.awt.LayoutManager layout)
          This constructor creates an OperationPanel object.
OperationPanel(java.awt.LayoutManager layout, boolean isDoubleBuffered)
          This constructor creates an OperationPanel object.
OperationPanel(Operation o)
          This constructor creates an OperationPanel object.
 
Method Summary
 void chainTo(Context aContext)
          Sets the receiving context as a child of aContext and as the new current child.
 void chainToContextNamed(java.lang.String aContextName)
          Sets the context as a child of the context named aContextName in the hierarchy.
 void dataChanged(DSECoordinationEvent dce)
          Manages the appropriate actions when a DSECoordinationEvent has been sent and refesh property is true.
 void executeOper(java.lang.String operation, int chaining, java.lang.String inputFormat, java.lang.String outputFormat)
          Execute an Operation
static OperationPanel getOperationPanel(java.awt.Component c)
          Returns the panel that contains the component passed as argument.
static OperationPanel getOperationPanelParent(java.awt.Component c)
          Returns the panel that contains the component passed as argument.
 void handleDataChanged(DataChangedEvent dce)
          Deprecated. use DSECoordinatedEvents
 void handleDSECoordinationEvent(DSECoordinationEvent event)
          Contains the appropriate actions to be executed when DSECoordinationEvent has been triggered.
 boolean isChained()
          Returns true if the context is chained to the hierarchy.
 boolean isCorrectStatus()
          Decides if the panel is in a correct status or not.
 void refreshDataExchangers()
          Updates the panel with the data exchangers context values.
 void setContextName(java.lang.String contextName, boolean mInstance)
          Sets the contextName property (java.lang.String) value.
 void setValueAt(java.lang.String aCompositeKey, java.lang.Object aDataValue)
          Sets the value of the element of its context, or context parent, which is located at aCompositeKey path.
 void unchain()
          Removes the operation context from the context hierarchy.
 
Methods inherited from class com.ibm.dse.gui.DSECoordinatedPanel
addCoordinatedEventListener, addExceptionInOperationListener, addToChildrenInErrorList, addToExecuteButtonsList, addToNextButtonsList, addToPrevButtonsList, addToRequiredNotFilledList, ancestor, ancestorAdded, ancestorMoved, ancestorRemoved, becomingActiveActions, becomingUnactiveActions, clearPanelContents, close, close, close, commit, convertFromEuros, convertToEuros, disposePanel, enableExecuteButton, enableNextButton, enableOkButton, enableOkButton, enablePreviousButton, externalizer, fireCoordinationEvent, fireCoordinationEvent, fireHandleExceptionInOperation, get_EMUCurrencyButton, get_EuroButton, get_HelpButton, get_OkButton, getCheckBoxesAndButtonGroupsInitialized, getChildrenInError, getChildrenNotFilled, getClassForHelpImplementation, getContext, getDataExchangers, getDisableWhileOperationRunning, getDSECoordinatedPanel, getDSECoordinatedPanelParent, getEMUCurrency, getExecuteButtons, getExecuteWhenOpen, getExternalizer, getIconName, getInstanceOperation, getIsInEuros, getListOfCheckBoxes, getNextButtons, getOperation, getOperationName, getOutsiders, getPrevButtons, getReplyOperationName, getReplyOutputFormatName, getSavedData, getTitle, getValidationMethod, getValueAt, getViewName, handleErrorMessage, handleOperationRepliedEvent, initializeFrom, instanceOperationIfNecessary, isClosable, isFirstVisible, manageHelp, postInitialize, readExternal, readExternal, readObject, refresh, register, register, registerOutsider, removeCoordinatedEventListener, removeDataExchanger, removeExceptionInOperationListener, removeExternal, removeFromChildrenInErrorList, removeFromExecuteButtonsList, removeFromNextButtonsList, removeFromRequiredNotFilledList, rollBack, saveData, set_EMUCurrencyButton, set_EuroButton, set_HelpButton, set_OkButton, setCheckBoxesAndButtonGroupsInitialized, setChildrenInError, setChildrenNotFilled, setClassForHelpImplementation, setClosable, setContext, setDataExchangers, setDisableWhileOperationRunning, setEMUCurrency, setExecuteWhenOpen, setExternalizer, setFirstVisible, setIconName, setInstanceOperation, setIsInEuros, setListOfCheckBoxes, setOperation, setOperationName, setOperationName, setOutsiders, setReplyOperationName, setReplyOutputFormatName, setSavedData, setTitle, setValidationMethod, setViewName, toStrings, toTags, tryRunOperation, writeExternal, writeExternal
 
Methods inherited from class com.ibm.dse.gui.SpPanel
actionPerformed, add, add, add, add, add, changeComponentOrientation, clear, clearDataDirection, clearDataExchangersScrolls, enableListScrolls, get_ClearButton, get_RepeatButton, getActivatedOkKey, getClearOutputData, getComponents, getEditable, getEnableStateElements, getErrorBean, getErrorLabel, getHelpID, getHelpID, getSpPanel, getSpPanelParent, init, key, keyPressed, keyReleased, keyTyped, manageHelp, repeat, repeatDataExchangersScrolls, saveEnabledStateComponents, set_ClearButton, set_RepeatButton, setActivatedOkKey, setClearOutputData, setEditable, setEnabled, setEnableStateElements, setErrorBean, setErrorLabel, setHelpID, setVisible
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OperationPanel

public OperationPanel()
This constructor creates an OperationPanel object.

OperationPanel

public OperationPanel(Operation o)
This constructor creates an OperationPanel object.

OperationPanel

public OperationPanel(java.awt.LayoutManager layout)
This constructor creates an OperationPanel object.
Parameters:
layout - java.awt.LayoutManager

OperationPanel

public OperationPanel(java.awt.LayoutManager layout,
                      boolean isDoubleBuffered)
This constructor creates an OperationPanel object.
Parameters:
layout - java.awt.LayoutManager
isDoubleBuffered - boolean

OperationPanel

public OperationPanel(boolean isDoubleBuffered)
This constructor creates an OperationPanel object.
Parameters:
isDoubleBuffered - boolean
Method Detail

chainTo

public void chainTo(Context aContext)
             throws DSEInvalidRequestException
Sets the receiving context as a child of aContext and as the new current child. Refer to the Context class chainTo method for an example of implementing this method.

This method throws a DSEInvalidRequestException.


chainToContextNamed

public void chainToContextNamed(java.lang.String aContextName)
                         throws DSEInvalidRequestException,
                                DSEObjectNotFoundException
Sets the context as a child of the context named aContextName in the hierarchy. The receiving context is set as the new curent child. If there is more than one context with this name, one of them is choosen at random. Refer to the Context class chainToContextNamed method for an example of implementing this method.

This method throws a DSEInvalidRequestException generated by the chainTo method and throws a DSEObjectNotFoundException if context parent is not found.


dataChanged

public void dataChanged(DSECoordinationEvent dce)
Manages the appropriate actions when a DSECoordinationEvent has been sent and refesh property is true.
Overrides:
dataChanged in class DSECoordinatedPanel
Parameters:
dce - com.ibm.dse.gui.DSECoordinationEvent

executeOper

public void executeOper(java.lang.String operation,
                        int chaining,
                        java.lang.String inputFormat,
                        java.lang.String outputFormat)
Execute an Operation
Parameters:
java.lang.String - operation, operation name to execute
int - chaining, operation context chains to Active Context, Parent Context, Root Context or unChained.
String - inputFormat, map format beetwen active context and Operation Context before execute operation.
String - outputFormat, map format beetwen active context and Operation Context after execute operation.

getOperationPanel

public static OperationPanel getOperationPanel(java.awt.Component c)
Returns the panel that contains the component passed as argument. It could be itself, its parent, grandparent etc.
Parameters:
c - Component, the component
Returns:
OperationPanel, the operation panel where the component is located

getOperationPanelParent

public static OperationPanel getOperationPanelParent(java.awt.Component c)
Returns the panel that contains the component passed as argument. It could be its parent, grandparent etc.
Parameters:
c - Component, the component
Returns:
OperationPanel, the operation panel where the component is located

handleDataChanged

public void handleDataChanged(DataChangedEvent dce)
Deprecated. use DSECoordinatedEvents

Manages the appropriate actions when a DataChangedEvent has been sent.
Parameters:
dce - com.ibm.dse.gui.DataChangedEvent

handleDSECoordinationEvent

public void handleDSECoordinationEvent(DSECoordinationEvent event)
Contains the appropriate actions to be executed when DSECoordinationEvent has been triggered.
Overrides:
handleDSECoordinationEvent in class DSECoordinatedPanel
Parameters:
event - DSECoordinationEvent

isChained

public boolean isChained()
Returns true if the context is chained to the hierarchy.

isCorrectStatus

public boolean isCorrectStatus()
Decides if the panel is in a correct status or not. An DSECoordinatedPanel is in a correct status when all of the required fields are filled with correct values. If there are validation methods, they are executed and must return true.
Overrides:
isCorrectStatus in class DSECoordinatedPanel

refreshDataExchangers

public void refreshDataExchangers()
Updates the panel with the data exchangers context values.
Overrides:
refreshDataExchangers in class DSECoordinatedPanel

setContextName

public void setContextName(java.lang.String contextName,
                           boolean mInstance)
Sets the contextName property (java.lang.String) value. Complies with the CoordinatedPanelInteface interface.
Parameters:
contextName - String, the new value for the property
mInstance - boolean, if true makes an instance of the context.

setValueAt

public void setValueAt(java.lang.String aCompositeKey,
                       java.lang.Object aDataValue)
                throws DSEInvalidArgumentException,
                       DSEObjectNotFoundException
Sets the value of the element of its context, or context parent, which is located at aCompositeKey path.

unchain

public void unchain()
             throws DSEInvalidRequestException,
                    DSEObjectNotFoundException
Removes the operation context from the context hierarchy. The parent attribute is set to null and the operation context is removed from the children list in the parent context. The receiving context cannot have children. Refer to the Context class unchain method for an example of implementing this method.

This method throws a DSEInvalidRequestException and throws a DSEObjectNotFoundException.