org.openide.util

Interface ContextAwareAction

All Superinterfaces:

Action, ActionListener, EventListener

All Known Implementing Classes:

CallbackSystemAction

public interface ContextAwareAction
extends Action

Interface to be implemented by an action whose behavior is dependent on some context. The action created by ContextAwareAction.createContextAwareInstance(org.openide.util.Lookup) is bound to the provided context: Action.isEnabled(), ActionListener.actionPerformed(java.awt.event.ActionEvent), etc. may be specific to that context.

For example, the action representing a context menu item will usually implement this interface. When the actual context menu is created, rather than making a presenter for the generic action, the menu will contain a presenter for the context-aware instance. The context will then be taken from the GUI environment where the context menu was shown; for example it may be a TopComponent's context, often taken from an activated node selection. The context action might be enabled only if a certain "cookie" is present in that selection. When invoked, the action need not search for an object to act on, since it can use the context.

Since:

3.29

See Also:

NetBeans FAQ, Utilities.actionsToPopup(javax.swing.Action[], org.openide.util.Lookup), Utilities.actionsGlobalContext()

Field Summary

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Method Summary

Modifier and Type	Method and Description
Action	createContextAwareInstance(Lookup actionContext) Creates action instance for provided context.

Methods inherited from interface javax.swing.Action

accept, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Method Detail

createContextAwareInstance

Action createContextAwareInstance(Lookup actionContext)

Creates action instance for provided context.

Parameters:

actionContext - an arbitrary context (e.g. "cookies" from a node selection)

Returns:

a transient action whose behavior applies only to that context