com.ibm.dse.desktop
Interface NavigationController

All Known Implementing Classes:
DSENavigationController

public interface NavigationController

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


Method Summary
 void activateView(java.lang.String viewId)
          This method shows the view associated to this viewId param@ viewId String
 void cancel(java.lang.String viewId)
          This method initiates a rollback sequence.This method will close or not all the peers for the viewId, restoring the view hierarchy and activating the parent view
 void close()
          This method gets the active view and call the closeView method to close the view.
 void closeNavigation(java.lang.String viewId, DataMapperFormat mapper)
          This method close all the navigation of the panels and if an closeMapFormat is declared maps the value to the active view.
 void closeNavigation(java.lang.String viewId, java.lang.String closeMapFormat)
          This method close all the navigation and maps the context of the viewId to the context of the parent view.
 void closeView(java.lang.String id)
          This method close the view passed as parameter.
 void deActivateView(java.lang.String viewId)
          This method disactivates the view associated to this viewId
 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 associated to this viewId
 java.lang.String getPreviousView(java.lang.String viewId)
          returns the String associated to the previous view of the viewId.
 CoordinatedPanel getViewInstance(java.lang.String viewId)
          This method returns the instance of the viewId
 boolean isChildren(java.lang.String viewId)
          Indicates that the viewId has children views.
 boolean isPeer(java.lang.String viewId)
          Indicates that the viewId is peer of another view.
 void nextView(java.lang.String viewId, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputMapFormat)
          This method instanciates de viewId,sets this view as the active view,and update the registry with the propertys of the view 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)
          This method shows the next view and activates this,and stores the next and previous id of the views
 void openView(java.lang.String viewId)
          This method instanciates de viewId,sets this view as the active view and shows it .
 void openView(java.lang.String viewId, ClientOperation op, java.lang.Boolean executeOp)
          This method instanciates de viewId and associates the operation name to the view.
 void openView(java.lang.String viewId, ClientOperation op, int navigation, java.lang.String linkContextTo, java.lang.String inputMapFormat)
          This method instanciates de viewId,sets this view as the active view,and update the registry with the propertys of the view and shows it .
 void openView(java.lang.String viewId, java.lang.String viewSource, ClientOperation op, int navigation, java.lang.String linkContextTo, DataMapperFormat mapper)
          This method open a view and activates this,and stores all 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 inputMapFormat)
          This method instanciates de viewId,sets this view as the active view,and update the registry with the propertys of the view and shows it .
 void previousView()
          This method activates and shows the previous view associated to the activeView
 void refreshActiveView()
          This method refresh the active view of the Task
 void resizeActiveView(int height, int width)
          This method resizes the current displayed view param@ height int param@ width int
 void resizeActiveView(int height, int width, int xpos, int ypos)
          This method resizes the current displayed view at the indicated position param@ height int param@ width int param@ xpos float param@ ypos float
 void setActiveView(java.lang.String viewId)
          Sets the value of the ActiveView property.
 void setLevel(int i)
          return the level of the navigationArea respects 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)
          This method initiates a rollback sequence.
 

Method Detail

activateView

public void activateView(java.lang.String viewId)
This method shows the view associated to this viewId param@ viewId String

cancel

public void cancel(java.lang.String viewId)
This method initiates a rollback sequence.This method will close or not all the peers for the viewId, restoring the view hierarchy and activating the parent view

close

public void close()
This method gets the active view and call the closeView method to close the view.

closeNavigation

public void closeNavigation(java.lang.String viewId,
                            DataMapperFormat mapper)
This method close all the navigation of the panels and if an closeMapFormat is declared maps the value to the active view.

closeNavigation

public void closeNavigation(java.lang.String viewId,
                            java.lang.String closeMapFormat)
This method close all the navigation and maps the context of the viewId to the context of the parent view.

closeView

public void closeView(java.lang.String id)
This method close the view passed as parameter.
Parameters:
id - java.lang.String identifier of the view.

deActivateView

public void deActivateView(java.lang.String viewId)
This method disactivates the view associated to this viewId

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 associated to this viewId
Returns:
Vector a list of viewIds.

getPreviousView

public java.lang.String getPreviousView(java.lang.String viewId)
returns the String associated to the previous view of the viewId.

getViewInstance

public CoordinatedPanel getViewInstance(java.lang.String viewId)
This method returns the instance of the viewId

isChildren

public boolean isChildren(java.lang.String viewId)
Indicates that the viewId has children views.
Returns:
boolean

isPeer

public boolean isPeer(java.lang.String viewId)
Indicates that the viewId is peer of another view.
Returns:
boolean

nextView

public void nextView(java.lang.String viewId,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     java.lang.String inputMapFormat)
This method instanciates de viewId,sets this view as the active view,and update the registry with the propertys of the view and shows it .
Parameters:
viewId - String
op - DSEClientOperation
navigation - int
contextUsed - String
assignContext - boolean

nextView

public void nextView(java.lang.String id,
                     java.lang.String source,
                     ClientOperation operation,
                     int navigation,
                     java.lang.String linkContextTo,
                     java.lang.String inputPathFormat)
This method shows the next view and activates this,and stores the next and previous id of the 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

openView

public void openView(java.lang.String viewId)
              throws java.lang.Exception
This method instanciates de viewId,sets this view as the active view and shows it .
Parameters:
viewId - String

openView

public void openView(java.lang.String viewId,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     java.lang.String inputMapFormat)
This method instanciates de viewId,sets this view as the active view,and update the registry with the propertys of the view and shows it .
Parameters:
viewId - String
op - DSEClientOperation
navigation - int
contextUsed - String
assignContext - boolean

openView

public void openView(java.lang.String viewId,
                     ClientOperation op,
                     java.lang.Boolean executeOp)
              throws java.lang.Exception
This method instanciates de viewId and associates the operation name to the view. Sets this view as the active view and shows it.
Parameters:
viewId - String
op - String

openView

public void openView(java.lang.String viewId,
                     java.lang.String viewSource,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     DataMapperFormat mapper)
This method open a view and activates this,and stores all 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
operation - ClientOperation
navigation - int
linkContextTo - String
DataMapperFormat - mapper

openView

public void openView(java.lang.String viewId,
                     java.lang.String viewSource,
                     ClientOperation op,
                     int navigation,
                     java.lang.String linkContextTo,
                     java.lang.String inputMapFormat)
This method instanciates de viewId,sets this view as the active view,and update the registry with the propertys of the view and shows it .
Parameters:
viewId - String
op - DSEClientOperation
navigation - int
contextUsed - String
assignContext - boolean

previousView

public void previousView()
This method activates and shows the previous view associated to the activeView

refreshActiveView

public void refreshActiveView()
This method refresh the active view of the Task

resizeActiveView

public void resizeActiveView(int height,
                             int width)
This method resizes the current displayed view param@ height int param@ width int

resizeActiveView

public void resizeActiveView(int height,
                             int width,
                             int xpos,
                             int ypos)
This method resizes the current displayed view at the indicated position 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 respects 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)
This method initiates a rollback sequence. for the active view, restoring the view hierarchy and activating the parent view