IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.desktop
Interface NavigationController

All Known Implementing Classes:
DSENavigationController

public interface NavigationController

The NavigationController interface must be implemented by each class that wants to control the navigation among views.


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)
          Shows the identified view with a fixed position and size passed as parameters.
 void cancel(java.lang.String viewId)
          Initiates a rollback sequence.
 void close()
          Gets the active view and calls the closeView method to close it.
 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 identified view.
 void deActivateView(java.lang.String viewId)
          Deactivates the identified view.
 void deRegisterSubView(java.lang.String viewId)
          Removes the entry of this view from the View registry.
 java.lang.String getActiveView()
          Returns the value of the activeView property.
 java.util.Vector getChilds(java.lang.String viewId)
          Returns the value of the children property.
 SpInternalFrame getNavigationArea()
          Returns the value of the NavigationArea property.
 java.lang.String getNextView(java.lang.String viewId)
          Returns the value of the nextView property.
 java.lang.String getParent(java.lang.String viewId)
          Returns the value of the parent property.
 java.util.Vector getPeers(java.lang.String viewId)
          Returns the peers of the identified view.
 java.lang.String getPreviousView(java.lang.String viewId)
          Returns the viewId of the previous view.
 CoordinatedPanel getViewInstance(java.lang.String viewId)
          Returns the instance of the viewId.
 boolean isChildren(java.lang.String viewId)
          Indicates whether the identified view has children views.
 boolean isPeer(java.lang.String viewId)
          Indicates whether the identified view has peer views.
 void nextView(java.lang.String viewId, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputMapFormat)
          Instantiates the identified view, sets it as the active view, updates the registry with the view's properties, and shows it.
 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)
          Instantiates the identified view, sets it as the active view, and shows it.
 void openView(java.lang.String viewId, ClientOperation op, java.lang.Boolean executeOp)
          Instantiates the identified view, associates the operation with it, sets it as the active view, and shows it.
 void openView(java.lang.String viewId, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputMapFormat)
          Instantiates the identified view, sets it as the active view, updates the registry with the view's properties, and shows it.
 void openView(java.lang.String viewId, java.lang.String viewSource, ClientOperation op, int navigation, java.lang.String linkContextTo, DataMapperFormat mapper)
          Instantiates the identified view, sets it as the active view, 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 information related to the view.
 void openView(java.lang.String viewId, java.lang.String viewSource, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputMapFormat)
          Instantiates the identified view, sets it as the active view, updates the registry with the view's properties, and shows it.
 void openView(java.lang.String viewId, java.lang.String viewSource, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputMapFormat, java.util.Hashtable position)
          Instantiates the identified view, sets it as the active view, updates the registry with the view's properties, and shows it.
 void previousView()
          Activates and shows the previous view.
 void reactivateSubView(java.lang.String viewId)
          Reactivates the identified view.
 void refreshActiveView()
          Refreshes the active view of the Task.
 void resizeActiveView(int height, int width)
          Resizes the currently displayed view.
 void resizeActiveView(int height, int width, int xpos, int ypos)
          Resizes and relocates the currently displayed view.
 void setActiveView(java.lang.String viewId)
          Sets the value of the ActiveView property.
 void setLevel(int i)
          return - 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)
          Initiates a rollback sequence for the active view, restores the view hierarchy, and activates the parent view.
 

Method Detail

activateView

public void activateView(java.lang.String viewId)
Activates the view passed as the parameter. param@ viewId String - the identifier of the view


activeSubView

public void activeSubView(java.lang.String viewId,
                          java.util.Hashtable position)
Shows the identified view with a fixed position and size passed as parameters.

Parameters:
viewId - java.lang.String - identifier of the view
position - java.util.Hashtable - position and size of the view

cancel

public void cancel(java.lang.String viewId)
Initiates a rollback sequence. This method closes the view and its peers, restores the view hierarchy, and activates the parent view.


close

public void close()
Gets the active view and calls the closeView method to close it.


closeNavigation

public 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.


closeNavigation

public 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.


closeView

public void closeView(java.lang.String id)
Closes the identified view.

Parameters:
id - java.lang.String - identifier of the view

deActivateView

public void deActivateView(java.lang.String viewId)
Deactivates the identified view.


deRegisterSubView

public void deRegisterSubView(java.lang.String viewId)
Removes the entry of this view from the View registry.

Parameters:
viewId - java.lang.String - identifier of the view

getActiveView

public java.lang.String getActiveView()
Returns the value of the activeView property.

Returns:
String - the current value of activeView

getChilds

public java.util.Vector getChilds(java.lang.String viewId)
Returns the value of the children property.

Returns:
Vector - the current values of children

getNavigationArea

public SpInternalFrame getNavigationArea()
Returns the value of the NavigationArea property.

Returns:
JComponent - the current value of NavigationArea

getNextView

public java.lang.String getNextView(java.lang.String viewId)
Returns the value of the nextView property.

Returns:
String - the current value of nextView

getParent

