NetBeans API List

Version 6.9

10 Jun 2010

This document provides a list of NetBeans APIs with a short description of what they are used for, and a table describing different types of interfaces (see What is an API? to understand why we list DTDs, file formats, etc.) and with a stability category (stable and official, under development, deprecated, friend or private; see API life-cycle for more info). The aim is to provide as detailed a definition of NetBeans module external interfaces as possible and give other developers a chance to decide whether they want to depend on a particular API or not.

Some of these APIs are part of the NetBeans Platform (for example lookup, loaders, utilities, nodes, explorer, window systems, multiview, etc.), some of them are specific to NetBeans IDE (projects, javacore, diff, etc.) and some are not included in the release at all and are just provided for download (usually via autoupdate). Basically when building an application based on NetBeans one is free to choose the set of modules and their APIs to satisfy one's needs.

This is a list of APIs for NetBeans 6.9 version, if you want to see a list of APIs for a particular version, you may want to go to:

To get the API of your module listed here, see the documentation for the Javadoc building infrastructure.

Additional Sources of Information

FAQ and Mailing List

Can't find what you're looking for? Try the FAQ and then dev@openide.netbeans.org.


Content


Ant

javadoc | download | architecture | usecases

The Ant integration module recognizes Ant build scripts, facilitates editing them as text or structurally, lets the user run targets or create shortcuts to them, etc.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
AntLoggerStableorg-apache-tools-ant-module/org/apache/tools/ant/module/spi/AntLogger.html

Permits customization of the way Ant output is displayed.

AutomaticExtraClasspathProviderStableorg-apache-tools-ant-module/org/apache/tools/ant/module/spi/AutomaticExtraClasspathProvider.html

Permits additions to the default Ant classpath.

IntrospectedInfoStableorg-apache-tools-ant-module/org/apache/tools/ant/module/api/IntrospectedInfo.html

Examining cached and introspected data about which tasks and types are known to be defined in the user's Ant scripts, and what their design-time structure is. Used by XML code completion, for example.

AntTargetExecutorStableorg-apache-tools-ant-module/org/apache/tools/ant/module/api/AntTargetExecutor.html

Running named targets in specified Ant scripts. Can be used by modules which provide a different UI for initiating Ant execution. ActionUtils provides a more convenient wrapper around this functionality.

Set of java.io.File APIsIndividualtable with definitions
Set of layer APIsIndividualtable with definitions

Common Annotations

javadoc | download | architecture | usecases

Provides common annotations serving as a documentation element and for static code analysis.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
CommonAnnotationsAPIStableorg-netbeans-api-annotations-common/org/netbeans/api/annotations/common/package-summary.html

Debugger Core API

javadoc | download | architecture | usecases

The debuggercore/api module (Debugger Core API) allows to install different debugger implementation to one IDE. It allows to share some common UI components.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
DebuggerCoreAPIOfficial./org-netbeans-api-debugger

JPDA Debugger API

javadoc | download | architecture | usecases

The debuggerjpda/api (Debugger JPDA API) defines API for NetBeans Java Debugger.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
JPDADebuggerAPIOfficial./org-netbeans-api-debugger-jpda
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions

Java Support APIs

javadoc | download | architecture | usecases

Provides java specific queries (javadc, source level) used by other modules like java language infrastructure. More information in the Javadoc.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
JavaSupportAPIsOfficial

The Java Support APIs provides basic facilities for getting or supplying information about Java-language source files. It is based on the query pattern so implementations can be supplied from other modules or projects.

Classpath APIs

javadoc | download | architecture | usecases

Models basic aspects of the metadata surrounding list of source roots, such as the classpath. More information in the Javadoc.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
ClassPathAPIsOfficial

The ClassPath APIs provides java classpath like ordered collection of (source) roots with ability to listen on changes and helper methods like finding the file under the roots, returning a path from root to given file. It also provides a registry where projects register their classpaths to make them visible to languages infrastructure.

Progress API

