IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class DSECoordinationEvent

java.lang.Object
  extended byjava.util.EventObject
      extended bycom.ibm.dse.base.DSEEventObject
          extended bycom.ibm.dse.gui.DSECoordinationEvent
All Implemented Interfaces:
java.io.Serializable

public class DSECoordinationEvent
extends DSEEventObject

The DSECoordinationEvent class represents an event that is sent by: Data exchangers when some data changes. SpButton when in clicked. CoordinatedPanel for Navgtion and Action events. It supports the CoordinatedEventListener interface.

See Also:
Serialized Form

Field Summary
static int CHAIN_ACTIVE_CONTEXT
          For Execute_Operation Events chain Operation Context with Panel Conetxt.
static int CHAIN_PARENT_CONTEXT
          For Execute_Operation Events chain Operation Context with parent Panel Conetxt.
static int CHAIN_ROOT_CONTEXT
          For Execute_Operation Events chain Operation Context with root Conetxt.
static int CONTEXT_UNCHAINED
          For Execute_Operation Events do not chain the Operation Context.
static java.lang.String CTXUSED_ACTIVE
          For Open_View and Next_View events it will chain the view context Active View context.
static java.lang.String CTXUSED_PARENT
          For Open_View and Next_View events it will chain the view context Active PArent View context.
static java.lang.String CTXUSED_PROCESS
          For Open_View and Next_View events it will chain the view context to Current Processor context.
static java.lang.String EVENT_EVENTYPE_ACTION
          "Action" EventType will be for the flow processor.
static java.lang.String EVENT_EVENTYPE_COORDINATION
          "Coordination" EventType will be for the panels.
static java.lang.String EVENT_EVENTYPE_NAVIGATION
          "Navigation" EventType will be for the Navigation Controller.
static java.lang.String EVENT_SOURCETYPE_CANCEL
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will cancel the navigation.
static java.lang.String EVENT_SOURCETYPE_CLEAR
          Clear value for a type property.
static java.lang.String EVENT_SOURCETYPE_CLOSE
          Close value for a type property.
static java.lang.String EVENT_SOURCETYPE_CLOSE_NAVIGATION
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will close the view and will apply the close map format (if it is necessary).
static java.lang.String EVENT_SOURCETYPE_DEFAULT
          Default value for a type property.
static java.lang.String EVENT_SOURCETYPE_EMU
          EMUCurrency value for a type property.
static java.lang.String EVENT_SOURCETYPE_EURO
          Euro value for a type property.
static java.lang.String EVENT_SOURCETYPE_EXEC
          The Coordinated Panel The coordinated panel will execute a specific operation, and when this operation finishes, the DSECoordinatedPanel fires an "Operation Replied" event.
static java.lang.String EVENT_SOURCETYPE_HELP
          Help value for a type property.
static java.lang.String EVENT_SOURCETYPE_NEXT
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will change the curent view to the next view.
static java.lang.String EVENT_SOURCETYPE_NONE
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will send this event to the Flow Procesor.
static java.lang.String EVENT_SOURCETYPE_OK
          OK value for a type property.
static java.lang.String EVENT_SOURCETYPE_OP_REPLIED
          Operation has been executed.
static java.lang.String EVENT_SOURCETYPE_OPEN_TASK
          Event used for opening a task using a button
static java.lang.String EVENT_SOURCETYPE_OPEN_VIEW
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will will open a new view, and this new view will be the current view.
static java.lang.String EVENT_SOURCETYPE_PREVIOUS
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will change the curent view to the previous view.
static java.lang.String EVENT_SOURCETYPE_REPEAT
          Repeat value for a type property.
static java.lang.String EVENT_SOURCETYPE_UNDO
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will change its state for to the committed state.
static java.lang.String EVENT_SOURCETYPE_VIEW_CLOSED
          DSECoordinated panel has been closed.
static java.lang.String EVENT_SOURCETYPE_VIEW_NOT_VISIBLE
          DSECoordinatedPanel is not visible.
static java.lang.String EVENT_SOURCETYPE_VIEW_OPENED
          New view has been opened.
static java.lang.String EVENT_SOURCETYPE_VIEW_VISIBLE
          DSECoordinatedPanel is visible.
