Overview (Editor Library)

Editor Library
Package	Description
org.netbeans.editor
org.netbeans.editor.ext	Completion Design View
org.netbeans.editor.view.spi
org.netbeans.lib.editor.hyperlink.spi
org.netbeans.lib.editor.view

The editor functionality are mainly implementations of the Swing Text package APIs plus extension features such as Syntax Coloring, Code Completion, Word Matching, Abbreviations or Macros.

The library part is located under editor/lib/src folder.
It depends on the following classes from openide:

org.openide.DialogDescriptor
org.openide.DialogDisplayer
org.openide.ErrorManager
org.openide.NotifyDescriptor

org.openide.util.Lookup
org.openide.util.LookupListener
org.openide.util.LookupEvent
org.openide.util.NbBundle
org.openide.util.RequestProcessor
org.openide.util.Task

The above classes should remain to be isolated in a sense that they operate without loading other openide classes (if they need an implementation class they get it from Lookup).

Hyperlink SPI

EditorHyperlinkSPI Hyperlink SPI in org.netbeans.lib.editor.hyperlink.spi allows the editors for a particular mime-type to respond to the situation when a user hovers over the text with a Ctrl key pressed.
The Hyperlink SPI resolves whether the text under the mouse is hyperlink-able and defines the span of the hyperlink and the action to be performed when the user clicks on the hyperlink.
The SPI consists of a single HyperlinkProvider class that contains a javadoc with instructions about how to register the implementation in the xml layer for the given mime-type (mentioned in the layer section here as well).

What is New (see all changes)?

Nov 3 '20 Allow to specify minimum caret width

If present, JTextComponent property "CARET_MIN_WIDTH" with a value of type IntUnaryOpertor is used by BaseCaret to override constant 2.
May 20 '13 Document handling split

Document data handling and implementation was separated into editor.document module
Mar 11 '13 Removed dependencies on Folding

BaseCaret handling of folding was factored out. BaseCaret still implements the FoldHierarchyListener, but should not be used as a listener on a hierarchy, and will not attach itself. BaseCaret's listener method does nothing.

Folding actions from ActionFactory were deprecated, they moved to editor.fold.nbui module. Public classes in org.netbeans.editor.ActionFactory were changed to delegators to the actual actions registered with the component's EditorKit.
Mar 11 '13 Allow to refresh editor view so that caret is visible

The method helps to ensure that the caret, if it was originally visible on the screen, will remain visible after some view hierarchy change (i.e. define a new fold).
Mar 8 '13 SidebarFactory interface deprecated

The interface org.netbeans.editor.SideBarFactory was adopted to editor.lib2. The original interface was deprecated. Clients should start using the relocated interface.

Use Cases

No answer

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?

EditorHyperlinkSPI

Exported

Under Development

Hyperlink SPI in org.netbeans.lib.editor.hyperlink.spi allows the editors for a particular mime-type to respond to the situation when a user hovers over the text with a Ctrl key pressed.

EditorLibraryModuleAPI

Exported

Under Development

Editor defines APIs and SPIs both by

Providing java classes in public packages for further reuse.
Most of the classes were created spontaneously (several years ago) without fulfilling of the rules imposed on APIs and SPIs at the present time.
There is an ongoing work to revisit the existing classes and create stable APIs and SPIs (and possibly extract functionality into a submodule where appropriate). However this is a long-term task spanning several promotions.
Being sensitive to content of certain directories in xml layer.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
DefaultEditorKit.EndOfLineStringProperty	Exported	Stable	Document property containing line separator that was used when the document content was loaded from a `java.io.Reader` by an `EditorKit.read()`.
line-limit	Exported	Private	Document property that determines the number of characters in the longest line determined during the document loading from a reader by the editor kit.
CARET_MIN_WIDTH	Exported	Under Development	Component client property that provides an `IntUnaryOperator` which is invoked with a document offset and returns a minimum caret width. This overrides a constant 2 minimum caret width.

Group of systemproperty interfaces

Interface Name

In/Out

Stability

Specified in What Document?

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.

Editor LibraryUnder Development