org.openide.actions
Class InstantiateAction

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

All Implemented Interfaces:

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

public class InstantiateAction

extends NodeAction

Instantiate a template. Enabled only when there is one selected node and it represents a data object satisfying DataObject.isTemplate().

See Also:

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.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

InstantiateAction()

Method Summary

protected boolean	enable(Node[] activatedNodes) Test whether the action should be enabled based on the currently activated nodes.
HelpCtx	getHelpCtx() Get a help context for the action.
String	getName() Get a human presentable name of the action.
static Set	instantiateTemplate(DataObject obj) Instantiate a template object.
protected void	performAction(Node[] activatedNodes) Perform the action based on the currently activated nodes.

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, iconResource, 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

InstantiateAction

public InstantiateAction()

Method Detail

enable

protected boolean enable(Node[] activatedNodes)

Description copied from class: NodeAction

Test whether the action should be enabled based on the currently activated nodes.

Overrides:

enable in class NodeAction

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

Parameters:

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

Returns:

true to be enabled, false to be disabled

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

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

instantiateTemplate

public static Set instantiateTemplate(DataObject obj)
                               throws IOException

Instantiate a template object. Asks user for the target file's folder and creates the file. Then runs the node delegate's customizer (if there is one). Also the node's default action, if any, is run.

Parameters:

obj - the template to use

Returns:

set of created objects or null if user canceled the action

Throws:

IOException - on I/O error

See Also:

DataObject.createFromTemplate(org.openide.loaders.DataFolder)