org.openide.actions
Class ExecuteAction

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

All Implemented Interfaces:

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

public class ExecuteAction

extends CookieAction

Execute a class. Is enabled if the only selected node implements ExecCookie.

See Also:

org.openide.execution, 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.CookieAction

MODE_ALL, MODE_ANY, MODE_EXACTLY_ONE, MODE_ONE, MODE_SOME

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

ExecuteAction()

Method Summary

protected Class[]	cookieClasses() Get the cookies that this action requires.
static boolean	execute(DataObject[] dataObjects, boolean compileBefore) Execute some data objects.
static void	execute(Iterator execCookies) Execute a list of items by cookie.
static boolean	execute(Node[] nodes, boolean compileBefore) Execute some nodes.
HelpCtx	getHelpCtx() Get a help context for the action.
String	getName() Get a human presentable name of the action.
static boolean	getRunCompilation() Test whether files will be compiled before execution.
static String	getWorkspace() Get the name of the workspace in which execution is performed.
protected String	iconResource() Specify the proper resource name for the action's icon.
protected int	mode() Get the mode of the action, i.e. how strict it should be about cookie support.
protected void	performAction(Node[] activatedNodes) Perform the action based on the currently activated nodes.
static void	setRunCompilation(boolean run) Set whether files should be compiled before execution.
static void	setWorkspace(String workspace) Set the name of the workspace in which execution is performed.

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

enable

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

actionPerformed, addNotify, getActivatedNodes, initialize, isEnabled, performAction, removeNotify, setEnabled, surviveFocusChange

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

getMenuPresenter, getPopupPresenter, getToolbarPresenter

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

clearSharedData, createPopupMenu, createToolbarPresenter, get, getIcon, getIcon, getValue, linkActions, putValue, setIcon

Methods inherited from class org.openide.util.SharedClassObject

addPropertyChangeListener, equals, finalize, findObject, findObject, firePropertyChange, getLock, getProperty, hashCode, putProperty, putProperty, readExternal, 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

ExecuteAction

public ExecuteAction()

Method Detail

getWorkspace

public static String getWorkspace()

Get the name of the workspace in which execution is performed. By default, execution is performed in the "running" workspace.

Returns:

the workspace name

setWorkspace

public static void setWorkspace(String workspace)

Set the name of the workspace in which execution is performed.

Parameters:

workspace - the workspace name

setRunCompilation

public static void setRunCompilation(boolean run)

Set whether files should be compiled before execution.

Parameters:

run - true if they should

getRunCompilation

public static boolean getRunCompilation()

Test whether files will be compiled before execution. By default they will.

Returns:

true if they will be

cookieClasses

protected Class[] cookieClasses()

Description copied from class: CookieAction

Get the cookies that this action requires. The cookies are disjunctive, i.e. a node must support AT LEAST ONE of the cookies specified by this method.

Overrides:

cookieClasses in class CookieAction

Following copied from class: org.openide.util.actions.CookieAction

Returns:

a list of cookies

performAction

protected void performAction(Node[] activatedNodes)

Description copied from class: NodeAction

Perform the action based on the currently activated nodes. Note that if the source of the event triggering this action was itself a node, that node will be the sole argument to this method, rather than the activated nodes.

Overrides:

performAction in class NodeAction

Following copied from class: org.openide.util.actions.NodeAction

Parameters:

activatedNodes - current activated nodes, may be empty but not null

mode

protected int mode()

Description copied from class: CookieAction

Get the mode of the action, i.e. how strict it should be about cookie support.

Overrides:

mode in class CookieAction

Following copied from class: org.openide.util.actions.CookieAction

Returns:

the mode of the action. Possible values are disjunctions of the MODE_XXX constants.

getName

public String getName()

Description copied from class: SystemAction

Get a human presentable name of the action. This may be presented as an item in a menu.

Using the normal menu presenters, an included ampersand before a letter will be treated as the name of a mnemonic.

Overrides:

getName in class SystemAction

Following copied from class: org.openide.util.actions.SystemAction

Returns:

the name of the action

getHelpCtx

public HelpCtx getHelpCtx()

Description copied from class: SystemAction

Get a help context for the action.

Overrides:

getHelpCtx in class SystemAction

Following copied from class: org.openide.util.actions.SystemAction

Returns:

the help context for this action

iconResource

protected String iconResource()

Description copied from class: SystemAction

Specify the proper resource name for the action's icon. May be overridden by subclasses. Typically this should be a 16x16 color GIF.

Overrides:

iconResource in class SystemAction

Following copied from class: org.openide.util.actions.SystemAction

Returns:

the resource name for the icon, e.g. /com/mycom/mymodule/myIcon.gif; or null to make a text label

execute

public static void execute(Iterator execCookies)

Execute a list of items by cookie.

Parameters:

execCookies - list of ExecCookies (any may be null)

execute

public static boolean execute(DataObject[] dataObjects,
                              boolean compileBefore)

Execute some data objects.

Parameters:

dataObjects - the data objects (should have ExecCookie on them if they are to be used)

compileBefore - true to compile before executing

Returns:

true if compilation succeeded or was not performed, false if compilation failed

execute

public static boolean execute(Node[] nodes,
                              boolean compileBefore)

Execute some nodes.

Parameters:

nodes - the nodes (should have ExecCookie on them if they are to be used)

compileBefore - true to compile before executing

Returns:

true if compilation succeeded or was not performed, false if compilation failed