Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

SWT LPEX
v3.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.lpex.core
Class LpexBaseAction

java.lang.Object
  com.ibm.lpex.core.LpexBaseAction

All Implemented Interfaces:

LpexAction

public abstract class LpexBaseAction

extends Object

implements LpexAction

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 popup menu item. A direct implementation of LpexAction, for example one added to the popup editor parameter by an application using the LPEX widget, has no means to provide this information.

See Also:

LpexView.defineAction(java.lang.String, com.ibm.lpex.core.LpexAction), 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.
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 tool tip text for the action.

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

LpexBaseAction

public LpexBaseAction()

Method Detail

available

public boolean available(LpexView lpexView)

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. The default implementation of this method returns true.

Specified by:

available in interface LpexAction

Parameters:

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

getHelpId

public String getHelpId(LpexView lpexView)

This method in the defined action will be called to query the context help id of the action. The default implementation of this method returns null.

Parameters:

lpexView - the document view for which the action help id is queried

getToolTipText

public String getToolTipText(LpexView lpexView)

This method in the defined action will be called to query the tool tip text for the action. The default implementation of this method returns null.

Parameters:

lpexView - the document view for which the action tool tip text is queried