javadoc | download | architecture | usecases

The progress API is good for tracking progress of long lasting tasks in the IDE.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
ProgressOfficial./org-netbeans-api-progress/index.html

Visual Library API

javadoc | download | architecture | usecases

The Visual Library 2.0 is the next generation of the original Graph Library 1.0. It is designed for a general visualization with a support for graph-oriented modeling. Its focus is to become a part of the NetBeans platform and unify the visualization (UI and API) used in NetBeans-Platform-based applications. See http://graph.netbeans.org/ web-site for details. See documentation for complete set of use-cases and code-snippets.

Usage:

No. Just set a normal project dependency on org.netbeans.api.visual (spec no.: 2.0) module.

Interface NameStability ClassificationSpecified in What Document?
VisualLibraryAPIOfficial

The API provides a set of reusable pieces - widgets. By composing them you are creating a visualization. Each widget has various properties including layout, border, assigned actions, ... The library contains a set of pre-defined widgets that can be extended. All pluggable pieces are declared as interfaces or abstract classes - WidgetAction, Anchor, AnchorShape, PointShape, Animator, Border, GraphLayout, LookFeel, Layout, SceneLayout, Router, CollisionsCollector. Also they all have their built-in implementation.

XML Tools API

javadoc | download | architecture

It helps with editing XML files and supports leveraging XML in developed application.

Interface NameStability ClassificationSpecified in What Document?
XMLAPIsOfficialindex.html

Core - IDE

javadoc | download | architecture | usecases

core.ide

Usage:

XXX no answer for deploy-dependencies

Interface NameStability ClassificationSpecified in What Document?
core.ideStable

Right now this module provides handy ServicesTabNodeRegistration accompanied with few UI elements.

Auto Update Services

javadoc | download | architecture | usecases

org.netbeans.api.autoupdate org.netbeans.spi.autoupdate

Usage:

Interface NameStability ClassificationSpecified in What Document?
org.netbeans.api.autoupdateOfficialorg-netbeans-modules-autoupdate-services/overview-summary.html
org.netbeans.spi.autoupdateOfficialorg-netbeans-modules-autoupdate-services/overview-summary.html
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of dtd APIsIndividualtable with definitions
Set of preferences APIsIndividualtable with definitions

Database Explorer

javadoc | download | architecture | usecases

This project provides access to objects defined in the Database Explorer. Documentation is available in the Javadoc.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
DatabaseExplorerAPIOfficialorg-netbeans-modules-db/index.html
SQLSupportAPIOfficialorg-netbeans-modules-db/org/netbeans/api/db/sql/support/package-summary.html
Set of layer APIsIndividualtable with definitions

Diff

javadoc | download | architecture | usecases

The diff module provides the ability to visualize differencies between source files. It also has a graphical conflicts resolver tool and built-in patch algorithm. List of the main features: Simple APIs, that provide access to registered diff and merge engines and visualizers. Built in and external diff engines defined. Graphical diff vizualizer and conflicts resolver. Extensible with additional diff and merge engines and vizualizers. Patch algorithm implemented for UNIX-style, unidiff and contextual diff formats.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
DiffAPIOfficial
DiffImplementationAPIFriend

Editor Code Templates

javadoc | download | architecture | usecases

