IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class NavigationParameters

java.lang.Object
  extended bycom.ibm.dse.gui.NavigationParameters
All Implemented Interfaces:
java.io.Serializable

public class NavigationParameters
extends java.lang.Object
implements java.io.Serializable

The NavigationParameters class is used by the DSECoordinationEvent to encapsulate its parameters.

See Also:
Serialized Form

Constructor Summary
NavigationParameters()
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newContextUsed, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, boolean newAssignContext, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat)
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newContextUsed, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, boolean newAssignContext, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat, int x, int y, int w, int h)
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newContextUsed, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, boolean newAssignContext, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat, int x, int y, int w, int h, boolean useP, boolean useS)
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newContextUsed, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat)
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newContextUsed, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat, int x, int y, int w, int h)
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newContextUsed, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat, int x, int y, int w, int h, boolean useP, boolean useS)
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newLinkContextTo, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat, java.lang.String newCloseMapFormat, java.lang.String newOpenMapFormat)
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newLinkContextTo, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat, java.lang.String newCloseMapFormat, java.lang.String newOpenMapFormat, int x, int y, int w, int h)
          This constructor creates a NavigationParameters object.
NavigationParameters(java.lang.String newLinkContextTo, int newNavigation, java.lang.String newOperationName, int newChainContext, java.lang.String newViewName, java.lang.String newViewSource, java.lang.String newOutputMapFormat, java.lang.String newInputMapFormat, java.lang.String newCloseMapFormat, java.lang.String newOpenMapFormat, int x, int y, int w, int h, boolean useP, boolean useS)
          This constructor creates a NavigationParameters object.
 
Method Summary
 DSECoordinationEvent generateCoordinationEvent(java.lang.String sourceType, java.lang.Object sourceEvent)
          Generates a DSECoordinationEvent with its values.
 int getChainContext()
          Gets the chainContext property (java.lang.String) value.
 java.lang.String getCloseMapFormat()
          Gets the CloseMapFormat name property (java.lang.String) value.
 int getH()
          Gets the height size of the view.
 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.
 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.lang.String getViewName()
          Gets the viewName property (java.lang.String) value.
 java.lang.String getViewSource()
          Gets the viewSource property (java.lang.String) value.
 int getW()
          Gets the width size of the view.
 int getX()
          Gets the x position of the view.
 int getY()
          Gets the y position of the view.
 boolean isUsePos()
          Gets the usePos property (boolean) value.
 boolean isUseSize()
          Gets the useSize property (boolean) value.
 void setChainContext(int newChainContext)
          Sets the chainContext name property (java.lang.String) value.
 void setCloseMapFormat(java.lang.String newCloseMapFormat)
          Sets the CloseMapFormat name property (java.lang.String) value.
 void setH(int newH)
          Sets the height size of the view.
 void setInputMapFormat(java.lang.String newInputMapFormat)
          Sets the InputMapFormat name property (java.lang.String) value.
 void setLinkContextTo(java.lang.String newContextUsed)
          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 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 setUsePos(boolean newUsePos)
          Sets the usePos property (boolean) value.
 void setUseSize(boolean newUseSize)
          Sets the useSize 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.
 void setW(int newW)
          Sets the width size of the view.
 void setX(int newX)
          Sets the x position of the view.
 void setY(int newY)
          Sets the y position of the view.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NavigationParameters

public NavigationParameters()
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newContextUsed,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat)
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newContextUsed,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat,
                            int x,
                            int y,
                            int w,
                            int h)
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newContextUsed,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat,
                            int x,
                            int y,
                            int w,
                            int h,
                            boolean useP,
                            boolean useS)
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newLinkContextTo,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat,
                            java.lang.String newCloseMapFormat,
                            java.lang.String newOpenMapFormat)
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newLinkContextTo,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat,
                            java.lang.String newCloseMapFormat,
                            java.lang.String newOpenMapFormat,
                            int x,
                            int y,
                            int w,
                            int h)
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newLinkContextTo,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat,
                            java.lang.String newCloseMapFormat,
                            java.lang.String newOpenMapFormat,
                            int x,
                            int y,
                            int w,
                            int h,
                            boolean useP,
                            boolean useS)
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newContextUsed,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            boolean newAssignContext,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat)
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newContextUsed,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            boolean newAssignContext,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat,
                            int x,
                            int y,
                            int w,
                            int h)
This constructor creates a NavigationParameters object.


NavigationParameters

public NavigationParameters(java.lang.String newContextUsed,
                            int newNavigation,
                            java.lang.String newOperationName,
                            int newChainContext,
                            java.lang.String newViewName,
                            java.lang.String newViewSource,
                            boolean newAssignContext,
                            java.lang.String newOutputMapFormat,
                            java.lang.String newInputMapFormat,
                            int x,
                            int y,
                            int w,
                            int h,
                            boolean useP,
                            boolean useS)
This constructor creates a NavigationParameters object.

Method Detail

generateCoordinationEvent

public DSECoordinationEvent generateCoordinationEvent(java.lang.String sourceType,
                                                      java.lang.Object sourceEvent)
Generates a DSECoordinationEvent with its values.

Returns:
DSECoordinationEvent - The DSECoordination Event

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.

getH

public int getH()
Gets the height size of the view.

Returns:
int - The h 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 linkContextTo 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.

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.

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.

getW

public int getW()
Gets the width size of the view.

Returns:
int - The w property value.

getX

public int getX()
Gets the x position of the view.

Returns:
int - The x property value.

getY

public int getY()
Gets the y position of the view.

Returns:
int - The y property value.

isUsePos

public boolean isUsePos()
Gets the usePos property (boolean) value.

Returns:
boolean

isUseSize

public boolean isUseSize()
Gets the useSize property (boolean) value.

Returns:
boolean

setChainContext

public void setChainContext(int newChainContext)
Sets the chainContext name property (java.lang.String) 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.

setH

public void setH(int newH)
Sets the height size of the view.

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

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

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

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.

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.

setUsePos

public void setUsePos(boolean newUsePos)
Sets the usePos property (boolean) value.

Parameters:
newUsePos - boolean, the new value for the property.

setUseSize

public void setUseSize(boolean newUseSize)
Sets the useSize property (boolean) value.

Parameters:
newUseSize - boolean,the new value for the property.

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.


setW

public void setW(int newW)
Sets the width size of the view.

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

setX

public void setX(int newX)
Sets the x position of the view.

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

setY

public void setY(int newY)
Sets the y position of the view.

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

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005