static int NAVIGATION_CHILDREN
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then the navigation will be "children" (see desktop).
static int NAVIGATION_NONE
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then the navigation will be "none" (see desktop).
static int NAVIGATION_PEER
          If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then the navigation will be "peer" (see desktop).
 
Fields inherited from class com.ibm.dse.base.DSEEventObject
name, originTID, parameters, sourceName
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
DSECoordinationEvent(java.lang.Object anObject)
          This constructor creates a DSECoordinationEvent object.
 
Method Summary
 DSECoordinationEvent copy(java.lang.Object source, java.lang.String name)
           
 int getChainContext()
          Gets the chainContext property (java.lang.String) value.
 java.lang.String getCloseMapFormat()
          Gets the CloseMapFormat name property (java.lang.String) value.
 java.lang.String getEventName()
          Gets the eventName property (java.lang.String) value.
 java.lang.String getEventSourceType()
          Gets the eventSourceType property (java.lang.String) value.
 java.lang.String getEventType()
          Gets the eventType property (java.lang.String) value.
 java.lang.String getInputMapFormat()
          Gets the InputMapFormat name property (java.lang.String) value.
 java.lang.String getLinkContextTo()
          Gets the linkContextTo property (java.lang.String) value.
 int getNavigation()
          Gets the navigation property (int) value.
 java.lang.String getOpenMapFormat()
          Gets the OpenMapFormat name property (java.lang.String) value.
 Operation getOperation()
          Gets the operation property (Operation) value.
 java.lang.String getOperationName()
          Gets the operationName property (java.lang.String) value.
 java.lang.String getOutputMapFormat()
          Gets the OutputMapFormat name property (java.lang.String) value.
 java.util.Hashtable getPosition()
          Gets the position property (java.util.Hashtable) value.
 java.lang.String getViewName()
          Gets the viewName property (java.lang.String) value.
 java.lang.String getViewSource()
          Gets the viewSource property (java.lang.String) value.
 void iniHashTable()
          initialice parameters property
 boolean isRefresh()
          Gets the refresh property (boolean) value.
 void setChainContext(int newChainContext)
          Sets the chainContext name property (int) value.
 void setCloseMapFormat(java.lang.String newCloseMapFormat)
          Sets the CloseMapFormat name property (java.lang.String) value.
 void setEventName(java.lang.String newEventName)
          Sets the eventName property (java.lang.String) value.
 void setEventSourceType(java.lang.String newEventSourceType)
          Sets the eventSouceType property (java.lang.String) value.
 void setEventType(java.lang.String newEventType)
          Sets the eventType property (java.lang.String) value.
 void setInputMapFormat(java.lang.String newInputMapFormat)
          Sets the InputMapFormat name property (java.lang.String) value.
 void setLinkContextTo(java.lang.String newChaining)
          Sets the linkContextTo property (java.lang.String) value.
 void setNavigation(int newNavigation)
          Sets the navigation property (int) value.
 void setOpenMapFormat(java.lang.String newOpenMapFormat)
          Sets the OpenMapFormat name property (java.lang.String) value.
 void setOperation(Operation op)
          Sets the operation property (Operation) value.
 void setOperationName(java.lang.String newOperationName)
          Sets the operationName property (java.lang.String) value.
 void setOutputMapFormat(java.lang.String newOutputMapFormat)
          Sets the OutputMapFormat name property (java.lang.String) value.
 void setPosition(java.util.Hashtable position)
          Sets the position property (java.util.Hashtable) value which keeps the position and size of the view.
 void setRefresh(boolean newRefresh)
          Sets the refresh property (boolean) value.
 void setViewName(java.lang.String newViewName)
          Sets the viewName property (java.lang.String) value.
 void setViewSource(java.lang.String newViewSource)
          Sets the viewSource property (java.lang.String) value.
 
Methods inherited from class com.ibm.dse.base.DSEEventObject
getName, getParameters, getSourceName, getTID, setName, setOriginTID, setParameters, setSourceName, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAVIGATION_PEER

public static final int NAVIGATION_PEER
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then the navigation will be "peer" (see desktop).

See Also:
Constant Field Values

NAVIGATION_CHILDREN

public static final int NAVIGATION_CHILDREN
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then the navigation will be "children" (see desktop).

