cern.gp.actions.support

Class BeanAction

java.lang.Object

CookieAction

cern.gp.actions.support.BeanAction

Direct Known Subclasses:

AcceptAction, BeanActionSupport, CopyAction, DeleteAction, EditAction, RemoveAction, StopAction, ViewAction

public abstract class BeanAction
extends CookieAction

Generic action that should be used as a parent class for all actions linked to beans 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 :

• performCapability

Author:

Lionel Mestre

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BeanAction(java.lang.Class capabilityClass) Creates a new BeanAction linked a the given capabilityClass and with default mode MODE_ANY
protected	BeanAction(java.lang.Class capabilityClass, int mode) Creates a new BeanAction linked a the given capabilityClass and with the given mode

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class[]	cookieClasses() Returns the set of capabilities supported by this action.
javax.swing.JButton	createJButton() returns a Button that can invoke this action, and that is enabled or disabled properly.
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 int	mode()
protected void	performAction(Node[] activatedNodes) Standard perform action extended by actually activated nodes.
protected abstract void	performCapability(GPNode node, Capability capability) Performs the capability for the given node.
protected boolean	surviveFocusChange()

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanAction

protected BeanAction(java.lang.Class capabilityClass)

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

Parameters:

capabilityClass - the capability class associated with this action

BeanAction

protected BeanAction(java.lang.Class capabilityClass,
                     int mode)

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

Parameters:

capabilityClass - the capability class associated with this action

mode - the mode of this action (see modes in CookieAction)

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

cookieClasses

protected java.lang.Class[] cookieClasses()

Returns the set of capabilities supported by this action. Currently this action only support one single capability (named cookie in NetBeans).

Returns:

set of needed cookies

surviveFocusChange

protected boolean surviveFocusChange()

mode

protected int mode()

performAction

protected void performAction(Node[] activatedNodes)

Standard perform action extended by actually activated nodes.

Parameters:

activatedNodes - gives array of actually activated nodes.

See Also:

org.openide.util.actions.CookieAction#performAction

performCapability

protected abstract void performCapability(GPNode node,
                                          Capability capability)
                                   throws java.lang.reflect.InvocationTargetException

Performs the capability for the given node.

Parameters:

node - the node for which the capability is performed

capability - the capability to perform

Throws:

java.lang.reflect.InvocationTargetException