ViewAction (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 ViewAction

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

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

public class ViewAction
extends CookieAction

View an object (but do not edit it).

See Also:: ViewCookie, 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.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

ViewAction()


Method Summary

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

protected Class[] cookieClasses()
          Get the cookies that this action requires.

HelpCtx getHelpCtx()
          Get a help context for the action.

String getName()
          Get a human presentable name of the action.

protected String iconResource()
          Specify the proper resource name for the action's icon.

protected int mode()
          Get the mode of the action: how strict it should be about cookie support.

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

createContextAwareInstance, enable

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

ViewAction

public ViewAction()

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

iconResource

protected String iconResource()

Description copied from class: SystemAction

Specify the proper resource name for the action's icon. May be overridden by subclasses; the default is to have no icon. Typically this should be a 16x16 color GIF. Do not use relative paths nor an initial slash. If e.g. myIcon.gif is accompanied with myIcon_pressed.gif, myIcon_disabled.gif and/or myIcon_rollover.gif these images are used to call methods on JButton.setPressedIcon(), JButton.setDisabledIcon() and/or JButton.setRolloverIcon() with appropriate images. Please check Actions.connect(AbstractButton, Action) for additional info how this is achieved (using special "iconBase" key for getValue). As of APIs version 3.24, this path will be used for a localized search automatically.

Overrides:: iconResource in class SystemAction

Returns:: the resource name for the icon, e.g. com/mycom/mymodule/myIcon.gif; or null to have no icon (make a text label)

mode

protected int mode()

Description copied from class: CookieAction

Get the mode of the action: how strict it should be about cookie support.

Specified by:: mode in class CookieAction

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

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.

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

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 Class[]`	`cookieClasses()` Get the cookies that this action requires.
`HelpCtx`	`getHelpCtx()` Get a help context for the action.
`String`	`getName()` Get a human presentable name of the action.
`protected String`	`iconResource()` Specify the proper resource name for the action's icon.
`protected int`	`mode()` Get the mode of the action: how strict it should be about cookie support.
`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.

ViewAction (NetBeans APIs) - NetBeans API Javadoc 4.1.0

org.openide.actions Class ViewAction

ViewAction

surviveFocusChange

getName

getHelpCtx

iconResource

mode

cookieClasses

performAction

asynchronous

org.openide.actions
Class ViewAction