See Also:
Constant Field Values

NAVIGATION_NONE

public static final int NAVIGATION_NONE
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then the navigation will be "none" (see desktop).

See Also:
Constant Field Values

CHAIN_ACTIVE_CONTEXT

public static final int CHAIN_ACTIVE_CONTEXT
For Execute_Operation Events chain Operation Context with Panel Conetxt.

See Also:
Constant Field Values

CHAIN_PARENT_CONTEXT

public static final int CHAIN_PARENT_CONTEXT
For Execute_Operation Events chain Operation Context with parent Panel Conetxt.

See Also:
Constant Field Values

CHAIN_ROOT_CONTEXT

public static final int CHAIN_ROOT_CONTEXT
For Execute_Operation Events chain Operation Context with root Conetxt.

See Also:
Constant Field Values

CONTEXT_UNCHAINED

public static final int CONTEXT_UNCHAINED
For Execute_Operation Events do not chain the Operation Context.

See Also:
Constant Field Values

CTXUSED_PROCESS

public static final java.lang.String CTXUSED_PROCESS
For Open_View and Next_View events it will chain the view context to Current Processor context.

See Also:
Constant Field Values

CTXUSED_ACTIVE

public static final java.lang.String CTXUSED_ACTIVE
For Open_View and Next_View events it will chain the view context Active View context.

See Also:
Constant Field Values

CTXUSED_PARENT

public static final java.lang.String CTXUSED_PARENT
For Open_View and Next_View events it will chain the view context Active PArent View context.

See Also:
Constant Field Values

EVENT_SOURCETYPE_PREVIOUS

public static final java.lang.String EVENT_SOURCETYPE_PREVIOUS
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will change the curent view to the previous view.

See Also:
Constant Field Values

EVENT_SOURCETYPE_NEXT

public static final java.lang.String EVENT_SOURCETYPE_NEXT
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will change the curent view to the next view.

See Also:
Constant Field Values

EVENT_SOURCETYPE_UNDO

public static final java.lang.String EVENT_SOURCETYPE_UNDO
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will change its state for to the committed state.

See Also:
Constant Field Values

EVENT_SOURCETYPE_CANCEL

public static final java.lang.String EVENT_SOURCETYPE_CANCEL
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will cancel the navigation.

See Also:
Constant Field Values

EVENT_SOURCETYPE_OP_REPLIED

public static final java.lang.String EVENT_SOURCETYPE_OP_REPLIED
Operation has been executed.

See Also:
Constant Field Values

EVENT_SOURCETYPE_VIEW_OPENED

public static final java.lang.String EVENT_SOURCETYPE_VIEW_OPENED
New view has been opened.

See Also:
Constant Field Values

EVENT_SOURCETYPE_VIEW_VISIBLE

public static final java.lang.String EVENT_SOURCETYPE_VIEW_VISIBLE
DSECoordinatedPanel is visible.

See Also:
Constant Field Values

EVENT_SOURCETYPE_VIEW_NOT_VISIBLE

public static final java.lang.String EVENT_SOURCETYPE_VIEW_NOT_VISIBLE
DSECoordinatedPanel is not visible.

See Also:
Constant Field Values

EVENT_SOURCETYPE_OPEN_VIEW

public static final java.lang.String EVENT_SOURCETYPE_OPEN_VIEW
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will will open a new view, and this new view will be the current view.

See Also:
Constant Field Values

EVENT_SOURCETYPE_VIEW_CLOSED

public static final java.lang.String EVENT_SOURCETYPE_VIEW_CLOSED
DSECoordinated panel has been closed.

See Also:
Constant Field Values

EVENT_SOURCETYPE_OK

public static final java.lang.String EVENT_SOURCETYPE_OK
OK value for a type property. When it is clicked, the operation associated to the coordianted panel is executed. It is enabled when:
- All mandatory fields in the operation panel and in nested embedded panels (with nesting property activated) are filled.
- No field in the operation panel and in nested embedded panels (with nesting property activated) have a wrong value.
- Global validations have been successfully performed.

See Also:
Constant Field Values

EVENT_SOURCETYPE_CLOSE

