|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.dse.base.DSENotifier
com.ibm.dse.desktop.DSENavigationController
This class controls the navigation of a business function. Each Task has a DSENavigationController to keep information of the views and navigation amongst them based on the received DSECoordinated events.
Field Summary | |
---|---|
static java.lang.String |
CTXUSED_ACTIVE
The identifier of the context of the active view |
static java.lang.String |
CTXUSED_PARENT
The identifier of the context of the parent active view |
static java.lang.String |
CTXUSED_PROCESS
The identifier of the context of the process |
protected int |
NAV_CHILDREN
The identifier of children navigation |
protected int |
NAV_NONE
The identifier of none navigation |
protected int |
NAV_PEER
The identifier of the peer navigation |
protected java.util.Hashtable |
viewOrderList
The hashtable with the list of views ordered |
protected java.util.Hashtable |
viewRegistryList
The hashtable with the list of views |
Fields inherited from class com.ibm.dse.base.DSENotifier |
---|
handlersList, name |
Constructor Summary | |
---|---|
DSENavigationController()
This constructor creates a DSENavigationController object. |
|
DSENavigationController(java.lang.String aName)
This constructor creates a DSENavigationController object. |
Method Summary | |
---|---|
void |
activateView(java.lang.String viewId)
Activates the view passed as the parameter. |
void |
activeSubView(java.lang.String viewId,
java.util.Hashtable position)
Activates the view passed as a parameter. |
void |
addCoordinatedEventListener(CoordinatedEventListener newListener)
Adds a CoordinatedEventListener. |
void |
cancel(java.lang.String viewId)
Cancels all the operations of the navigation and closes the navigation's panels until it reaches the parent view, if it exists. |
void |
close()
Closes all the views opened for the task. |
void |
closeNavigation(java.lang.String viewId,
DataMapperFormat mapper)
Closes all the panels of the navigation and, if a closeMapFormat is declared, maps the value to the active view. |
void |
closeNavigation(java.lang.String viewId,
java.lang.String closeMapFormat)
Closes all the panels of the navigation and uses the closeMapFormat to map the value to the active view. |
void |
closeView(java.lang.String id)
Closes the view passed as the parameter. |
void |
deActivateView(java.lang.String viewId)
Deactivates the view passed as the parameter. |
void |
deRegister(java.lang.String viewId)
Removes the entry of this view from the View registry. |
void |
deRegisterSubView(java.lang.String viewId)
Removes the entry of this view from the View registry. |
void |
fireCoordinationEvent()
Fires a CoordinationEvent. |
void |
fireCoordinationEvent(DSECoordinationEvent event)
Fires a CoordinationEvent. |
java.lang.String |
getActiveView()
Returns the viewId associated with the active view. |
java.util.Vector |
getChilds(java.lang.String viewId)
Returns a list of the children associated with the viewId. |
static java.awt.Component |
getFirstFocusableComponent(java.awt.Container c)
Gets the first component inside the task that can accept the focus. |
java.lang.String |
getKey()
Returns the last element of the queue of views. |
SpInternalFrame |
getNavigationArea()
Returns the Container of the view. |
java.lang.String |
getNextView(java.lang.String viewId)
Returns the viewId of the next view associated with the passed viewId. |
java.lang.String |
getParent(java.lang.String viewId)
Returns the ID of the parent view associated with the viewId. |
java.util.Vector |
getPeers(java.lang.String viewId)
Returns the peers associated with the viewId. |
java.lang.String |
getPreviousView(java.lang.String viewId)
Returns the viewId of the previous view associated with the viewId. |
Processor |
getProcess()
Returns the process associated with this NavigationController. |
javax.swing.JScrollPane |
getScrollPane()
Returns the scrollpane associated with the navigationArea. |
CoordinatedPanel |
getViewInstance(java.lang.String viewId)
Returns the instance of the view passed as a parameter. |
void |
handleDSECoordinationEvent(DSECoordinationEvent event)
Contains the appropriate actions to be executed when DSECoordinationEvent has been triggered. |
boolean |
isChildren(java.lang.String viewId)
Returns whether the view with the passed ID has children. |
boolean |
isPeer(java.lang.String viewId)
Returns whether the view with the passed ID is a peer of another view. |
void |
modifyNavigation(java.lang.String viewId,
boolean close,
boolean rollback,
DataMapperFormat mapper)
Closes, rolls back, and maps (depending on the parameters) the view. |
void |
nextView(java.lang.String id,
ClientOperation operation,
int navigation,
java.lang.String linkContextTo,
java.lang.String inputPathFormat)
Shows the next view, activates it, and stores the IDs of the next and previous views. |
void |
nextView(java.lang.String id,
java.lang.String source,
ClientOperation operation,
int navigation,
java.lang.String linkContextTo,
java.lang.String inputPathFormat)
Shows the next view, activates it, and stores the IDs of the next and previous views. |
void |
nextView(java.lang.String id,
java.lang.String source,
ClientOperation operation,
int navigation,
java.lang.String linkContextTo,
java.lang.String inputPathFormat,
java.util.Hashtable position)
Shows the next view, activates it, and stores the IDs of the next and previous views. |
void |
openView(java.lang.String viewId)
Opens a view, activates it, and stores all the information about the view. |
void |
openView(java.lang.String viewId,
ClientOperation op,
java.lang.Boolean execOp)
Opens a view, activates it, and stores all the information related to this view. |
void |
openView(java.lang.String viewId,
ClientOperation op,
int navigation,
java.lang.String linkContextTo,
java.lang.String inputPathFormat)
Opens a view, activates it, and stores all the information related to this view. |
void |
openView(java.lang.String viewId,
java.lang.String viewSource,
ClientOperation op,
int navigation,
java.lang.String linkContextTo,
DataMapperFormat mapper)
Opens a view, activates it, and stores all the information related to this view. |
void |
openView(java.lang.String viewId,
java.lang.String viewSource,
ClientOperation op,
int navigation,
java.lang.String linkContextTo,
DataMapperFormat mapper,
java.util.Hashtable position)
Opens a view, activates it, and stores all the information related to this view. |
void |
openView(java.lang.String viewId,
java.lang.String viewSource,
ClientOperation op,
int navigation,
java.lang.String linkContextTo,
java.lang.String inputFormat)
Opens a view, activates it, and stores all the information related to this view. |
void |
openView(java.lang.String viewId,
java.lang.String viewSource,
ClientOperation op,
int navigation,
java.lang.String linkContextTo,
java.lang.String inputFormat,
java.util.Hashtable position)
Opens a view, activates it, and stores all the information related to this view. |
void |
previousView()
Deactivates the active view and shows the previous view. |
void |
reactivateSubView(java.lang.String viewId)
Reactivates the view passed as a parameter. |
void |
refreshActiveView()
Refreshes the active view of the Task. |
void |
removeCoordinatedEventListener(CoordinatedEventListener newListener)
Removes the CoordinatedEventListener. |
java.util.Vector |
reorder(java.util.Vector v)
Returns the order in which the views were created. |
void |
resizeActiveView(int height,
int width)
Resizes the active view. |
void |
resizeActiveView(int height,
int width,
int xpos,
int ypos)
Resizes and relocates the active view. |
void |
setActiveView(java.lang.String viewId)
Sets the value of the activeView property. |
void |
setLevel(int i)
Returns the level of the navigationArea with respect to the WorkingArea. |
void |
setNavigationArea(SpInternalFrame na)
Sets the value of the navigationArea property. |
void |
setProcess(Processor proc)
Sets the value of the process property. |
void |
undo(java.lang.String viewId)
Rolls back all the operations of the navigation. |
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, toString, wait, wait, wait |
Field Detail |
protected java.util.Hashtable viewRegistryList
protected java.util.Hashtable viewOrderList
protected int NAV_NONE
protected int NAV_PEER
protected int NAV_CHILDREN
public static final java.lang.String CTXUSED_PROCESS
public static final java.lang.String CTXUSED_ACTIVE
public static final java.lang.String CTXUSED_PARENT
Constructor Detail |
public DSENavigationController()
This class takes charge of all the navigation of the views.
public DSENavigationController(java.lang.String aName) throws java.io.IOException
This class takes charge of all the navigation of the views.
aName
- java.lang.String
java.io.IOException
Method Detail |
public void activateView(java.lang.String viewId)
activateView
in interface NavigationController
viewId
- java.lang.String - the identifier of the viewpublic void activeSubView(java.lang.String viewId, java.util.Hashtable position)
activeSubView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewposition
- java.util.Hashtable - position and size of the viewpublic void addCoordinatedEventListener(CoordinatedEventListener newListener)
addCoordinatedEventListener
in interface CoordinatedEventSource
newListener
- CoordinatedEventListenerpublic void cancel(java.lang.String viewId)
cancel
in interface NavigationController
viewId
- Stringpublic void close()
close
in interface NavigationController
public void closeNavigation(java.lang.String viewId, java.lang.String closeMapFormat)
closeNavigation
in interface NavigationController
viewId
- StringcloseMapFormat
- Stringpublic void closeNavigation(java.lang.String viewId, DataMapperFormat mapper)
closeNavigation
in interface NavigationController
viewId
- Stringmapper
- DataMapperFormatpublic void closeView(java.lang.String id)
closeView
in interface NavigationController
id
- java.lang.String - identifier of the viewpublic void deActivateView(java.lang.String viewId)
deActivateView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewpublic void deRegister(java.lang.String viewId)
viewId
- java.lang.String - identifier of the viewpublic void deRegisterSubView(java.lang.String viewId)
deRegisterSubView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewpublic void fireCoordinationEvent()
fireCoordinationEvent
in interface CoordinatedEventSource
public void fireCoordinationEvent(DSECoordinationEvent event)
fireCoordinationEvent
in interface CoordinatedEventSource
public java.lang.String getActiveView()
getActiveView
in interface NavigationController
public java.util.Vector getChilds(java.lang.String viewId)
getChilds
in interface NavigationController
public static java.awt.Component getFirstFocusableComponent(java.awt.Container c)
c
- java.awt.Container
public java.lang.String getKey()
public SpInternalFrame getNavigationArea()
getNavigationArea
in interface NavigationController
public java.lang.String getNextView(java.lang.String viewId)
getNextView
in interface NavigationController
viewId
-
public java.lang.String getParent(java.lang.String viewId)
getParent
in interface NavigationController
viewId
-
public java.util.Vector getPeers(java.lang.String viewId)
getPeers
in interface NavigationController
viewId
-
public java.lang.String getPreviousView(java.lang.String viewId)
getPreviousView
in interface NavigationController
viewId
-
public Processor getProcess()
public javax.swing.JScrollPane getScrollPane()
public CoordinatedPanel getViewInstance(java.lang.String viewId)
getViewInstance
in interface NavigationController
viewId
- java.lang.String - identifier of the view
public void handleDSECoordinationEvent(DSECoordinationEvent event)
handleDSECoordinationEvent
in interface CoordinatedEventListener
event
- DSECoordinationEventpublic boolean isChildren(java.lang.String viewId)
isChildren
in interface NavigationController
viewId
-
public boolean isPeer(java.lang.String viewId)
isPeer
in interface NavigationController
viewId
-
public void modifyNavigation(java.lang.String viewId, boolean close, boolean rollback, DataMapperFormat mapper)
viewId
- Stringclose
- boolean - True to close the viewrollback
- boolean - True to roll back the viewmapper
- DataMapperFormatpublic void nextView(java.lang.String id, ClientOperation operation, int navigation, java.lang.String linkContextTo, java.lang.String inputPathFormat)
nextView
in interface NavigationController
id
- java.lang.String - identifier of the viewoperation
- ClientOperationnavigation
- intlinkContextTo
- StringinputPathFormat
- Stringpublic void nextView(java.lang.String id, java.lang.String source, ClientOperation operation, int navigation, java.lang.String linkContextTo, java.lang.String inputPathFormat)
nextView
in interface NavigationController
id
- java.lang.String - identifier of the viewsource
- java.lang.String - full name of the viewoperation
- ClientOperationnavigation
- intlinkContextTo
- Stringpublic void nextView(java.lang.String id, java.lang.String source, ClientOperation operation, int navigation, java.lang.String linkContextTo, java.lang.String inputPathFormat, java.util.Hashtable position)
nextView
in interface NavigationController
id
- java.lang.String - identifier of the viewsource
- java.lang.String - full name of the viewoperation
- ClientOperationnavigation
- intlinkContextTo
- Stringposition
- java.util.Hashtable - position and size of the viewpublic void openView(java.lang.String viewId) throws java.lang.Exception
openView
in interface NavigationController
viewId
- java.lang.String - identifier of the view
java.lang.Exception
public void openView(java.lang.String viewId, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputPathFormat)
openView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewop
- ClientOperationnavigation
- intlinkContextTo
- StringinputPathFormat
- Stringpublic void openView(java.lang.String viewId, ClientOperation op, java.lang.Boolean execOp) throws java.lang.Exception
openView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewop
- ClientOperationexecOp
- boolean
java.lang.Exception
public void openView(java.lang.String viewId, java.lang.String viewSource, ClientOperation op, int navigation, java.lang.String linkContextTo, DataMapperFormat mapper)
openView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewviewSource
- java.lang.String - name of the package of the viewop
- ClientOperationnavigation
- intlinkContextTo
- Stringmapper
- DataMapperFormatpublic void openView(java.lang.String viewId, java.lang.String viewSource, ClientOperation op, int navigation, java.lang.String linkContextTo, DataMapperFormat mapper, java.util.Hashtable position)
openView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewviewSource
- java.lang.String - name of the package of the viewop
- ClientOperationnavigation
- intlinkContextTo
- Stringmapper
- DataMapperFormatposition
- java.util.Hashtable - position and size of the viewpublic void openView(java.lang.String viewId, java.lang.String viewSource, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputFormat)
openView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewviewSource
- java.lang.String - name of the package of the viewop
- ClientOperationnavigation
- intlinkContextTo
- StringinputFormat
- Stringpublic void openView(java.lang.String viewId, java.lang.String viewSource, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputFormat, java.util.Hashtable position)
openView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewviewSource
- java.lang.String - name of the package of the viewop
- ClientOperationnavigation
- intlinkContextTo
- Stringposition
- java.util.Hashtable - position and size of the viewinputFormat
- booleanpublic void previousView()
previousView
in interface NavigationController
public void reactivateSubView(java.lang.String viewId)
reactivateSubView
in interface NavigationController
viewId
- java.lang.String - identifier of the viewpublic void refreshActiveView()
refreshActiveView
in interface NavigationController
public void removeCoordinatedEventListener(CoordinatedEventListener newListener)
removeCoordinatedEventListener
in interface CoordinatedEventSource
newListener
- DataChangedListenerpublic java.util.Vector reorder(java.util.Vector v)
v
- java.util.Vector
public void resizeActiveView(int height, int width)
resizeActiveView
in interface NavigationController
height
- intwidth
- intpublic void resizeActiveView(int height, int width, int xpos, int ypos)
resizeActiveView
in interface NavigationController
height
- intwidth
- intxpos
- intypos
- intpublic void setActiveView(java.lang.String viewId)
setActiveView
in interface NavigationController
viewId
- String - the new value of the propertypublic void setLevel(int i)
setLevel
in interface NavigationController
public void setNavigationArea(SpInternalFrame na)
setNavigationArea
in interface NavigationController
na
- Container - the new value of the propertypublic void setProcess(Processor proc)
setProcess
in interface NavigationController
proc
- com.ibm.dse.automaton.DSEProcessor - the new value of the propertypublic void undo(java.lang.String viewId)
undo
in interface NavigationController
viewId
- String
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |