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.
org.netbeans.spi.editor.typinghooks	The Typing Hooks SPI allows modules to intercept various key typed events handled by the editor infrastructure.

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)?

• Nov 14 '11 Add "weight" attribute to EditorActionRegistration.

  Add "weight" attribute to EditorActionRegistration annotation to allow for a clean actions overriding.

• Jul 16 '11 Zoom text actions added

  Zoom text actions allow to increase/decrease default font size by Ctrl+Wheel or by actions (defined in editor.actions module).

• Aug 5 '10 Typing Hooks SPI added

  Typing Hooks SPI allows interception of various key typed events that are processed in the editor. The SPI is a replacement for subclassing editor actions such as DefaultKeyTypedAction, InsertBreakAction, etc.

• Mar 26 '10 Adding line/column based dialog bindings

  Added DialogBinding.bindComponentToFile(FileObject fileObject, int line, int column, int length, JTextComponent component) and DialogBinding.bindComponentToDocument(Document document, int line, int column, int length, JTextComponent component).

• Mar 4 '10 EditorActionNames.toggleNonPrintableCharacters added.

  Added EditorActionNames.toggleNonPrintableCharacters action name.

Use Cases

At the moment the Editor Library 2 module contains three distinct SPIs. Each SPI lives in its own package and the usecases can be found in the packages overview.

• Code Generator SPI - org.netbeans.spi.editor.codegen
• Highlighting SPI - org.netbeans.spi.editor.highlighting
• Typing Hooks SPI - org.netbeans.spi.editor.typinghooks

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-code-generator	Exported	Official	.../spi/editor/codegen/package-summary.html Code Generator SPI
editor-highlighting	Exported	Official	.../editor/highlighting/package-summary.html Highlighting SPI
editor-typing-hooks	Exported	Official	.../editor/typinghooks/package-summary.html Typing Hooks 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.