public static final java.lang.String EVENT_SOURCETYPE_CLOSE
Close value for a type property. When it is clicked, the operation associated to the operation panel is closed, as well as the view where the panel is located.

See Also:
Constant Field Values

EVENT_SOURCETYPE_REPEAT

public static final java.lang.String EVENT_SOURCETYPE_REPEAT
Repeat value for a type property. When it is clicked, all data exchangers with a dataName associated that are located in the panel, and in nested embedded panels with nesting property to true, take the same values they had in the last operation execution.

See Also:
Constant Field Values

EVENT_SOURCETYPE_CLEAR

public static final java.lang.String EVENT_SOURCETYPE_CLEAR
Clear value for a type property. When it is clicked, all data exchangers in the panel, and in nested embedded panels with nesting property to true, are cleared.

See Also:
Constant Field Values

EVENT_SOURCETYPE_EMU

public static final java.lang.String EVENT_SOURCETYPE_EMU
EMUCurrency value for a type property. When it is clicked, data in the operation panel and in embedded panels with convertible property to true is converted to the currency specified in EMUCurrency property.

See Also:
Constant Field Values

EVENT_SOURCETYPE_EURO

public static final java.lang.String EVENT_SOURCETYPE_EURO
Euro value for a type property. When it is clicked, data in the operation panel and in embedded panels with convertible property to true is converted to euros.

See Also:
Constant Field Values

EVENT_SOURCETYPE_HELP

public static final java.lang.String EVENT_SOURCETYPE_HELP
Help value for a type property. When it is clicked, showHelp(String helpId) method defined in the class specified in classForHelpImplementation property is called with the identifier associated to the panel where the button is located.

See Also:
Constant Field Values

EVENT_SOURCETYPE_DEFAULT

public static final java.lang.String EVENT_SOURCETYPE_DEFAULT
Default value for a type property. It is a standard button that does not have associated behavior.

See Also:
Constant Field Values

EVENT_SOURCETYPE_NONE

public static final java.lang.String EVENT_SOURCETYPE_NONE
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will send this event to the Flow Procesor.

See Also:
Constant Field Values

EVENT_SOURCETYPE_EXEC

public static final java.lang.String EVENT_SOURCETYPE_EXEC
The Coordinated Panel The coordinated panel will execute a specific operation, and when this operation finishes, the DSECoordinatedPanel fires an "Operation Replied" event. If there is a value for the "View Information" parameter, then after the operation executes the panel will fire a "Next View" event.

See Also:
Constant Field Values

EVENT_SOURCETYPE_CLOSE_NAVIGATION

public static final java.lang.String EVENT_SOURCETYPE_CLOSE_NAVIGATION
If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will close the view and will apply the close map format (if it is necessary).

See Also:
Constant Field Values

EVENT_EVENTYPE_COORDINATION

public static final java.lang.String EVENT_EVENTYPE_COORDINATION
"Coordination" EventType will be for the panels.

See Also:
Constant Field Values

EVENT_EVENTYPE_NAVIGATION

public static final java.lang.String EVENT_EVENTYPE_NAVIGATION
"Navigation" EventType will be for the Navigation Controller.

See Also:
Constant Field Values

EVENT_EVENTYPE_ACTION

public static final java.lang.String EVENT_EVENTYPE_ACTION
"Action" EventType will be for the flow processor.

See Also:
Constant Field Values

EVENT_SOURCETYPE_OPEN_TASK

public static final java.lang.String EVENT_SOURCETYPE_OPEN_TASK
Event used for opening a task using a button

See Also:
Constant Field Values
Constructor Detail

DSECoordinationEvent

public DSECoordinationEvent(java.lang.Object anObject)
This constructor creates a DSECoordinationEvent object.

Method Detail

copy

public DSECoordinationEvent copy(java.lang.Object source,
                                 java.lang.String name)

getChainContext

public int getChainContext()
Gets the chainContext property (java.lang.String) value.

Returns:
int - The chainContext property value.

getCloseMapFormat

public java.lang.String getCloseMapFormat()
Gets the CloseMapFormat name property (java.lang.String) value.

Returns:
String - The CloseMapFormat name property value.

getEventName

public java.lang.String getEventName()
Gets the eventName property (java.lang.String) value.

Returns:
String - The ceventName property value.

