com.ibm.lpex.samples
Class ComposeAction

java.lang.Object
  com.ibm.lpex.samples.ComposeAction

All Implemented Interfaces:

LpexAction

Direct Known Subclasses:

ComposeHebrewAction

public class ComposeAction
extends Object
implements LpexAction

Sample action compose - enter special characters. Use this action to enter into the document special characters that are not found on your default keyboard. For example, enter a acute (á) by typing a compose sequence consisting of a and apostrophe ('), and the plus-minus sign (±) by typing + and -.

Here is the ComposeAction source code.

To run this sample:

• Define this user action via an editor preference page, where available, or from the editor command line:

  set actionClass.compose com.ibm.lpex.samples.ComposeAction

• Run it from the editor command line:

  action compose

  or associate it with a key (here, Alt+F1 in the text area):

  set keyAction.a-f1 compose

See the source code for the supported compose sequences. To see these characters in the document, you may need a Unicode font installed on your system. The document must be saved to an encoding which supports the characters composed.

See Also:

All the samples

Field Summary

static LpexAction	composeAction Compose action that can be used when the compose command has been already defined in the view.
static LpexCommand	composeCommand Command to compose special characters from a sequence of regular ones.

Constructor Summary

ComposeAction()

Method Summary

boolean	available(LpexView lpexView) Returns the availability of this action.
void	doAction(LpexView lpexView) Runs the action.

Methods inherited from class java.lang.Object

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

Field Detail

composeCommand

public static final LpexCommand composeCommand

Command to compose special characters from a sequence of regular ones. Called by the input editor command when prompting for the compose sequence. Also used by TestUserProfile.

composeAction

public static final LpexAction composeAction

Compose action that can be used when the compose command has been already defined in the view. It is used by TestUserProfile.

Constructor Detail

ComposeAction

public ComposeAction()

Method Detail

doAction

public void doAction(LpexView lpexView)

Runs the action. Prompts the user for a compose sequence, then enters the (special) character(s) into the document. Uses the input default editor command, and the compose command defined in here.

Specified by:

doAction in interface LpexAction

Parameters:

lpexView - the document view in which the action is issued

available

public boolean available(LpexView lpexView)

Returns the availability of this action. This action can be run in any visible, writable document view.

Specified by:

available in interface LpexAction

Parameters:

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