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

java.lang.Object
  org.openide.util.SharedClassObject
      org.openide.util.actions.SystemAction
          org.openide.util.actions.CallableSystemAction
              org.openide.util.actions.CallbackSystemAction
                  org.openide.actions.CloseViewAction

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

public class CloseViewAction
extends CallbackSystemAction

Close the current top component.

See Also:: TopComponent.close(), 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

CloseViewAction()


Method Summary

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

Object getActionMapKey()
          Getter for action map key, which is used to find action from provided context (i.e.

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

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

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

actionPerformed, createContextAwareInstance, getActionPerformer, getSurviveFocusChange, initialize, performAction, setActionPerformer, setSurviveFocusChange

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, isEnabled, linkActions, putValue, setEnabled, setIcon

Methods inherited from class org.openide.util.SharedClassObject

addNotify, addPropertyChangeListener, equals, finalize, findObject, findObject, firePropertyChange, getLock, getProperty, hashCode, putProperty, putProperty, readExternal, removeNotify, 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, isEnabled, putValue, removePropertyChangeListener, setEnabled

Constructor Detail

CloseViewAction

public CloseViewAction()

Method Detail

getActionMapKey

public Object getActionMapKey()

Description copied from class: CallbackSystemAction

Getter for action map key, which is used to find action from provided context (i.e. ActionMap provided by the context), which acts as a callback. Override this method in subclasses to provide 'nice' key.

Overrides:: getActionMapKey in class CallbackSystemAction

Returns:: key which is used to find the action which performs callback, default returned key is a class name.

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

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

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