org.openide.actions
Class ToolsAction

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

All Implemented Interfaces:

Action, ActionListener, EventListener, Externalizable, Presenter, Presenter.Menu, Presenter.Popup, Serializable

public class ToolsAction

extends SystemAction

implements Presenter.Menu, Presenter.Popup

A "meta-action" that displays (in a submenu) a list of enabled actions provided by modules. Such registered actions are called "service actions": they are provided externally but seem to provide additional services on existing components. Often they will be NodeActions or CookieActions so that they will be enabled based on the node selection, i.e. the node containing this popup. It is desirable for most nodes to include this action somewhere in their popup menu.

Note: you do not need to touch this class to add a service action! Just add the action to a module manifest in an Action section.

The list of registered service actions is provided to this action from the implementation by means of ActionManager.

See Also:

Serialized Form

Inner Class Summary

static interface

ToolsAction.Model Deprecated. Useless, see ActionManager.

Inner classes inherited from class org.openide.util.actions.Presenter

Presenter.Menu, Presenter.Popup, Presenter.Toolbar

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

ToolsAction()

Method Summary

void	actionPerformed(ActionEvent ev) Actually perform the action.
HelpCtx	getHelpCtx() Get a help context for the action.
JMenuItem	getMenuPresenter() Get a menu item that can present this action in a JMenu.
String	getName() Get a human presentable name of the action.
JMenuItem	getPopupPresenter() Get a menu item that can present this action in a JPopupMenu.
static void	setModel(ToolsAction.Model m) Deprecated. Useless, see ActionManager.

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

clearSharedData, createPopupMenu, createToolbarPresenter, get, getIcon, getIcon, getValue, iconResource, initialize, 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

ToolsAction

public ToolsAction()

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

getMenuPresenter

public JMenuItem getMenuPresenter()

Description copied from interface: Presenter.Menu

Get a menu item that can present this action in a JMenu.

Specified by:

getMenuPresenter in interface Presenter.Menu

Following copied from interface: org.openide.util.actions.Presenter.Menu

Returns:

the representation for this action

getPopupPresenter

public JMenuItem getPopupPresenter()

Description copied from interface: Presenter.Popup

Get a menu item that can present this action in a JPopupMenu.

Specified by:

getPopupPresenter in interface Presenter.Popup

Following copied from interface: org.openide.util.actions.Presenter.Popup

Returns:

the representation for this action

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

setModel

public static void setModel(ToolsAction.Model m)

Deprecated. Useless, see ActionManager.