Overview (Editor Library 2)

Editor Library 2
Package	Description
org.netbeans.api.editor
org.netbeans.api.editor.caret	The Editor Caret API opens up the editor to give information about its carets and to manipulate them.
org.netbeans.spi.editor
org.netbeans.spi.editor.caret	The Editor Caret SPI contains interface(s) to be implemented by clients in order to manipulate the editor carets.
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.document
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)?

Sep 15 '19 Ability to indent text set to TypedTextInterceptor

Added TypedTextInterceptor.MutableContext.setText overload, which optionally re-indents the provided text.
May 14 '19 Prepended text for highlights

If AttributeSet returned from HighlightsSequence contains key "virtual-text-prepend" with a value of type String, the UI may optionally render the value as a virtual text before the text of the highlight. It is recommended to make the span of length 1, to avoid problems when the AttributeSet with "virtual-text-prepend" is merged with other AttributeSets, which could lead to duplication.
Jul 16 '16 Added category to EditorActionRegistration

Allow to set the keymap-category for an action registered using @EditorActionRegistration.
May 25 '16 Position.Bias support added to EditorCaret

CaretInfo.getDotBias() and CaretInfo.getMarkBias() added together with other methods and parameters for bias manipulation to properly handle bidirectional text.
May 23 '16 Renamed ShiftHighlightsSequence to SplitOffsetHighlightsSequence

Renamed ShiftHighlightsSequence to SplitOffsetHighlightsSequence to and its getStartShift() to getStartSplitOffset() for better description and getEndShift() to getEndSplitOffset().

Use Cases

At the moment the Editor Library 2 module contains distinct APIs/SPIs. They live in their 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
Caret API - org.netbeans.api.editor.caret
Caret SPI - org.netbeans.spi.editor.caret

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
editor-caret	Exported	Official	.../api/editor/caret/package-summary.html Editor Caret API

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

Just normal module dependency.

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

Editor Library 2Official