Skip navigation links
org.openide.awt 7.79

UI Utilities API
Official

See: Description

UI Utilities API 
Package Description
org.netbeans.api.actions
Context Interfaces are a design pattern used to add behaviors to existing objects or to separate implementation from the main object.
org.netbeans.spi.actions
Contains support classes for easier implementation of Context Interfaces.
org.openide.awt
A set of utility classes pertaining to the visual appearance of NetBeans.

API/SPI for UI related aspects of application.

What is New (see all changes)?

Use Cases

Cover of NetBeans Platform for Beginners book For general overview of the concepts of NetBeans action system and related UI elements, together with code samples, see chapter 5, of NetBeans Platform for Beginners by Jason Wexbridge and Walter Nyland.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...
Group of java interfaces
Interface NameIn/OutStabilitySpecified in What Document?
org.openide.awtExportedOfficial .../org/openide/awt/package-summary.html

Group of property interfaces
Interface NameIn/OutStabilitySpecified in What Document?
menuTextExportedStableorg/openide/awt/Actions.html

popupTextExportedStableorg/openide/awt/Actions.html

Group of branding interfaces
Interface NameIn/OutStabilitySpecified in What Document?
org.openide.awt.USE_MNEMONICSExportedStable

There is a way to enable mnemonics in popup menu items created via Actions factory methods in your own application build on top of NetBeans Platform. Just provide branding for org/openide/awt/Bundle.properties file and modify USE_MNEMONICS=always. Other possible values of this key include default, never or always.

Group of logger interfaces
Interface NameIn/OutStabilitySpecified in What Document?
org.netbeans.ui.actions.UI_ACTION_BUTTON_PRESSExportedFriend

There is a special support for notifying when an action wrapped by Actions bridge is invoked and how. The support is using Logger.getLogger("org.netbeans.ui.actions") and sents a LogRecord with message UI_ACTION_BUTTON_PRESS, FINER level and paramerters:
  • {0} instance of the button
  • {1} class of the button
  • {2} instance of the action
  • {3} class of the action
  • {4} display name of the action
whenever such action is invoked. This message can then be consumed by enhanced UI logger that track what the user is going.

Group of systemproperty interfaces
Interface NameIn/OutStabilitySpecified in What Document?
org.openide.awt.StatusDisplayer.DISPLAY_TIMEExportedFriend

Status text set in StatusDisplayer is by default shown in status line of NetBeans and is hidden after specified timeout. If not overriden by this property it is done after 5000ms. O means that the last text will be shown and not removed.

org.openide.awt.ActionReference.completionExportedUnder Development

If System.getProperty("org.openide.awt.ActionReference.completion") is specified, then the dedicated processor for ActionReference tries to load such class, casts it to Processor and asks it for additional completion items for its path attribute. By default, when running inside NetBeans IDE, apisupport.project registers such class and provides items representing valid paths in current project.

Group of lookup interfaces
Interface NameIn/OutStabilitySpecified in What Document?
ButtonActionConnectorSPIExportedFriend

Objects implementing ButtonActionConnector are looked up. Only the first instance found in the loookup is used to provide an alternative implementation of connection between Actions and GUI components. If there isn't one in the lookup the default implementation is used (it means there does not have to be one).

Group of layer interfaces
Interface NameIn/OutStabilitySpecified in What Document?
Actions.factoriesExportedStableorg/openide/awt/Actions.html

Many action factories (alwaysEnabled, context and callback, etc.) are ready to be called directly from layer XML file.

Implementation Details

Where are the sources for the module?

The sources for the module are in the Apache Git repositories or in the GitHub repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

Nothing.

Read more about the implementation in the answers to architecture questions.

Skip navigation links
org.openide.awt 7.79