Code Templates allow to paste various code snippets by using parametrized text. The parameters of the same name will share the same default value and if that value gets changed by user's typing the new value gets replicated into all the parameter's occurrences. Code Templates replace the original abbreviations functionality. Code template's example for (Iterator ${iterator} = ${collection instanceof="java.util.Collection"}.iterator(); ${iterator}.hasNext();) { ${cursor}${iterator}.next();" } Each parameter can have additional hints of what values can be assigned to it. The hint has a form ${param hint=value} or just ${param hint} which translates to ${param hint="true"} If necessary the value of the hint can be enclosed in quotes to allow to write whitespace or { or } into the value. The quote can be written by using \". Reserved parameter names ${cursor} defines position where the caret will be located after the editing of the code template default values will finish. Reserved hint names ${param editable=false} can be used to make the parameter to be skipped from user's editing. This may be useful e.g. with using java-specific type hint (described below). Java: ${ind index} defines that the default value of the parameter should be an unused variable in the given context named i. If i is already used then j is attempted or then k etc. until z. Then i0, i1 etc. are attempted. ${param type="java.util.Collection"} defines java type that the parameter must be instance of. Besides class names there can be array e.g. String[] or generics java.util.List<String> ${param array} defines parameter of array type (including arrays of primitive data types). ${param type="java.util.Iterator"} defines that the parameter has the given java type. The template processing infrastructure will use short name Iterator and import java.util.Iterator.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
CodeTemplatesAPIStable

Editor Code Completion

javadoc | download | architecture | usecases

Code Completion provides users with a list of suggested completions for partially typed texts in the editor and various dialog input fields. The Code Completion module was created to replace the original legacy editor code completion which lacked several key requirements: Support for multiple independent code completion content providers. Implied requirement for ordering and prioritization of the completion items. Direct support for asynchronous completion result computation. Missing separation to the API and SPI and implementation parts.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
CodeCompletionAPIOfficialorg-netbeans-modules-editor-completion/index.html
Set of logger APIsIndividualtable with definitions

Editor Error Stripe

javadoc | download | architecture | usecases

The Error Stripe shows an overview of important information of an edited source code. It shows this information for the whole source code (regardless of its size).

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
TextAPIStable./org-openide-text/overview-summary.html

OpenIDE Text API

ErrorStripeSPIStableorg-netbeans-modules-editor-errorstripe-api/index.html

public SPI provided by the Error Stripe.

ErrorStripePrivateSPIPrivate

Private mark provider SPI.

Set of systemproperty APIsIndividualtable with definitions

Editor Code Folding

javadoc | download | architecture | usecases

The Code Folding is part of the editor module functionality and it's responsible for hiding of the portions of the code that are less important for the user at the given time.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
CodeFoldingAPIOfficial

MIME Lookup API

javadoc | download | architecture | usecases

Each editor provides an EditorKit which controls the policy of specific MIME content type. The policy of content type should be easily registered and found via some lookup mechanism, that will provide convenient way of using it either for kit provider or base editor infrastructure. In addition to this, the policy can be inherited, (e.g. in case of embeded kits like JSP) and the content types need to be merged in this case. MIME Lookup API should provide all mentioned requierements via easy lookup query, so content type policy user need not to solve this searching and merging on its own side.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
MimeLookupAPIOfficial
MimeLookupSPIOfficial

Editor Settings

javadoc | download | architecture | usecases

The legacy settings system in the editor module is complicated, error prone and hard to use. It'd been created spontaneously over the years to support immediate needs at that time without paying enough attention to extensibility and interoperability. Historically any module providing editor settings needed to depend on the whole editor module. The main purpose of this project is to define API for editor settings, that is lightweight and easily extensible. The API relies on MimeLookup to provide a way of registering and looking up settings. The aim is NOT to provide an implementation of a storage for editor settings, but to define an interface between this storage and clients like <mime-type> editors, externaleditor, etc.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
EditorSettingsAPIOfficial

API

External Execution Support

javadoc | download | architecture | usecases

Provides common APIs to execute external process in the IDE to handle its streams and present the output to the user. Input/line processing can be used as separate part.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
ExternalExecutionAPIStableorg-netbeans-modules-extexecution/org/netbeans/api/extexecution/package-summary.html
ExternalExecutionInputAPIStableorg-netbeans-modules-extexecution/org/netbeans/api/extexecution/input/package-summary.html
ExternalExecutionInputPrintingAPIStableorg-netbeans-modules-extexecution/org/netbeans/api/extexecution/print/package-summary.html
ExternalExecutionDestroySPIStableorg-netbeans-modules-extexecution/org/netbeans/spi/extexecution/destroy/package-summary.html

Java Platform

javadoc | download | architecture | usecases

Many Java-based project types need to be able to configure the version and location of Java to be used when building and running the project. This API/SPI permits these platforms to be registered and queried, and any customizations made in an appropriate GUI and persisted to disk.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
JavaPlatformAPIOfficial

The Java Platform API permits access to installed Java platforms (for example, the J2SE JDK, or various mobile-device emulators for J2ME). Particular platform types are registered by modules and can store customized information about the platform to disk.

Java Project Support

javadoc | download | architecture | usecases

Provides support infrastructure for projects working with the Java language.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
JavaProjectAPIOfficial

The Java Project API is actually entirely SPI and supplies useful implementations of Java-related functionality specific to the project system.

ProjectClassPathExtenderUnder Development

Implemented by java/j2seproject and asked for by form. Permits the Form Editor to add JavaBeans archives to the classpath of a J2SE project automatically.

ProjectClassPathSupportUnder Development

Support class containg helper method for creating ClassPathImplementation based on Ant properties.

Set of systemproperty APIsIndividualtable with definitions

Java Source

javadoc | download | architecture | usecases

XXX no answer for arch-what

Usage:

XXX no answer for deploy-dependencies

Interface NameStability ClassificationSpecified in What Document?
JavaSourceAPIOfficialorg-netbeans-modules-java-source/index.html
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of lookup APIsIndividualtable with definitions

Java Source UI

javadoc | download | architecture | usecases

java.sourceui

Usage:

XXX no answer for deploy-dependencies

Interface NameStability ClassificationSpecified in What Document?
java.sourceuiOfficial

APIs for controling visual aspects of processing of Java files.

JavaHelp Integration

javadoc | download | architecture

The JavaHelp integration API wraps the standard JavaHelp extension library. It also provides a small additional API for NetBeans modules to supply help sets to the system, add GUI menu items, and request that particular help topics be displayed. JavaHelpIntegrationAPI

Interface NameStability ClassificationSpecified in What Document?
JavaHelpIntegrationAPIOfficialorg-netbeans-modules-javahelp/index.html
Set of property APIsIndividualtable with definitions
Set of dtd APIsIndividualtable with definitions

Lexer

javadoc | download | architecture | usecases

Lexer module provides token lists for various text inputs. Token lists can either be flat or they can form tree token hierarchies if any language embedding is present. Tokens

Usage:

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.lexer/2 > @SPECIFICATION-VERSION@

Interface NameStability ClassificationSpecified in What Document?
LexerAPIOfficial
Set of logger APIsIndividualtable with definitions

Options Dialog and SPI

javadoc | download | architecture | usecases

This module contains implementation of Options Panel and simple SPI.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
OptionsDialogSPIOfficial./org-netbeans-modules-options-api/org/netbeans/spi/options/OptionsCategory.html
Set of layer APIsIndividualtable with definitions

Print

javadoc | download | architecture | usecases

Provides print functionality in NetBeans.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
PrintAPIStable

Ant-Based Project Support

javadoc | download | architecture | usecases

Provides the basic infrastructure by which Ant-based projects can be created, read and write configuration parameters and properties from/to disk, satisfy common queries and interfaces, etc. See Javadoc and build system design document.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
AntProjectAPIOfficial

Mostly an SPI for creating project types centered around the Ant build tool. Permits Ant-based project types to be registered and supplies various support implementations to help satisfy the contract of Project and various optional interfaces.

Set of systemproperty APIsIndividualtable with definitions
Set of preferences APIsIndividualtable with definitions

External Libraries

javadoc | download | architecture | usecases

Permits libraries to be defined, customized, and stored by the user for reuse in multiple projects. For example, a Java JAR library has a classpath (usually one JAR), and an optional source path and Javadoc path that may be used for development-time features.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
ProjectLibrariesAPIOfficial

The Project Libraries API permits definitions of libraries to be registered and persisted. Library type providers may be registered and can construct memory objects corresponding to persistent library definitions.

Set of dtd APIsIndividualtable with definitions

Project API

javadoc | download | architecture | usecases

Provides a generic infrastructure for modelling projects. Documentation available in the Javadoc. The build system design overview describes the basic purpose of modelling projects.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
ProjectAPIOfficial

The Project API defines abstract projects, i.e. groupings of files built and manipulated as units. It is used for Ant-based projects but could support other scenarios such as makefiles. Modules can plug in project types which can recognize certain folders as being projects, and define their behaviors. Besides the visible Javadoc, this module permits a project to add implementations of org.netbeans.spi.queries.FileBuiltQueryImplementation, org.netbeans.spi.queries.SharabilityQueryImplementation and org.netbeans.spi.queries.FileEncodingQueryImplementation into the project lookup (rather than global lookup). The implementations will be consulted only in the case the relevant file belongs to that project (according to org.netbeans.api.project.FileOwnerQuery). This helps avoid the need to consult irrelevant query implementations.

Project UI API

javadoc | download | architecture | usecases

The module supplies the APIs for the basic, generic UI infrastructure for projects: list of opened projects, main project, basic project-sensitive actions, template wizards, etc.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
ProjectUIAPIOfficial

The Project UI API provides some miscellaneous APIs and SPIs relating to the appearance and UI behavior of generic projects. Most importantly, it permits the customizer and logical view of a project to be defined.

ProjectUIAPI-providerFriend

Callbacks intended to let the Project UI module plug in implementations of APIs defined here. Uses implementation dependencies.

Set of layer APIsIndividualtable with definitions
Set of property APIsIndividualtable with definitions
Set of lookup APIsIndividualtable with definitions

General Queries API

javadoc | download | architecture | usecases

General kinds of queries between modules. Queries are one way of solving the intermodule communication problem when it is necessary for some modules to obtain basic information about the system (e.g. whether a particular file is intended for version control) without needing direct dependencies on the module providing the answer (e.g. the project type which controls the file). Details are covered in the Javadoc.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
GeneralQueriesAPIOfficial

The General Queries API provides generic queries, or sources of concrete information, useful throughout the build system and perhaps elsewhere. Each query is split into an API component intended for clients to find the answer to a particular question without knowledge of the underlying structure or origin of the answer; and an SPI interface (using lookup) permitting answers to be provided from any source. These queries currently pertain to VCS and compilation status and user visibility of files.

Set of preferences APIsIndividualtable with definitions

Command Line Parsing API

javadoc | download | architecture | usecases

GetOpts like infrastructure to parse command line arguments with the cooperative participation of various modules.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
SendOptsAPIOfficialorg-netbeans-modules-sendopts/org/netbeans/api/sendopts/package-summary.html
SendOptsSPIOfficialorg-netbeans-modules-sendopts/org/netbeans/spi/sendopts/package-summary.html
Set of lookup APIsIndividualtable with definitions

Settings API

javadoc | download | architecture

Settings are persistent objects with a set of properties, that should be available via lookup. Properties are expected to be changed. Implementation of setting doesn't care about persistence issues, which is responsibility of settings infrastructure. XML persistence support is provided in a standalone autoload module core-settings.jar. Also service types must be mentioned here. Service type can be desribed as typed a named settings. SettingsAPI ServicesAPI XmlSettingsPersistence

Interface NameStability ClassificationSpecified in What Document?
SettingsAPIOfficial./org-openide-util/org/openide/util/doc-files/api.html#settings
ServicesAPIOfficial./org-openide-util/org/openide/util/doc-files/api.html#service-lookup
XmlSettingsPersistenceOfficial./org-netbeans-modules-settings/org/netbeans/spi/settings/package-summary.html
Set of layer APIsIndividualtable with definitions
Set of dtd APIsIndividualtable with definitions

Debugger Core - UI

javadoc | download | architecture | usecases

The debuggercore module (Debugger Core UI) contains shared UI components for all debugger implementations, and defines some SPI for sharing of them.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
DebuggerCoreUI-SPIOfficial./org-netbeans-spi-debugger-ui

Navigator API

javadoc | download | architecture | usecases

Navigator module is a base API module which provides: A place for modules to show structure/outline of their documents Ability for modules to show their view only when special document(node) is active in the system UI for switching between multiple views available for currently active document(node) Coalescing of fast coming selected node changes to show content for

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
org.netbeans.spi.navigator.NavigatorPanelStable
org.netbeans.spi.navigator.NavigatorHandlerUnder Development
Set of lookup APIsIndividualtable with definitions

Common Palette

javadoc | download | architecture | usecases

The project implements a new component palette that will be reused by other projects. The new palette should provide a common look and feel for Form editor, Mobility, J2EE and possible other modules as well. UI draft specification is available at http://ui.netbeans.org/docs/ui/palette/index.html

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
PaletteStableorg-netbeans-spi-palette/overview-summary.html
Set of java.io.File APIsIndividualtable with definitions
Set of layer APIsIndividualtable with definitions
Set of dtd APIsIndividualtable with definitions
Set of lookup APIsIndividualtable with definitions

Quick Search API

javadoc | download | architecture | usecases

QuickSearch API and its implementations provides way for end user to learn system earlier and easier and also to find various things in the system more quickly, conveniently and in standard way. Main project page is on nb wiki, http://wiki.netbeans.org/QuickSearch

Usage:

Nothing, regular depencency is enough.

Interface NameStability ClassificationSpecified in What Document?
SearchProviderOfficialorg-netbeans-spi-quicksearch/org/netbeans/spi/quicksearch/SearchProvider.html
SearchRequestOfficialorg-netbeans-spi-quicksearch/org/netbeans/spi/quicksearch/SearchRequest.html
SearchResponseOfficialorg-netbeans-spi-quicksearch/org/netbeans/spi/quicksearch/SearchResponse.html
Set of property APIsIndividualtable with definitions

Task List API

javadoc | download | architecture | usecases

This module provides SPI for third parties that want to display some sort information for the user in the Task List / Problems window. A typical example are Java errors, warnings, TODOs etc. Part of the integration are several implementation modules that provider task list user interface, TODO task scanning, Java integration.

Usage:

no special dependency declarations

Interface NameStability ClassificationSpecified in What Document?
TaskListSPIOfficialorg-netbeans-spi-tasklist/org/netbeans/spi/tasklist/package-summary.html

Set of layer APIsIndividualtable with definitions

TreeTableView Model

javadoc | download | architecture | usecases

The debuggercore/ViewModel module (View Model) allows to share one TreeTableView among different modules.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
ViewModelOfficial./org-netbeans-spi-viewmodel/overview-summary.html

Actions APIs

javadoc | download | architecture | usecases

Actions provides system of support and utility classes for 'actions' usage in NetBeans.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
ActionsAPIOfficialorg-openide-actions/overview-summary.html
Set of layer APIsIndividualtable with definitions
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of preferences APIsIndividualtable with definitions

UI Utilities API

javadoc | download | architecture | usecases

The org.openide.awt provides API/SPI for UI related aspects of application.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
org.openide.awtOfficial./org-openide-awt/org/openide/awt/package-summary.html
Set of layer APIsIndividualtable with definitions
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of logger APIsIndividualtable with definitions
Set of lookup APIsIndividualtable with definitions

Dialogs API

javadoc | download | architecture | usecases

The DialogsAPI allows creating a user notification, a dialog's description and also permits it to be displayed. The wizard framework allows create a sequence of panels which leads a user through the steps to complete any task. This API is part of package org.openide.

Interface NameStability ClassificationSpecified in What Document?
DialogsAPIOfficial./org-openide-dialogs/org/openide/package-summary.html#package_description

Execution API

javadoc | download | architecture

