org.openide.actions
Class SaveAsTemplateAction

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

All Implemented Interfaces:

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

public final class SaveAsTemplateAction

extends NodeAction

Saves a data object to a folder under in the system's templates area.

See Also:

Places.Folders.templates(), 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

SaveAsTemplateAction()

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.
String	iconResource() Specify the proper resource name for the action's icon.
protected void	performAction(Node[] activatedNodes) Perform the action based on the currently activated nodes.
protected boolean	surviveFocusChange() Specify the behavior of the action when a window with no activated nodes is selected.

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

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

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

SaveAsTemplateAction

public SaveAsTemplateAction()

Method Detail

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

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

iconResource

public String iconResource()

Deprecated. Should never be called publically.

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

surviveFocusChange

protected boolean surviveFocusChange()

Description copied from class: NodeAction

Specify the behavior of the action when a window with no activated nodes is selected. If the action should then be disabled, return false here; if the action should stay in the previous state, return true.

Note that NodeAction.getActivatedNodes() and NodeAction.performAction() are still passed the set of selected nodes from the old window, if you keep this feature on. This is useful, e.g., for an action like Compilation which should remain active even if the user switches to a window like the Output Window that has no associated nodes; then running the action will still use the last selection from e.g. an Explorer window or the Editor, if there was one to begin with.

Overrides:

surviveFocusChange in class NodeAction

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

Returns:

true in the default implementation

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