RenameAction (NetBeans APIs) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.openide.actions
Class RenameAction

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

All Implemented Interfaces:: Action, ActionListener, ContextAwareAction, EventListener, Externalizable, HelpCtx.Provider, Presenter, Presenter.Menu, Presenter.Popup, Presenter.Toolbar, Serializable

public class RenameAction
extends NodeAction

Rename a node.

See Also:: Node.setName(java.lang.String), Serialized Form

Nested Class Summary

Nested classes inherited from class org.openide.util.actions.Presenter

Presenter.Menu, Presenter.Popup, Presenter.Toolbar

Field Summary

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

RenameAction()


Method Summary

protected boolean asynchronous()
          If true, this action should be performed asynchronously in a private thread.

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.

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, createContextAwareInstance, 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, 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, reset, 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, getValue, putValue, removePropertyChangeListener

Constructor Detail

RenameAction

public RenameAction()

Method Detail

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

Returns:: true in the default implementation

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.

Specified by:: getName in class SystemAction

Returns:: the name of the action

getHelpCtx

public HelpCtx getHelpCtx()

Description copied from class: SystemAction

Get a help context for the action.

Specified by:: getHelpCtx in interface HelpCtx.Provider
Specified by:: getHelpCtx in class SystemAction

Returns:: the help context for this action

enable

protected boolean enable(Node[] activatedNodes)

Description copied from class: NodeAction

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

Specified by:: enable in class 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.

Specified by:: performAction in class NodeAction

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

asynchronous

protected boolean asynchronous()

Description copied from class: CallableSystemAction

If true, this action should be performed asynchronously in a private thread. If false, it will be performed synchronously as called in the event thread.

The default value is true for compatibility reasons; subclasses are strongly encouraged to override it to be false, and to either do their work promptly in the event thread and return, or to somehow do work asynchronously (for example using RequestProcessor.getDefault()).

You may currently set the global default to false by setting the system property org.openide.util.actions.CallableSystemAction.synchronousByDefault to true.

When true, the current implementation also provides for a wait cursor during the execution of the action. Subclasses which override to return false should consider directly providing a wait or busy cursor if the nature of the action merits it.

Overrides:: asynchronous in class CallableSystemAction

Returns:: true if this action should automatically be performed asynchronously

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Method Summary
`protected boolean`	`asynchronous()` If true, this action should be performed asynchronously in a private thread.
`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.
`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.

RenameAction (NetBeans APIs) - NetBeans API Javadoc 4.1.0

org.openide.actions Class RenameAction

RenameAction

surviveFocusChange

getName

getHelpCtx

enable

performAction

asynchronous

org.openide.actions
Class RenameAction