org.openide.actions
Class HelpAction

java.lang.Object
  |
  +--org.openide.util.SharedClassObject
        |
        +--org.openide.util.actions.SystemAction
              |
              +--org.openide.actions.HelpAction

All Implemented Interfaces:

Action, ActionListener, EventListener, Externalizable, Serializable

public class HelpAction

extends SystemAction

Show help for the currently selected workspace element.

See Also:

HelpCtx.findHelp(java.awt.Component), Serialized Form

Fields inherited from class org.openide.util.actions.SystemAction

PROP_ENABLED, PROP_ICON

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

HelpAction()

Method Summary

void	actionPerformed(ActionEvent ev) Actually perform the action.
HelpCtx	getHelpCtx() Get a help context for the action.
String	getName() Get a human presentable name of the action.
protected String	iconResource() Specify the proper resource name for the action's icon.
protected void	initialize() Initialize the action.

Methods inherited from class org.openide.util.actions.SystemAction

clearSharedData, createPopupMenu, createToolbarPresenter, get, getIcon, getIcon, getValue, isEnabled, linkActions, putValue, setEnabled, setIcon

Methods inherited from class org.openide.util.SharedClassObject

addNotify, addPropertyChangeListener, equals, finalize, findObject, findObject, firePropertyChange, getLock, getProperty, hashCode, putProperty, putProperty, readExternal, removeNotify, removePropertyChangeListener, writeExternal, writeReplace

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.Action

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

HelpAction

public HelpAction()

Method Detail

getName

public String getName()

Description copied from class: SystemAction

Get a human presentable name of the action. This may be presented as an item in a menu.

Using the normal menu presenters, an included ampersand before a letter will be treated as the name of a mnemonic.

Overrides:

getName in class SystemAction

Following copied from class: org.openide.util.actions.SystemAction

Returns:

the name of the action

getHelpCtx

public HelpCtx getHelpCtx()

Description copied from class: SystemAction

Get a help context for the action.

Overrides:

getHelpCtx in class SystemAction

Following copied from class: org.openide.util.actions.SystemAction

Returns:

the help context for this action

iconResource

protected String iconResource()

Description copied from class: SystemAction

Specify the proper resource name for the action's icon. May be overridden by subclasses. Typically this should be a 16x16 color GIF.

Overrides:

iconResource in class SystemAction

Following copied from class: org.openide.util.actions.SystemAction

Returns:

the resource name for the icon, e.g. /com/mycom/mymodule/myIcon.gif; or null to make a text label

initialize

protected void initialize()

Description copied from class: SystemAction

Initialize the action. The default implementation just enabled it.

Overrides:

initialize in class SystemAction

actionPerformed

public void actionPerformed(ActionEvent ev)

Description copied from class: SystemAction

Actually perform the action. Specified in ActionListener.actionPerformed(java.awt.event.ActionEvent).

In some cases, the implementation may have an empty body, if the presenters handle the performing of the action in a different way than by calling this method.

When run in the normal way from the action manager (e.g. as part of a standard menu or toolbar presenter), the action body can block and take time, but needs to explicitly ask to enter the AWT event thread if doing any GUI work. See the Threading Models document in API documentation for details.

Overrides:

actionPerformed in class SystemAction

Following copied from class: org.openide.util.actions.SystemAction

Parameters:

ev - the event triggering the action