|
LPEX 3.6.8 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.lpex.core.LpexBaseAction
public abstract class LpexBaseAction
Base implementation of an LPEX action.
This class is an LpexAction
that can provide the application
with additional information needed by the resource that this action is
associated with, such as the context help id for an action bound to a pop-up
menu item.
LpexView.defineAction(java.lang.String, com.ibm.lpex.core.LpexAction)
Constructor Summary | |
---|---|
LpexBaseAction()
|
Method Summary | |
---|---|
boolean |
available(LpexView lpexView)
This method in the defined action will be called to query the availability of the action. |
boolean |
checkable()
This method in the defined action will be called to query whether menu items associated with this actions may be checked. |
boolean |
checked(LpexView lpexView)
This method in the defined action will be called to query the checked status of a checkable action. |
String |
getHelpId(LpexView lpexView)
This method in the defined action will be called to query the context help id of the action. |
String |
getToolTipText(LpexView lpexView)
This method in the defined action will be called to query the hover help text for the action. |
int |
screenShow(LpexView lpexView)
This method in the defined action will be called to query the suggested screen refresh to be undertaken after running this action as a user action or through the LpexView#triggerAction() method. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.lpex.core.LpexAction |
---|
doAction |
Constructor Detail |
---|
public LpexBaseAction()
Method Detail |
---|
public boolean available(LpexView lpexView)
false
, menu items associated
with this user action will be disabled, the key or mouse event to which
this action is assigned will not run it, and neither will the
action command.
The default implementation of this method returns true
.
available
in interface LpexAction
lpexView
- the document view for which the action availability is
queriedpublic boolean checkable()
true
, menu items associated
with this user action may be checked or unchecked, depending on the
status returned by method checked().
The default implementation of this method returns false
.
public boolean checked(LpexView lpexView)
true
, menu items associated
with this user action will be checked, otherwise they will be unchecked.
The default implementation of this method returns false
.
lpexView
- the document view for which the action's checked status is
queriedpublic String getHelpId(LpexView lpexView)
The default implementation of this method returns null
.
lpexView
- the document view for which the action help id is
queriedpublic String getToolTipText(LpexView lpexView)
The default implementation of this method returns null
.
lpexView
- the document view for which this action's hover help text is
queriedpublic int screenShow(LpexView lpexView)
The extent of the screens to be refreshed is indicated by one of these codes:
LpexConstants.SHOW_NONE
,
LpexConstants.SHOW_VIEW
,
LpexConstants.SHOW_DOCUMENT
,
LpexConstants.SHOW_ALL
.
The default implementation of this method returns SHOW_DOCUMENT
.
lpexView
- the document view for which this action's needed screen refresh is
queried
|
LPEX 3.6.8 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |