Editor Library 2
Official

The Netbeans editor infrastructure provides an implementation of the Swing Text package APIs as well as some additional features such as syntax coloring, code folding, braces matching, etc.

See:
Description

Editor Library 2

org.netbeans.api.editor
org.netbeans.spi.editor.codegen	The Code Generator SPI gives modules a chance to plug their own code generators into the popup that appears in the editor on the Insert Code action invocation.
org.netbeans.spi.editor.highlighting	The Highlighting SPI is a new way of influencing how text in an editor component is rendered.
org.netbeans.spi.editor.highlighting.support	The support package provides several implementations of the HighlightsContainer interface.

The Netbeans editor infrastructure provides an implementation of the Swing Text package APIs as well as some additional features such as syntax coloring, code folding, braces matching, etc.

What is New (see all changes)?

• Jul 1 '09 EditorRegistry.COMPONENT_REMOVED_PROPERTY added.

  EditorRegistry.COMPONENT_REMOVED_PROPERTY is fired when a component is removed from component hierarchy.

• May 15 '09 DialogBinding added

  DialogBinding allows for content of some text component to be virtually placed to the given offset inside of a file or document. This way, the necessary context is provided for code completion and similar features to work in any text component.

• Apr 7 '09 EditorActionRegistration annotation added

  EditorActionRegistration allows to easily register an editor action into the list of actions of an editor kit. It also allows a lazy action's class loading (more details in javadoc).

• Apr 30 '08 Code Generation SPI added

  The Code Generation SPI consists of two interfaces. The CodeGenerator implementations registered for various mime types serve for creating code snippets and inserting them into documents on the Insert Code editor action invocation. The CodeGeneratorContextProvider implementations registered for the mime types could provide the respective CodeGenerators with an additional context information.

• Sep 13 '07 HighlightAttributeValue interface added

  The HighlightAttributeValue allows specifying highlights with attributes, which value is lazily evaluated at the time when the attrbute is used. For example when specifying tooltips.

Use Cases

At the moment the Editor Library 2 module contains only the Highlighting SPI, which use cases can be found in the org.netbeans.spi.editor.highlighting package overview.

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 Name	In/Out	Stability	Specified in What Document?
editor-highlighting	Exported	Official	.../editor/highlighting/package-summary.html Highlighting SPI

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
HighlightsLayerIncludes	Exported	Official	Defines a regular expression that can be used for filtering out highlighting layers used for rendering a text component. If specified, any layer with id matching the regular expression will be used for rendering the component. By default, when the property is not specified or is null, all layers are used. See Use case 5. for more details.
HighlightsLayerExcludes	Exported	Official	Defines a regular expression that can be used for filtering out highlighting layers used for rendering a text component. If specified, any layer with id matching the regular expression will not be used for rendering the component. By default, when the property is not specified or is null, all layers are used. See Use case 5. for more details.

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial 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?

Just normal module dependency.

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