cern.gp.actions.support

Class ActionUtils

java.lang.Object

cern.gp.actions.support.ActionUtils

public class ActionUtils
extends java.lang.Object

A few utility methods for Actions. This is partly an extension to the functionality in openide.awt.Actions.

Author:

Vito Baggiolini

Method Summary

Modifier and Type	Method and Description
static javax.swing.Action	actionForComp(TopComponent tc, java.lang.Class action) helper method, creates an action that is "connected" to the nodes inside a TopComponent.
static javax.swing.JComponent	addJButtons(javax.swing.JComponent comp, java.lang.Class[] actionClasses) Deprecated. -- tell us (proj-gp-dev@cern.ch) if you really need it!
static javax.swing.JButton	createJButton(java.lang.Class actionClass) creates a JButton for the action class.
static javax.swing.JButton	createJButton(SystemAction act) Deprecated. -- use #createJButton(Action)
static javax.swing.JButton	createJButton(TopComponent tc, java.lang.Class actionClass) creates a JButton for the action class that listens to Nodes in the specified TopComponent.
static javax.swing.JPanel	createJButtonPanel(java.lang.Class[] actionClasses) creates a JPanel with JButtons for the actions specified.
static javax.swing.JPanel	createJButtonPanel(TopComponent tc, java.lang.Class[] actionClasses) creates a JPanel with JButtons for action classes that listen to Nodes in the specified TopComponent.
static javax.swing.ImageIcon	getBlankIcon() utility method, returns a blank icon, can be used if an existing icon shall be "hidden"

Methods inherited from class java.lang.Object

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

Method Detail

createJButton

public static javax.swing.JButton createJButton(java.lang.Class actionClass)

creates a JButton for the action class. This button takes its icon, description, shortcut etc from the action class. It is enabled whenever the action is enabled.

Returns:

a JButton

createJButton

public static javax.swing.JButton createJButton(TopComponent tc,
                                                java.lang.Class actionClass)

creates a JButton for the action class that listens to Nodes in the specified TopComponent. This is useful, e.g. when you want to place the JButton in a separate TopComponent (i.e. not in the Explorer TopComponent itself)

Parameters:

tc - the TopComponent that contains the nodes (typically this is an Explorer)

actionClass - an action supported by one or more of the nodes in the TopComponent

Returns:

a JButton

Since:

2.0.5

createJButton

public static javax.swing.JButton createJButton(SystemAction act)

Deprecated. -- use #createJButton(Action)

creates a JButton for the SystemAction itself. You should not need to use this method, rather use createJButton(Class) If you find you need to use this action, please do not create actions yourself, use the SystemAction#get(java.lang.Class) or {@link #actionForComp(TopComponent, Class)} instead.

Returns:

a JButton

See Also:

for more explanations

createJButtonPanel

public static javax.swing.JPanel createJButtonPanel(java.lang.Class[] actionClasses)

creates a JPanel with JButtons for the actions specified. The JPanel uses a FlowLayout. If you don't like the JPanel, you can create the JPanel (or other component) yourself and use addJButtons

Returns:

JPanel the panel containing the buttons

createJButtonPanel

public static javax.swing.JPanel createJButtonPanel(TopComponent tc,
                                                    java.lang.Class[] actionClasses)

creates a JPanel with JButtons for action classes that listen to Nodes in the specified TopComponent. This is useful, e.g.when you want to place the Buttons in a separate TopComponent (i.e. not in the Explorer TopComponent itself).

Parameters:

tc - the TopComponent that contains the nodes (typically this is an Explorer)

actionClasses - actions supported by one or more of the nodes in the TopComponent

Returns:

a JButton

Since:

2.0.5

addJButtons

public static javax.swing.JComponent addJButtons(javax.swing.JComponent comp,
                                                 java.lang.Class[] actionClasses)

Deprecated. -- tell us (proj-gp-dev@cern.ch) if you really need it!

Utility method, adds JButtons corresponding to the actionClasses to a JComponent

Returns:

the JComponent passed as first paraameter, with the buttons added

getBlankIcon

public static javax.swing.ImageIcon getBlankIcon()

utility method, returns a blank icon, can be used if an existing icon shall be "hidden"

actionForComp

public static javax.swing.Action actionForComp(TopComponent tc,
                                               java.lang.Class action)

helper method, creates an action that is "connected" to the nodes inside a TopComponent. This makes it possible to create Action Buttons that listen to nodes in an Explorer but are located outside the Explorer's TopComponent

Parameters:

tc - the TopComponent (e.g. Explorer) to connect to

action - the action class

Returns:

the Context aware Action instance

Since:

2.0.5