com.ibm.as400.opnav
Interface ActionsManager


public interface ActionsManager

The interface which manages user actions defined for a system object. An ActionsManager implementation provides lists of user actions to a user interface, without knowing or caring how the user interface is implemented. It is also responsible for performing actions requested by the user.

User interface assumptions:

Implementation assumptions:

Since:
v4r4m0
See Also:
ListManager, DropTargetManager

Field Summary
static int CREATION_ACTIONS
          Indicates that object creation actions are requested.
static int CUSTOM_ACTIONS
          Indicates that custom actions are requested.
static int DEFAULT_ACTION
          Indicates that only the default action is requested.
static int MENUBAR_ACTIONS
          Indicates that menubar actions are requested NOTE: THIS ACTION IS NOT CURRENTLY SUPPORTED
static int OPTION_ACTIONS
          Indicates that options are requested
static int STANDARD_ACTIONS
          Indicates that standard actions are requested.
static int TOOLBAR_ACTIONS
          Indicates that toolbar actions are requested NOTE: THIS ACTION IS NOT CURRENTLY SUPPORTED
static int VIEW_ACTIONS
          Indicates that view actions are requested.
 
Method Summary
 void actionSelected(int action, java.awt.Frame owner)
          Informs the ActionsManager implementation that a particular action has been selected by the user.
 void initialize(ObjectName[] objectNames, ObjectName dropTarget)
          Identifies the objects in a list on which the user may wish to perform some action.
 ActionDescriptor[] queryActions(int flags)
          Returns a list of actions which are applicable to the specified objects.
 

Field Detail

DEFAULT_ACTION

public static final int DEFAULT_ACTION
Indicates that only the default action is requested.

CUSTOM_ACTIONS

public static final int CUSTOM_ACTIONS
Indicates that custom actions are requested.

CREATION_ACTIONS

public static final int CREATION_ACTIONS
Indicates that object creation actions are requested.

STANDARD_ACTIONS

public static final int STANDARD_ACTIONS
Indicates that standard actions are requested.

OPTION_ACTIONS

public static final int OPTION_ACTIONS
Indicates that options are requested

TOOLBAR_ACTIONS

public static final int TOOLBAR_ACTIONS
Indicates that toolbar actions are requested NOTE: THIS ACTION IS NOT CURRENTLY SUPPORTED

MENUBAR_ACTIONS

public static final int MENUBAR_ACTIONS
Indicates that menubar actions are requested NOTE: THIS ACTION IS NOT CURRENTLY SUPPORTED

VIEW_ACTIONS

public static final int VIEW_ACTIONS
Indicates that view actions are requested.
Method Detail

initialize

public void initialize(ObjectName[] objectNames,
                       ObjectName dropTarget)
Identifies the objects in a list on which the user may wish to perform some action. This method is called immediately after this object is instantiated.

If the user interface is displaying the list of available actions resulting from a drag and drop operation, the dropTarget parameter identifies the name of the target container. Otherwise, dropTarget will be null.

Parameters:
objectNames - an array of object names.
dropTarget - the container into which the objects are being dropped (may be null).
Since:
v4r4m0
See Also:
ObjectName

queryActions

public ActionDescriptor[] queryActions(int flags)
Returns a list of actions which are applicable to the specified objects. This method is called when the user interface needs to display the available actions on one or more objects in a list of system objects.
Parameters:
flags - the constants which indicate the type of actions requested.
Returns:
an array of action descriptors, each of which describes one action. If no actions are defined on the objects, queryActions should return null or an array of zero elements.
Since:
v4r4m0
See Also:
ActionDescriptor

actionSelected

public void actionSelected(int action,
                           java.awt.Frame owner)
Informs the ActionsManager implementation that a particular action has been selected by the user.

The implementation should respond to the request by displaying a UI panel or taking some action on behalf of the user.

Parameters:
action - the identifier of the action specified in the ActionDescriptor that was returned by queryActions.
owner - the frame to be specified as the owner of any dialog panels that are displayed. This frame should be passed to any UIServices methods that require a frame.
Since:
v4r4m0
See Also:
UIServices