com.ibm.as400.opnav
Interface InformationManager


public interface InformationManager

The interface which manages user information for the Operations Navigator framework An InformationManager implementation provides lists of user information for given key values. For example, the framework can call a registered information manager to discover what icon a user desires in the upper left corner of the Operation Navigator open Window.

Assumptions:

Since:
v4r4m0
See Also:
DropTargetManager

Field Summary
static java.lang.String ANIMATION_IMAGES
          Key value that allows the user to override the animation with their own animation.
static java.lang.String DEFAULT_LIST_HEADING
          Key value that allows the user to set the default list heading in the frame window.
static java.lang.String DEFAULT_TREE_HEADING
          Key value that allows the user to set the default tree heading in the frame window.
static java.lang.String FRAME_CLOSE
          Key value that allows the user to prevent a window from closing, the object to be returned is an array with one Boolean value.
static java.lang.String FRAME_DIMENSIONS
          Key value that allows the user to set the width and height of the frame window.
static java.lang.String FRAME_ICON
          Key value that allows the user to set the icon in the frame window.
static java.lang.String FRAME_TITLE
          Key value that allows the user to set the title in the frame window.
static java.lang.String LIST_HEADING
          Key value that allows the user to set the list heading in the frame window.
static java.lang.String OVERVIEW_HELP
          Key value that specifies whether the console will support help The object to be returned is an array with two values.
static java.lang.String ROOT_LISTMANAGER
          Key value that allows the user to specify the listmanager and root node.
static java.lang.String SUPPORT_CACHING
          Key value that specifies whether the console will cache open list managers for tree folder or list selections.
static java.lang.String SUPPORT_THREADS
          Key value that specifies whether the console will use threads to open list managers for tree folder or list selections.
static java.lang.String TASKPAD_AVAILABLE
          Key value that specifies whether the end user will be able to turn the taskpad on.
static java.lang.String TASKPAD_INFO
          Key value that allows the user to specify the title, tooltip, and icon for the taskpad title.
static java.lang.String TASKPAD_VISIBLE
          Key value that allows the user to specify whether the taskpad should be visible at initial display of the console.
static java.lang.String TREE_AVAILABLE
          Key value that specifies whether the end user will be able to turn the tree pane on.
static java.lang.String TREE_HEADING
          Key value that allows the user to set the tree heading in the frame window.
static java.lang.String TREE_VISIBLE
          Key value that allows the user to specify whether the tree pane should be visible at initial display of the console.
 
Method Summary
 void initialize(ObjectName objName)
          This method is called immediately before the frame window is created when registered in the Java Registry on the root node.
 void prepareToExit()
          This method is called just before the frame window is destroyed.
 java.lang.Object[] queryInformation(java.lang.String keyValue)
          Returns a list of objects which are applicable to the specified keyValue.
 

Field Detail

FRAME_TITLE

public static final java.lang.String FRAME_TITLE
Key value that allows the user to set the title in the frame window. Object to return is a String containing the title

FRAME_ICON

public static final java.lang.String FRAME_ICON
Key value that allows the user to set the icon in the frame window. Object to return is a String containing the file name of an Icon to display

LIST_HEADING

public static final java.lang.String LIST_HEADING
Key value that allows the user to set the list heading in the frame window. Object to return is a String to display in the list header

TREE_HEADING

public static final java.lang.String TREE_HEADING
Key value that allows the user to set the tree heading in the frame window. Object to return is a String to display in the tree header

DEFAULT_LIST_HEADING

public static final java.lang.String DEFAULT_LIST_HEADING
Key value that allows the user to set the default list heading in the frame window. Object to return is a default String to display in the list header

DEFAULT_TREE_HEADING

public static final java.lang.String DEFAULT_TREE_HEADING
Key value that allows the user to set the default tree heading in the frame window. Object to return is the default String to display in the tree header

FRAME_DIMENSIONS

public static final java.lang.String FRAME_DIMENSIONS
Key value that allows the user to set the width and height of the frame window. Note, the values you return to us will be overridden if the end user has previously changed the frame width or height. Object to return is a vector with two Integers. The first integer is the width of the frame in pixels. The second integer is the height of the frame in pixels. A null for width will result in a default frame width. Likewise, a null for height will result in a default frame height.

FRAME_CLOSE

public static final java.lang.String FRAME_CLOSE
Key value that allows the user to prevent a window from closing, the object to be returned is an array with one Boolean value. Return true if you would like the window to close (default) or false if you want to prevent the window from closing.

TREE_VISIBLE