The IDE uses a small interface to describe the execution of Java-based classes together with arguments. The ExecutionAPI controls the execution of user-level classes. The system may have several different types of executors simultaneously installed. By default we provide so called External Execution for running a user code by an external process and Internal Execution for running the user code in the same virtual machine as the IDE.

Interface NameStability ClassificationSpecified in What Document?
ExecutionAPIOfficial./org-openide-execution/org/openide/execution/doc-files/api.html
Set of property APIsIndividualtable with definitions

Explorer & Property Sheet API

javadoc | download | architecture | usecases

The ExplorerAPI is build around Explorer - solely a user-interface device: it has no particular knowledge of the structure of the IDE. Rather, it provides the physical user interface for the Node hierarchy, as described in the NodesAPI. A given Explorer instance will be some visual component (such as a Swing panel) displaying some representation of a subtree of the complete Node hierarchy; the topmost node being displayed is said to be the root of the Explorer. Be careful not to confuse the root of a particular Explorer instance, which is selected according to what the user wishes to see, with the root(s) of the entire Node hierarchy, which generally are fixed.

Usage:

XXX no answer for deploy-dependencies

Interface NameStability ClassificationSpecified in What Document?
ExplorerAPIOfficial./org-openide-explorer/org/openide/explorer/doc-files/api.html
TreeTableViewSortingAPIFriend
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions

File System API

javadoc | download | architecture | usecases

The Filesystems API provides a common API to access files in a uniform manner. It is available as standalone library and also is bundled together with other parts of the openide. Specification

Usage:

XXX no answer for deploy-dependencies

Interface NameStability ClassificationSpecified in What Document?
FilesystemsAPIOfficialorg-openide-filesystems/org/openide/filesystems/doc-files/api.html
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of dtd APIsIndividualtable with definitions

I/O APIs

javadoc | download | architecture | usecases

The Input/Output API is a small API module which contains InputOutput and related interfaces used in driving the Output Window. The normal implementation is org.netbeans.core.output2.

Usage:

You will very likely also want to declare

OpenIDE-Module-Requires: org.openide.windows.IOProvider

to ensure that an Output Window implementation is in fact enabled.

Interface NameStability ClassificationSpecified in What Document?
InputOutputAPIOfficial./org-openide-io/org/openide/windows/package-summary.html

Just an API/SPI for defining the output window.

Datasystems API

javadoc | download | architecture | usecases

In summary, the LoadersAPI is responsible for scanning files in a directory on disk, weeding out irrelevant files of no interest to the IDE, and grouping the rest into logical chunks, or just determining what type of data each represents. It does this scanning by asking each registered data loader whether or not the given file(s) should be handled. The first loader to recognize a file takes ownership of it, and creates a matching data object to represent it to the rest of the IDE.

Usage:

XXX no answer for deploy-dependencies

Interface NameStability ClassificationSpecified in What Document?
LoadersAPIOfficialorg-openide-loaders/org/openide/loaders/doc-files/api.html
Set of layer APIsIndividualtable with definitions
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of preferences APIsIndividualtable with definitions
Set of lookup APIsIndividualtable with definitions
Set of javax.swing.UIManager APIsIndividualtable with definitions

Module System API

javadoc | download | architecture | usecases

The Modules API lies at the core of NetBeans and describes how plug-in modules are added and managed. ModulesAPI

Interface NameStability ClassificationSpecified in What Document?
ModulesAPIOfficialorg-openide-modules/org/openide/modules/doc-files/api.html
CoreModulesAPIFriend
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of dtd APIsIndividualtable with definitions

Nodes API

javadoc | download | architecture

Nodes API serves as the main aparatus for visualisation of objects in NetBeans. Nodes augment objects with standard aspects used for visualisation (e.g. name, displayName, icons, set of proerties, subnodes hierarchy, etc.) Once a Node is defined for given object it can be visualised using diferent views e.g. trees, lists, tables etc. Descripion of nodes can be found here.

