com.ibm.lpex.samples
Class KeyReferenceAction

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

All Implemented Interfaces:

LpexAction

public class KeyReferenceAction
extends Object
implements LpexAction

Sample action ref - display a key reference for the current view. Use this action to display a dialog with the editor actions available in the current document view, and their associated keys.

Here is the KeyReferenceAction 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.ref com.ibm.lpex.samples.KeyReferenceAction

• Run it from the editor command line:

  action ref

  or associate it with a key (here, Ctrl+Shift+L in all contexts):

  set keyAction.c-s-l.t.c.p ref

See Also:

All the samples

Constructor Summary

KeyReferenceAction()

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

Constructor Detail

KeyReferenceAction

public KeyReferenceAction()

Method Detail

doAction

public void doAction(LpexView lpexView)

Runs the action. Displays the key reference dialog.

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 run in any view that has an associated window.

Specified by:

available in interface LpexAction

Parameters:

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