public java.lang.String getParent(java.lang.String viewId)
Returns the value of the parent property.

Returns:
String - the current value of parent

getPeers

public java.util.Vector getPeers(java.lang.String viewId)
Returns the peers of the identified view.

Returns:
Vector - a list of viewIds

getPreviousView

public java.lang.String getPreviousView(java.lang.String viewId)
Returns the viewId of the previous view.


getViewInstance

public CoordinatedPanel getViewInstance(java.lang.String viewId)
Returns the instance of the viewId.


isChildren

public boolean isChildren(java.lang.String viewId)
Indicates whether the identified view has children views.

Returns:
boolean - True if the view has children

isPeer

public boolean isPeer(java.lang.String viewId)
Indicates whether the identified view has peer views.

Returns:
boolean - True if the view has peers

nextView

public void nextView(java.lang.String viewId,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     java.lang.String inputMapFormat)
Instantiates the identified view, sets it as the active view, updates the registry with the view's properties, and shows it.

Parameters:
viewId - String
op - ClientOperation
navigation - int
linkContextTo - String
inputMapFormat - String

nextView

public 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.

Parameters:
id - java.lang.String - identifier of the view
source - java.lang.String - full name of the view
operation - ClientOperation
navigation - int
linkContextTo - String

nextView

public 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.

Parameters:
id - java.lang.String - identifier of the view
source - java.lang.String - full name of the view
operation - ClientOperation
navigation - int
linkContextTo - String
position - java.util.Hashtable

openView

public void openView(java.lang.String viewId)
              throws java.lang.Exception
Instantiates the identified view, sets it as the active view, and shows it.

Parameters:
viewId - String
Throws:
java.lang.Exception

openView

public void openView(java.lang.String viewId,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     java.lang.String inputMapFormat)
Instantiates the identified view, sets it as the active view, updates the registry with the view's properties, and shows it.

Parameters:
viewId - String
op - ClientOperation
navigation - int
linkContextTo - String
inputMapFormat - String

openView

public void openView(java.lang.String viewId,
                     ClientOperation op,
                     java.lang.Boolean executeOp)
              throws java.lang.Exception
Instantiates the identified view, associates the operation with it, sets it as the active view, and shows it.

Parameters:
viewId - String
op - String
executeOp - Boolean
Throws:
java.lang.Exception

openView

public void openView(java.lang.String viewId,
                     java.lang.String viewSource,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     DataMapperFormat mapper)
Instantiates the identified view, sets it as the active view, and stores all the information related to this view.

Parameters:
viewId - java.lang.String - identifier of the view
viewSource - java.lang.String - name of the package of the view
op - ClientOperation
navigation - int
linkContextTo - String

openView

public 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 information related to the view.

Parameters:
viewId - java.lang.String - identifier of the view
viewSource - java.lang.String - name of the package of the view
op - ClientOperation
navigation - int
linkContextTo - String
mapper - DataMapperFormat
position - java.util.Hashtable

openView

public void openView(java.lang.String viewId,
                     java.lang.String viewSource,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     java.lang.String inputMapFormat)
Instantiates the identified view, sets it as the active view, updates the registry with the view's properties, and shows it.

Parameters:
viewId - String
op - ClientOperation
navigation - int
linkContextTo - String
inputMapFormat - String

openView

public void openView(java.lang.String viewId,
                     java.lang.String viewSource,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     java.lang.String inputMapFormat,
                     java.util.Hashtable position)
Instantiates the identified view, sets it as the active view, updates the registry with the view's properties, and shows it.

Parameters:
viewId - String
op - ClientOperation
navigation - int
linkContextTo - String
inputMapFormat - boolean
position - java.util.Hashtable

previousView

public void previousView()
Activates and shows the previous view.


reactivateSubView

public void reactivateSubView(java.lang.String viewId)
Reactivates the identified view.

Parameters:
viewId - java.lang.String

refreshActiveView

public void refreshActiveView()
Refreshes the active view of the Task.


resizeActiveView

public void resizeActiveView(int height,
                             int width)
Resizes the currently displayed view. param@ height int param@ width int


resizeActiveView

public void resizeActiveView(int height,
                             int width,
                             int xpos,
                             int ypos)
Resizes and relocates the currently displayed view. param@ height int param@ width int param@ xpos float param@ ypos float


setActiveView

public void setActiveView(java.lang.String viewId)
Sets the value of the ActiveView property.

Parameters:
viewId - String - the new value of the property

setLevel

public void setLevel(int i)
return - the level of the navigationArea with respect to the WorkingArea


setNavigationArea

public void setNavigationArea(SpInternalFrame na)
Sets the value of the NavigationArea property.

Parameters:
na - JComponent - the new value of the property

setProcess

public void setProcess(Processor proc)
Sets the value of the process property.

Parameters:
proc - com.ibm.dse.automaton.DSEProcessor - the new value of the property.

undo

public void undo(java.lang.String viewId)
Initiates a rollback sequence for the active view, restores the view hierarchy, and activates the parent view.


IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005