public static final java.lang.String TREE_VISIBLE
Key value that allows the user to specify whether the tree pane should be visible at initial display of the console. The object to be returned is an array with one Boolean value. Return true if you would like the tree pane to be visible. Return false to have the tree turned off. Default value for this key is true.

TASKPAD_VISIBLE

public static final java.lang.String TASKPAD_VISIBLE
Key value that allows the user to specify whether the taskpad should be visible at initial display of the console. The object to be returned is an array with one Boolean value. Return true if you would like the taskpad to be visible. Return false to have the taskpad turned off at initial display of the console. Default value for this key is true. Note: The value returned for this key will be overidden by user settings.

TREE_AVAILABLE

public static final java.lang.String TREE_AVAILABLE
Key value that specifies whether the end user will be able to turn the tree pane on. The object to be returned is an array with one Boolean value. Return true if you would like the tree pane to be available to the user. Return false if you would the tree to never be available to the user. Default value for this key is true. Note: This value can never be overridden by user settings.

TASKPAD_AVAILABLE

public static final java.lang.String TASKPAD_AVAILABLE
Key value that specifies whether the end user will be able to turn the taskpad on. The object to be returned is an array with one Boolean value. Return true if you would like the taskpad to be available to the user. Return false if you would the taskpad to never be available to the user. Default value for this key is true. Note: This value can never be overridden by user settings.

SUPPORT_THREADS

public static final java.lang.String SUPPORT_THREADS
Key value that specifies whether the console will use threads to open list managers for tree folder or list selections. The object to be returned is an array with one Boolean value. Return true if you would like threads to be used to open list managers. Return false if you do not want threads to be used Default value for this key is true.`

SUPPORT_CACHING

public static final java.lang.String SUPPORT_CACHING
Key value that specifies whether the console will cache open list managers for tree folder or list selections. The object to be returned is an array with one Boolean value. Return true if you would like caching to be used. Return false if you do not want caching to be used Default value for this key is true.`

OVERVIEW_HELP

public static final java.lang.String OVERVIEW_HELP
Key value that specifies whether the console will support help The object to be returned is an array with two values. The first value is of type String. This is to be the fully qualified path of the file containing the overview help for your project. This path must match the path to your xxx.hs accessible from your classpath. The second value is of type String. This is to be the index of the help to be initially displayed in the help viewer. For example Object[] value = {"com/ibm/as400/opnav/SampleHelp.hs", "INDEX"};

TASKPAD_INFO

public static final java.lang.String TASKPAD_INFO
Key value that allows the user to specify the title, tooltip, and icon for the taskpad title. The object to be returned is an array with three Strings. The first item in the array should be a String for the title of the taskpad. The second item in the array is a String for the tooltip that will be displayed when the user hovers over the taskpad title. The third item in the array is a String that is the qualified path name to the icon that should be displayed next to the taskpad title. Note: file paths must NOT begin with a leading slash and must be of the format "xxx/yyy/zzz/aaa.gif"

ROOT_LISTMANAGER

public static final java.lang.String ROOT_LISTMANAGER
Key value that allows the user to specify the listmanager and root node. The object to be returned is an array with two Strings. The first item in the array should be a String for the listmanager. The second item in the array is a String for the root node.

ANIMATION_IMAGES

public static final java.lang.String ANIMATION_IMAGES
Key value that allows the user to override the animation with their own animation. The object to be returned is an array with two Strings. The first String is the qualified path to a static gif image of size 21 by 21 pixels. The second string is the path to the animated gif file (gif 89A format) of size 21 by 21 pixels. Note: file paths must begin with a leading slash and be of format "/xxx/yyy/zzz/aaa.gif"
Method Detail

initialize

public void initialize(ObjectName objName)
This method is called immediately before the frame window is created when registered in the Java Registry on the root node. This method is called

Parameters:
system - For an open Window, this is the system at the root of the tree. This may be null.
Since:
v5r1m0

queryInformation

public java.lang.Object[] queryInformation(java.lang.String keyValue)
Returns a list of objects which are applicable to the specified keyValue. This method is called when the user interface needs to gather information to alter the Operations Navigator frame window. For example, if the keyValue = "FRAME_TITLE" the user should return an array whose first object is a string that will be used for the frame title. For example, if the keyValue = "LIST_HEADING" the user should return an array whose first object is a string that will be used for the list heading.
Parameters:
keyBalue - the constants which indicate the type of actions requested.
Returns:
an array of objects, each of which is dependent on the key value. If no information is available for the keyValue, queryInformation should return null or an array of zero elements.
Since:
v5r1m0

prepareToExit

public void prepareToExit()
This method is called just before the frame window is destroyed.

Since:
v5r1m0