NetBeans Architecture Answers for Actions APIs module

WARNING: answering questions version 1.12 rather than the current 1.29.

Interfaces table

Group of java interfaces
Interface Name In/Out Stability Specified in What Document?
NodesAPI Imported Official .../overview-summary.html

WindowSystemAPI Imported Official .../overview-summary.html

ExplorerAPI Imported Official .../overview-summary.html

FilesystemsAPI Imported Official .../overview-summary.html

LoadersAPI Imported Official .../overview-summary.html

UtilitiesAPI Imported Official ../org-openide-util/overview-summary.html

ActionsAPI Exported Official overview-summary.html

Group of property interfaces
Interface Name In/Out Stability Specified in What Document?
OpenIDE-Transmodal-Action Exported Under Development

Inidicates action can be performed (typicaly via shortcut) even when dialog is popped out (modal or modeless).

delegates Exported Under Development

Used internaly in PasteAction delegate action which serves to pass an array of PasteType or Action to global instance (it is the only one which actually performs paste operation).

iconBase Exported Under Development

Used in companion to Actions.SMALL_ICON. Because there is no way to specify values for other types of icons the value of "iconBase" is used to construct the resource names of disabled, pressed and rollover icons. The value is expected to contain a resource path of the normal icon. Strings "_pressed", "_disabled" and "_rollover" are inserted before the suffix when searching for the other types of icons.

noIconInMenu Exported Under Development

Allowed value Boolean.TRUE. Influences the display of the action in the main menu, the item will have no icon there. Works for Actions that don't define custom MenuPresenter.

PreferredIconSize Exported Under Development

Used to support 24x24 icons in toolbars. If toolbar button has client property "PreferredIconSize" set to Integer(24) button tries to load icon with name "iconBase" + "24" eg. "cut24.gif". Strings "_pressed","_disabled" and "_rollover" are inserted before the suffix when searching for the other types of icons eg.:"cut24_pressed.gif".

waitFinished Exported Friend

There is a new contract established between the caller of an action that allows mutual communication and possible synchronous execution even for actions that by default perform their operations asynchronously. If the action's actionPeformed method is passed ActionEvent with command waitFinished the action shall be executed synchronously. The code:
             action.actionPerformed (new ActionEvent (this, 0, "waitFinished"))
             
shall be executed synchronously, even if the action by default runs asynchronously. All asynchronous actions are asked to obey this contract, CallableSystemAction does it by default. However this contract is defined as friend one and may be abandoned in future.

ActionMapKeys Exported Stable

CallableSystemAction uses its getActionMapKey() method (usually overriden by subclasses) to get a key which is then searched in the ActionMap obtained from the action's context. Other modules can register their own action then:
topComponent.getActionMap ().put (theKey, new YourOwnSwingAction ());
Here is the list of special keys:
  • "cloneWindow" - an action to be executed when a top component is to be cloned
  • "closeWindow" - an action when a view is about to be closed
  • DefaultEditorKit.copyAction - copy action handler
  • DefaultEditorKit.cutAction - cut action handler
  • "delete" - delete action handler
  • DefaultEditorKit.pasteAction - paste action handler
  • "jumpNext" - when a next element shall be selected
  • "jumpPrev" - when a previous element shall be selected

org.openide.util.actions.CallableSystemAction.synchronousByDefault Exported Friend

If set to true, changes default value of the asynchronous() method. Useful for unit tests which would prefer to run all tested actions synchronously.

Group of preferences interfaces
Interface Name In/Out Stability Specified in What Document?
org.openide.actions.HeapView Exported Private

key description read write
showDropShadow Preserves "Drop Shadow" setting of the view x x
showText Preserves "Show Text" setting of the view x x
tickStyle Preserves "Overlay Grid" setting of the view x x


General Information


Project and platform dependencies


Deployment


Compatibility with environment


Access to resources


Lookup of components


Execution Environment


Format of files and protocols


Performance and Scalability


Built on February 22 2011.  |  Portions Copyright 1997-2011 Sun Microsystems, Inc. All rights reserved.