getEventSourceType

public java.lang.String getEventSourceType()
Gets the eventSourceType property (java.lang.String) value.

Returns:
String - The eventSourceType property value.

getEventType

public java.lang.String getEventType()
Gets the eventType property (java.lang.String) value.

Returns:
String - The eventType property value.

getInputMapFormat

public java.lang.String getInputMapFormat()
Gets the InputMapFormat name property (java.lang.String) value.

Returns:
String - The InputMapFormat name property value.

getLinkContextTo

public java.lang.String getLinkContextTo()
Gets the linkContextTo property (java.lang.String) value.

Returns:
String - The eventlinkContextTo property value.

getNavigation

public int getNavigation()
Gets the navigation property (int) value.

Returns:
int - The navigation property value.

getOpenMapFormat

public java.lang.String getOpenMapFormat()
Gets the OpenMapFormat name property (java.lang.String) value.

Returns:
String - The OpenMapFormat name property value.

getOperation

public Operation getOperation()
Gets the operation property (Operation) value.

Returns:
Operation - The operation property value.

getOperationName

public java.lang.String getOperationName()
Gets the operationName property (java.lang.String) value.

Returns:
String - The operationName property value.

getOutputMapFormat

public java.lang.String getOutputMapFormat()
Gets the OutputMapFormat name property (java.lang.String) value.

Returns:
String - The OutputMapFormat name property value.

getPosition

public java.util.Hashtable getPosition()
Gets the position property (java.util.Hashtable) value.

Returns:
java.util.Hashtable - The position property value.

getViewName

public java.lang.String getViewName()
Gets the viewName property (java.lang.String) value.

Returns:
String - The viewName property value.

getViewSource

public java.lang.String getViewSource()
Gets the viewSource property (java.lang.String) value.

Returns:
String - The viewSource property value.

iniHashTable

public void iniHashTable()
initialice parameters property


isRefresh

public boolean isRefresh()
Gets the refresh property (boolean) value.


setChainContext

public void setChainContext(int newChainContext)
Sets the chainContext name property (int) value.

Parameters:
newChainContext - int, the new value for the property.

setCloseMapFormat

public void setCloseMapFormat(java.lang.String newCloseMapFormat)
Sets the CloseMapFormat name property (java.lang.String) value.

Parameters:
newCloseMapFormat - String, the new value for the property.

setEventName

public void setEventName(java.lang.String newEventName)
Sets the eventName property (java.lang.String) value.


setEventSourceType

public void setEventSourceType(java.lang.String newEventSourceType)
Sets the eventSouceType property (java.lang.String) value.


setEventType

public void setEventType(java.lang.String newEventType)
Sets the eventType property (java.lang.String) value.


setInputMapFormat

public void setInputMapFormat(java.lang.String newInputMapFormat)
Sets the InputMapFormat name property (java.lang.String) value.

Parameters:
newInputMapFormat - String, the new value for the property.

setLinkContextTo

public void setLinkContextTo(java.lang.String newChaining)
Sets the linkContextTo property (java.lang.String) value.


setNavigation

public void setNavigation(int newNavigation)
Sets the navigation property (int) value.


setOpenMapFormat

public void setOpenMapFormat(java.lang.String newOpenMapFormat)
Sets the OpenMapFormat name property (java.lang.String) value.

Parameters:
newOpenMapFormat - String, the new value for the property.

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 newOperationName)
Sets the operationName property (java.lang.String) value.


setOutputMapFormat

public void setOutputMapFormat(java.lang.String newOutputMapFormat)
Sets the OutputMapFormat name property (java.lang.String) value.

Parameters:
newOutputMapFormat - String, the new value for the property.

setPosition

public void setPosition(java.util.Hashtable position)
Sets the position property (java.util.Hashtable) value which keeps the position and size of the view.

Parameters:
position - java.util.Hashtable, the position and size of the view

setRefresh

public void setRefresh(boolean newRefresh)
Sets the refresh property (boolean) value.


setViewName

public void setViewName(java.lang.String newViewName)
Sets the viewName property (java.lang.String) value.


setViewSource

public void setViewSource(java.lang.String newViewSource)
Sets the viewSource property (java.lang.String) value.


IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005