|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.opnav.ActionDescriptor
A data entity which describes an action which a user may take on
one or more system objects.
An ActionDescriptor
provides the text for the action,
information on how it should be presented, and an identifier which
is passed when a user requests that a particular action be performed.
An ActionDescriptor
may serve to identify a group
of logically related subactions. For example, a CREATE action may
have associated subactions which identify the types of objects the
user may create. The subactions are displayed as having a logical
relationship to the main action, often as a cascading submenu
from an action in a main menu.
ActionsManager
Field Summary | |
static int |
ADD_MENU_ACTION
THIS CONSTANT IS CURRENTLY NOT SUPPORTED For Menubar actions this constant defines the action requested Indicates that a new menu is to added. |
static int |
ADD_MENUITEM_ACTION
THIS CONSTANT IS CURRENTLY NOT SUPPORTED For Menubar actions this constant defines the action requested Indicates that a new menu item is to added. |
static int |
ADD_TOOLBARITEM_ACTION
THIS CONSTANT IS CURRENTLY NOT SUPPORTED For Toolbar actions this constant defines the action requested Indicates that a new toolbar item is to added. |
static int |
CHANGE_MENUITEM_ACTION
THIS CONSTANT IS CURRENTLY NOT SUPPORTED For Menubar actions this constant defines the action requested Indicates that an existing menu item is to be enabled/disabled. |
static int |
CHANGE_TOOLBARITEM_ACTION
THIS CONSTANT IS CURRENTLY NOT SUPPORTED For Toolbar actions this constant defines the action requested Indicates that an existing toolbar item is to be modified. |
static int |
DELETE_MENU_ACTION
THIS CONSTANT IS CURRENTLY NOT SUPPORTED For Menubar actions this constant defines the action requested Indicates that an existing new menu is to be removed. |
static int |
DELETE_MENUITEM_ACTION
THIS CONSTANT IS CURRENTLY NOT SUPPORTED For Menubar actions this constant defines the action requested Indicates that an existing menu item is to be removed. |
static int |
DELETE_TOOLBARITEM_ACTION
THIS CONSTANT IS CURRENTLY NOT SUPPORTED For Toolbar actions this constant defines the action requested Indicates that an existing toolbar item is to be removed. |
Constructor Summary | |
ActionDescriptor()
Constructs an action descriptor which acts as a "separator". |
|
ActionDescriptor(int ID)
Constructs an action descriptor. |
Method Summary | |
boolean |
getContextMenuOnly()
THIS METHOD IS CURRENTLY NOT SUPPORTED Indicates that you want this item to appear in the context menu only, and not in any other menu (i.e. |
java.lang.String |
getHelpText()
Returns the action's help text. |
javax.swing.Icon |
getIcon()
THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the icon for this action item in the toolbar |
int |
getID()
Returns the action's identifier. |
int |
getMenubarAction()
THIS METHOD IS CURRENTLY NOT SUPPORTED For menubar actions this is the action that should occur Returns the menubar action that was set in setMenubarAction |
java.lang.String |
getMenuVerb()
THIS METHOD IS CURRENTLY NOT SUPPORTED For menubar actions this is the verb of the menu Returns the menu verb that was set in setMenuVerb |
int |
getPosition()
THIS METHOD IS CURRENTLY NOT SUPPORTED Returns the relative position of this action item in the toolbar/menubar/context menu The default value of -1 means the item is the leftmost/topmost item |
ActionDescriptor[] |
getSubactions()
Returns the action's subactions. |
java.lang.String |
getText()
Returns the action's text description. |
int |
getToolbarAction()
THIS METHOD IS CURRENTLY NOT SUPPORTED For toolbar actions this is the action that should occur Returns the toolbar action that was set in setToolbarAction |
java.lang.String |
getVerb()
Returns the action's verb. |
boolean |
isDefault()
Indicates whether this is the default action. |
boolean |
isEnabled()
Indicates whether the action is enabled. |
void |
setContextMenuOnly(boolean contextOnly)
THIS METHOD IS CURRENTLY NOT SUPPORTED Indicates that you want this item to appear in the context menu only, and not in any other menu (i.e. |
void |
setDefault(boolean bDefault)
Makes this action the default action. |
void |
setEnabled(boolean enabled)
Enables or disables the action. |
void |
setHelpText(java.lang.String helpText)
Sets the action's help text. |
void |
setIcon(javax.swing.Icon icon)
THIS METHOD IS CURRENTLY NOT SUPPORTED If this is a toolbar action this is the Icon to show in the button |
void |
setID(int ID)
Sets the action's identifier. |
void |
setMenubarAction(int actionType)
THIS METHOD IS CURRENTLY NOT SUPPORTED For menubar actions this is the action that should occur Valid action types include: ADD_MENU_ACTION - Add a new menu to the current menubar DELETE_MENU_ACTION - Delete a menu from the current menubar ADD_MENUITEM_ACTION - Add a new menu item to an existing menu CHANGE_MENUITEM_ACTION - Enable/Disable a menu item DELETE_MENUITEM_ACTION - Remove a menu item |
void |
setMenuVerb(java.lang.String menuVerb)
THIS METHOD IS CURRENTLY NOT SUPPORTED For menubar actions this identifies the menu for the requested change. |
void |
setPosition(int location)
THIS METHOD IS CURRENTLY NOT SUPPORTED If this is a toolbar/menubar/context menu action this is the relative position. |
void |
setSubactions(ActionDescriptor[] subactions)
Sets the action's subactions. |
void |
setText(java.lang.String text)
Sets the action's text description. |
void |
setToolbarAction(int actionType)
THIS METHOD IS CURRENTLY NOT SUPPORTED For toolbar actions this is the action that should occur Valid action types include: ADD_TOOLBARITEM_ACTION - Add a new toolbar item to an existing menu DELETE_TOOLBAR_ACTION - Delete a toolbar item |
void |
setVerb(java.lang.String verb)
Sets the action's verb. |
java.lang.String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final int ADD_MENU_ACTION
public static final int ADD_MENUITEM_ACTION
public static final int CHANGE_MENUITEM_ACTION
public static final int DELETE_MENU_ACTION
public static final int DELETE_MENUITEM_ACTION
public static final int ADD_TOOLBARITEM_ACTION
public static final int CHANGE_TOOLBARITEM_ACTION
public static final int DELETE_TOOLBARITEM_ACTION
Constructor Detail |
public ActionDescriptor()
An action descriptor constructed in this way indicates that the user interface should make a separation between the preceding action and the next action. The actual effect on the list of displayed actions is dependent on the UI platform.
public ActionDescriptor(int ID)
ActionsManager
implementation should use
the settor methods to completely describe the user action.ID
- the identifier which will be used to determine what
action the user has requested.Method Detail |
public java.lang.String getText()
setText(java.lang.String)
public void setText(java.lang.String text)
text
- the text description in a form suitable for displaying to the user.getText()
public java.lang.String getHelpText()
setHelpText(java.lang.String)
public void setHelpText(java.lang.String helpText)
helpText
- the help text string in a form suitable for displaying in a status area.getHelpText()
public java.lang.String getVerb()
setVerb(java.lang.String)
public void setVerb(java.lang.String verb)
verb
- the verb string which identifies the action. This string is never
displayed to the user and should not be translated.getVerb()
public boolean isEnabled()
setEnabled(boolean)
public void setEnabled(boolean enabled)
enabled
- true if the action should enabled; false otherwise.isEnabled()
public boolean isDefault()
setDefault(boolean)
public void setDefault(boolean bDefault)
isDefault()
public int getID()
setID(int)
public void setID(int ID)
ID
- the identifier which will be used to determine what
action the user has requested.getID()
public void setPosition(int location)
location
- the relative postion of the item in the toolbar/menubargetPosition()
public int getPosition()
setPosition(int)
public void setIcon(javax.swing.Icon icon)
icon
- the icon to place in the buttongetIcon()
public javax.swing.Icon getIcon()
setIcon(javax.swing.Icon)
public void setMenubarAction(int actionType)
actionType
- the valid action typegetMenubarAction()
public int getMenubarAction()
setMenubarAction(int)
public void setToolbarAction(int actionType)
actionType
- the valid action typegetToolbarAction()
public int getToolbarAction()
getToolbarAction()
public void setMenuVerb(java.lang.String menuVerb)
menuVerb
- the menu verb name for the actiongetMenuVerb()
public java.lang.String getMenuVerb()
setMenuVerb(java.lang.String)
public ActionDescriptor[] getSubactions()
ActionDescriptor
s which identify
this object's subactions.setSubactions(com.ibm.as400.opnav.ActionDescriptor[])
public void setSubactions(ActionDescriptor[] subactions)
subactions
- the array of ActionDescriptor
s which identify
this object's subactions.getSubactions()
public boolean getContextMenuOnly()
getContextMenuOnly()
public void setContextMenuOnly(boolean contextOnly)
contextOnly
- getContextMenuOnly()
public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |