org.openide.util.actions
Class CallableSystemAction

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CallbackSystemAction, GarbageCollectAction, NodeAction, OpenProjectAction, PageSetupAction, PasteAction, ProjectSensitiveAction, RedoAction, SaveAllAction, UndoAction, WorkspaceSwitchAction

public abstract class CallableSystemAction

extends SystemAction

implements Presenter.Menu, Presenter.Popup, Presenter.Toolbar

An action which may be called programmatically. Typically a presenter will call its performAction() method, which must be implemented.

Provides default presenters using the Actions utility class.

See Also:

Serialized Form

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

CallableSystemAction()

Method Summary

void	actionPerformed(ActionEvent ev) Actually perform the action.
JMenuItem	getMenuPresenter() Get a menu item that can present this action in a JMenu.
JMenuItem	getPopupPresenter() Get a menu item that can present this action in a JPopupMenu.
Component	getToolbarPresenter() Get a component that can present this action in a JToolBar.
abstract void	performAction() Actually perform the action.

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

clearSharedData, createPopupMenu, createToolbarPresenter, get, getHelpCtx, getIcon, getIcon, getName, 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

CallableSystemAction

public CallableSystemAction()

Method Detail

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

getToolbarPresenter

public Component getToolbarPresenter()

Description copied from interface: Presenter.Toolbar

Get a component that can present this action in a JToolBar.

Specified by:

getToolbarPresenter in interface Presenter.Toolbar

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

Returns:

the representation for this action

performAction

public abstract void performAction()

Actually perform the action. This is the method which should be called programmatically. Presenters in Actions use this.

See SystemAction.actionPerformed(java.awt.event.ActionEvent) for a note on threading usage: in particular, do not access GUI components without explicitly asking for the AWT event thread!

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