IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Interface CoordinatedPanel

All Superinterfaces:
CoordinatedEventListener, CoordinatedEventSource, java.util.EventListener
All Known Implementing Classes:
DSECoordinatedPanel

public interface CoordinatedPanel
extends CoordinatedEventListener, CoordinatedEventSource

The CoordinatedPanel interface for all Panel used in Navigation environment


Method Summary
 void becomingActiveActions()
          It is applicable if the panel is used in the desktop.
 void becomingUnactiveActions()
          It is applicable if the panel is used in the desktop.
 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 close(boolean unchainContext)
          Sets null all attributes, close default operation and fires a DSECoordinationEvent (type ViewClosed)
 void commit()
          Makes a checkpoint for possible rollback.
 void enableNextButton(boolean enable)
          Enables/Disables Next Buttons
 void enableOkButton(boolean enable)
          Enables/Disables Ok Buttons
 void enablePreviousButton(boolean enable)
          Enables/Disables Previous Buttons
 Context getContext()
          Gets the context property (com.ibm.dse.base.Context) value.
 java.lang.String getTitle()
          It is applicable if the panel is used in the desktop.
 java.lang.Object getValueAt(java.lang.String aCompositeKey)
          Returns the value of the element of its context, or parent contexts, which is located at aCompositeKey path.
 boolean isChained()
          Returns true if the context is chained to the hierarchy.
 boolean isClosable()
          Returns true if the panel can be closed or not
 void postInitialize()
          It is applicable if the panel is used in the desktop.
 void refresh()
          Refresh view from context
 void rollBack()
          Removes last changes in panle (till last commit)
 void setContext(Context context)
          Sets the context property (com.ibm.dse.base.Context) value.
 void setContextName(java.lang.String contextName, boolean mInstance)
          Sets the contextName property (java.lang.String) value.
 void setName(java.lang.String name)
          Sets the name of the component to the specified string.
 void setOperation(Operation op)
          Sets the operation property (Operation) value.
 void setOperationName(java.lang.String operationName, boolean mInstance)
          Sets the default operationName 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 setViewName(java.lang.String name)
          Sets the name of the component to the specified string.
 void tryRunOperation()
           
 void unchain()
          Removes the context or operation context from the context hierarchy.
 
Methods inherited from interface com.ibm.dse.gui.CoordinatedEventListener
handleDSECoordinationEvent
 
Methods inherited from interface com.ibm.dse.gui.CoordinatedEventSource
addCoordinatedEventListener, fireCoordinationEvent, fireCoordinationEvent, removeCoordinatedEventListener
 

Method Detail

becomingActiveActions

public void becomingActiveActions()
It is applicable if the panel is used in the desktop. This method should be overriden in order to add the actions to execute every time the panel associated to the task is shown.


becomingUnactiveActions

public void becomingUnactiveActions()
It is applicable if the panel is used in the desktop. This method should be overriden in order to add the actions to execute every time the panel associated to the task is hidden.


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.

Throws:
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.

Throws:
DSEInvalidRequestException
DSEObjectNotFoundException

close

public void close(boolean unchainContext)
Sets null all attributes, close default operation and fires a DSECoordinationEvent (type ViewClosed)

Parameters:
unchainContext - boolean, if true context will be unchainded from the hierarchy

commit

public void commit()
Makes a checkpoint for possible rollback.


enableNextButton

public void enableNextButton(boolean enable)
Enables/Disables Next Buttons


enableOkButton

public void enableOkButton(boolean enable)
Enables/Disables Ok Buttons


enablePreviousButton

public void enablePreviousButton(boolean enable)
Enables/Disables Previous Buttons


getContext

public Context getContext()
Gets the context property (com.ibm.dse.base.Context) value.

Returns:
The context property value.

getTitle

public java.lang.String getTitle()
It is applicable if the panel is used in the desktop. Gets the title property (java.lang.String) value.

Returns:
String - the title property value

getValueAt

public java.lang.Object getValueAt(java.lang.String aCompositeKey)
                            throws DSEObjectNotFoundException
Returns the value of the element of its context, or parent contexts, which is located at aCompositeKey path.

Throws:
DSEObjectNotFoundException

isChained

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


isClosable

public boolean isClosable()
Returns true if the panel can be closed or not


postInitialize

public void postInitialize()
It is applicable if the panel is used in the desktop. This method should be overriden in order to add the actions to execute when the panel associated to a task is created.


refresh

public void refresh()
Refresh view from context


rollBack

public void rollBack()
Removes last changes in panle (till last commit)


setContext

public void setContext(Context context)
Sets the context property (com.ibm.dse.base.Context) value.

Parameters:
context - The new value for the property.

setContextName

public void setContextName(java.lang.String contextName,
                           boolean mInstance)
Sets the contextName property (java.lang.String) value.

Parameters:
contextName - String, the new value for the property
mInstance - boolean, if true makes an instance of the context.

setName

public void setName(java.lang.String name)
Sets the name of the component to the specified string.

Parameters:
name - The string that is to be this component's name.

setOperation

public void setOperation(Operation op)
Sets the operation property (Operation) value.

Parameters:
op - Operation, the new value for the property

setOperationName

public void setOperationName(java.lang.String operationName,
                             boolean mInstance)
Sets the default operationName property (java.lang.String) value.

Parameters:
operationName - String, the new value for the property
mInstance - boolean, if true makes an instance of the operation.

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.

Throws:
DSEInvalidArgumentException
DSEObjectNotFoundException

setViewName

public void setViewName(java.lang.String name)
Sets the name of the component to the specified string.

Parameters:
name - The string that is to be this component's name.

tryRunOperation

public void tryRunOperation()

unchain

public void unchain()
             throws DSEInvalidRequestException,
                    DSEObjectNotFoundException
Removes the context or 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.

Throws:
DSEInvalidRequestException
DSEObjectNotFoundException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005