Overview (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV NEXT

FRAMES NO FRAMES

Editor Library
Under Development

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.

See:
Description

Editor Library

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

Editor Library
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/libsrc 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)?

May 2 '07 Adding ExtCaret.get/setMatchBraceOffset

The ExtCaret.setMatchBraceOffset and the MATCH_BRACE_* constants can be used for customizing the algorithm for finding a matching bracket. The options are: match a breacket before caret, after caret or either side.
Apr 2 '07 Making JumpList final

The JumpList was never meant to be subclassed or instantialized even though the class did not prevent it. It is now final with private constructor; the same for JumpList.Entry class.
Jan 8 '07 Deprecating the use of DrawLayer

Using DrawLayer and related classes and methods has been deprecated in favor of the new Highlighting SPI in the editor/lib2 module. For more details see Highlighting SPI.
Jan 5 '07 Adding Coloring.fromAttributeSet method

Adding Coloring.fromAttributeSet static method to provide a simple and correct way of converting colorings from the format used by the new settings infrastructure to the format used by DrawEngine and various DrawLayers.
Nov 28 '05 editor/lib now has its own arch and apichanges documents.

Separate arch and apichanges documents extracted from editor to editor/lib.

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.

Implementation Details

Where are the sources for the module?

The sources for the module are in NetBeans CVS in editor/lib directory.

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.