cern.gp.actions.support

Class NodeAction

java.lang.Object

org.openide.util.actions.NodeAction

cern.gp.actions.support.NodeAction

Direct Known Subclasses:

ContextAction

public abstract class NodeAction
extends org.openide.util.actions.NodeAction

Generic action that should be used as a parent class for all actions linked to nodes in the GP Platform.

Subclasses should overwrite the following methods in order to provide custom name and icon (if not overwritten a generic name and icon will be used) :

• getName
• iconResource

Subclasses must overwrite the following abstract methods :

• performAction(GPNode[])

The action will only be enable if at least one GPNode is in the selection. It is possible to change the behavior of the enable by overriding the enable method.

Author:

Lionel Mestre

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeAction() Creates a new BeanAction linked a the given capabilityClass and with default mode MODE_ANY

Method Summary

Modifier and Type	Method and Description
javax.swing.JButton	createJButton() returns a Button that can invoke this action, and that is enabled or disabled properly.
protected boolean	enable(Node[] activatedNodes) The action will only be enabled if at least one GPNode is selected.
HelpCtx	getHelpCtx() Help context where to find more about the action.
java.lang.String	getName() Human presentable name of the action.
protected java.lang.String	iconResource() Returns the pathname of the icon to use to display this action
protected void	performAction(Node[] activatedNodes) Standard perform action extended by actually activated nodes.
protected boolean	surviveFocusChange()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeAction

protected NodeAction()

Creates a new BeanAction linked a the given capabilityClass and with default mode MODE_ANY

Parameters:

capabilityClass - the capability class associated with this action

Method Detail

getName

public java.lang.String getName()

Human presentable name of the action. This should be presented as an item in a menu.

Returns:

the name of the action

getHelpCtx

public HelpCtx getHelpCtx()

Help context where to find more about the action.

Returns:

the help context for this action

createJButton

public javax.swing.JButton createJButton()

returns a Button that can invoke this action, and that is enabled or disabled properly. This is analogous to getMenuItemPresenter() or getToolBarPresenter()

Returns:

a button connected to this action

iconResource

protected java.lang.String iconResource()

Returns the pathname of the icon to use to display this action

Returns:

the pathname of the icon

surviveFocusChange

protected boolean surviveFocusChange()

enable

protected boolean enable(Node[] activatedNodes)

The action will only be enabled if at least one GPNode is selected.

Parameters:

activatedNodes - gives array of actually activated nodes.

See Also:

org.openide.util.actions.NodeAction#enable

performAction

protected void performAction(Node[] activatedNodes)

Standard perform action extended by actually activated nodes. Only actual instance of GPNode are taking into account by this implementation. The other are ignored.

Parameters:

activatedNodes - gives array of actually activated nodes.

See Also:

org.openide.util.actions.NodeAction#performAction