com.ibm.lpex.samples
Class TestAction

java.lang.Object
  |
  +--com.ibm.lpex.samples.TestAction

All Implemented Interfaces:

LpexAction

public class TestAction

extends java.lang.Object

implements LpexAction

This class is a sample action implementation. Running this action will display a short message on the editor message line. The action is available in any non-readonly view in which it is defined.

Here is the TestAction code.

To run this sample:

• Compile the action class:

  javac TestAction.java

• Define the action, by entering this on the editor command line:

  set actionClass.testAction com.ibm.lpex.samples.TestAction

• Run the action from the editor command line, by entering:

  action testAction

See Also:

LpexAction, LpexView

Constructor Summary

TestAction()

Method Summary

boolean	available(LpexView lpexView) This method in the defined action will be called to query the availability of the action.
void	doAction(LpexView lpexView) This method in the defined action will be called to run the action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestAction

public TestAction()

Method Detail

doAction

public void doAction(LpexView lpexView)

Description copied from interface: LpexAction

This method in the defined action will be called to run the action.

An action may be run (e.g., from the LPEX command line) with the action editor command, by selecting an associated menu item, or by activating the key or the mouse event to which the action is assigned.

Specified by:

doAction in interface LpexAction

Following copied from interface: com.ibm.lpex.core.LpexAction

Parameters:

lpexView - the document view in which the action is issued

available

public boolean available(LpexView lpexView)

Description copied from interface: LpexAction

This method in the defined action will be called to query the availability of the action.

When this method returns 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.

Specified by:

available in interface LpexAction

Following copied from interface: com.ibm.lpex.core.LpexAction

Parameters:

lpexView - the document view for which the action availability is queried