com.ibm.dse.automaton.ext
Class CloseView

java.lang.Object
  |
  +--com.ibm.dse.base.DSENotifier
        |
        +--com.ibm.dse.automaton.DSEAction
              |
              +--com.ibm.dse.automaton.ext.CloseView

public class CloseView
extends DSEAction

This class provides the behaviour for a sample DSEAction to close a view in the Desktop.

See Also:
Serialized Form

Fields inherited from class com.ibm.dse.automaton.DSEAction
context, inputMapFmtTag, operationTag, outputMapFmtTag, sourceEvent, tag
 
Fields inherited from class com.ibm.dse.base.DSENotifier
handlersList, name
 
Constructor Summary
CloseView()
          Creates an object of type CloseView.
CloseView(boolean mustRegister)
          Creates an object of type CloseView.
CloseView(java.lang.String aName)
          Creates an object of type CloseView.
CloseView(java.lang.String aName, java.lang.String aTID)
          Creates an object of type CloseView.
 
Method Summary
 void execute()
          This method obtains the instance of the navigation controller from the processor's context to close the active panel.
 
Methods inherited from class com.ibm.dse.automaton.DSEAction
chainOrAssignContext, chainOrAssignContext, close, close, evaluateGuardCondition, externalizer, getContext, getGuardConditions, getInputMapFmtTag, getOperationTag, getOutputMapFmtTag, getParms, getProcessor, getSourceEvent, initializeFrom, mapTheInput, mapTheOutput, preProcess, readExternal, readExternal, removeExternal, setContext, setGuardConditions, setInputMapFmtTag, setOperationTag, setOutputMapFmtTag, setParms, setProcessor, setSourceEvent, toString, toStrings, toTags, writeExternal, writeExternal
 
Methods inherited from class com.ibm.dse.base.DSENotifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, signalEvent, terminate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CloseView

public CloseView()
Creates an object of type CloseView.

CloseView

public CloseView(java.lang.String aName)
Creates an object of type CloseView.
Parameters:
aName - java.lang.String

CloseView

public CloseView(java.lang.String aName,
                 java.lang.String aTID)
Creates an object of type CloseView.
Parameters:
aName - java.lang.String
aTID - java.lang.String

CloseView

public CloseView(boolean mustRegister)
Creates an object of type CloseView.
Parameters:
mustRegister - boolean
Method Detail

execute

public void execute()
This method obtains the instance of the navigation controller from the processor's context to close the active panel. First, the active view's name is obtained from the navagation controller, then the outputMapFormat is retreived from the action's hashtable of parameters. These two values are passed as parameters to the navagation controller's closeNavigation() where the outputMapFmt will be used to copy the data from the panel's context to the processor's context, and the active panel will be closed.
Overrides:
execute in class DSEAction
Tags copied from class: DSEAction
Throws:
java.lang.Exception - The implementor of this class must decide when to throw an exception occurred to the automaton.