Interface NameStability ClassificationSpecified in What Document?
NodesAPIOfficialorg-openide-nodes/org/openide/nodes/doc-files/api.html
Set of property APIsIndividualtable with definitions

Text API

javadoc | download | architecture | usecases

The EditorAPI is used for accessing editor-related functionality from within the IDE for use by other modules and the core IDE itself.

Usage:

XXX no answer for deploy-dependencies

Interface NameStability ClassificationSpecified in What Document?
EditorAPIOfficial./org-openide-text/org/openide/text/doc-files/api.html
EditorKitInitializationFriend

In order to speedup, or remove the load of initialization of kit in AWT during startup, there is a special API that allows to ask the kit to pre-initialize. If the kit implements Callable interface from JDK, it is called in non-AWT thread. This works since version 6.18 and can be disabled by property oldInitialization.

Set of property APIsIndividualtable with definitions

Utilities API

javadoc | download | architecture | usecases

Described in the overall answer.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
UtilitiesAPIOfficialorg-openide-util/org/openide/util/doc-files/api.html
AWTBridgePrivatehttp://www.netbeans.org/source/browse/openide/util/src/org/netbeans/modules/openide/util/AWTBridge.java

a class that is looked up in Lookup.getDefault() and if registered can provide better UI elements for Actions.

SharedClassObject.setAccessibleUnder Developmentorg-openide-util/org/openide/util/SharedClassObject.html

used to instantiate subclasses.

WeakListener.setAccessibleUnder Developmentorg-openide-util/org/openide/util/WeakListeners.html

used to call the remove method using reflection

Set of java.io.File APIsIndividualtable with definitions
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of lookup APIsIndividualtable with definitions

Lookup

javadoc | download | architecture | usecases

Described in the overall answer.

Usage:

Nothing.

Interface NameStability ClassificationSpecified in What Document?
LookupAPIOfficialorg-openide-util-lookup/org/openide/util/lookup/doc-files/lookup-api.html

allows the discovery

LookupSPIOfficialorg-openide-util-lookup/org/openide/util/lookup/doc-files/lookup-spi.html

simplifies creation and registration of own lookup objects

ProviderRegistrationRemovalUnder Development./org-openide-util/org/openide/util/doc-files/api.html#service-lookup
Lookups.metaInfServicesUnder Developmentorg-openide-util-lookup/org/openide/util/lookup/Lookups.html#metaInfServices(java.lang.ClassLoader)

calls constructor of registered classes using reflection

Lookup.resetDefaultLookupFriend

There is a static private method Lookup.resetDefaultLookup that is called by NbJUnit's MockServices to properly reset default lookup and fire changes to all registred listeners.

Set of java.io.File APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of lookup APIsIndividualtable with definitions

Window System API

javadoc | download | architecture | usecases

Window System API is used to display and control application GUI: Main window, frames, components.

Usage:

You might use OpenIDE-Module-Requires: org.openide.windows.WindowManager but it is not generally done.

Interface NameStability ClassificationSpecified in What Document?
WindowSystemAPIOfficialorg-openide-windows/org/openide/windows/doc-files/api.html
WindowSystemImplementationAPIFriend
DataFlavorDnDTopComponentPrivate

DataFlavor.javaJVMLocalObjectMimeType + "; class=org.openide.windows.TopComponent"

DataFlavorDnDTopComponent.CloneablePrivate

DataFlavor.javaJVMLocalObjectMimeType + "; class=org.openide.windows.TopComponent$Cloneable"

DataFlavorDnDTopComponentArrayPrivate

DataFlavor.javaJVMLocalObjectMimeType + "; class=org.netbeans.core.windows.dnd.TopComponentDragSupport$TopComponentArray"

Set of layer APIsIndividualtable with definitions
Set of property APIsIndividualtable with definitions
Set of systemproperty APIsIndividualtable with definitions
Set of dtd APIsIndividualtable with definitions
Set of logger APIsIndividualtable with definitions
Set of javax.swing.UIManager APIsIndividualtable with definitions