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

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

• Aug 24 '10 Deprecating old formatting API

  The old formatting API (org.netbeans.editor.Formatter & co.) has been deprecated and moved to editor.deprecated.pre65formatting module.

  The exact API changes are listed in the sigtest report below.

  -sigtest-init:
       [echo] sigtest check: editor.lib; cnb: org-netbeans-modules-editor-lib; email: api-changes@netbeans.org; type: check
  
  check-sigtest:
      [mkdir] Created dir: /work/netbeans/main2m/editor.lib/build/test/sigtest/results
    [sigtest] /work/netbeans/main2m/editor.lib/build/test/sigtest/results/org.netbeans.modules.editor.lib
    [sigtest] Packages: org.netbeans.editor.*, org.netbeans.editor.ext.*, org.netbeans.editor.view.spi.*, org.netbeans.lib.editor.hyperlink.spi.*, org.netbeans.lib.editor.view.*
    [sigtest] Missing /System/Library/Frameworks/JavaVM.framework/Versions/1.6.0/Home/lib/rt.jar
    [sigtest] 
    [sigtest] email: api-changes@netbeans.org
    [sigtest] SignatureTest report
    [sigtest] Base version: 2.11.0
    [sigtest] Tested version: 2.11.0
    [sigtest] Check mode: bin [throws removed]
    [sigtest] Constant checking: on
    [sigtest] 
    [sigtest] 
    [sigtest] Class org.netbeans.editor.BaseDocument
    [sigtest]   "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseDocument.getFormatter()
    [sigtest]   "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseDocument.getLegacyFormatter()
    [sigtest] 
    [sigtest] Class org.netbeans.editor.BaseKit
    [sigtest]   "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseKit.createFormatter()
    [sigtest] 
    [sigtest] Class org.netbeans.editor.BaseKit$PasteAction
    [sigtest]   "E1.2 - API type removed" : method public static void org.netbeans.editor.BaseKit$PasteAction.indentBlock(org.netbeans.editor.BaseDocument,int,int)
    [sigtest] 
    [sigtest] Class org.netbeans.editor.Formatter
    [sigtest]   "E1.2 - API type removed" : CLASS public org.netbeans.editor.Formatter
    [sigtest] 
    [sigtest] Class org.netbeans.editor.GuardedDocument
    [sigtest]   "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseDocument.getFormatter()
    [sigtest]   "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseDocument.getLegacyFormatter()
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.AbstractFormatLayer
    [sigtest]   "E1.2 - API type removed" : CLASS public abstract org.netbeans.editor.ext.AbstractFormatLayer
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.ExtFormatSupport
    [sigtest]   "E1.2 - API type removed" : CLASS public org.netbeans.editor.ext.ExtFormatSupport
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.ExtFormatter
    [sigtest]   "E1.2 - API type removed" : CLASS public org.netbeans.editor.ext.ExtFormatter
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.ExtFormatter$Simple
    [sigtest]   "E1.2 - API type removed" : CLASS public static org.netbeans.editor.ext.ExtFormatter$Simple
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.ExtKit
    [sigtest]   "E1.2 - API type removed" : method public org.netbeans.editor.Formatter org.netbeans.editor.BaseKit.createFormatter()
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.FormatLayer
    [sigtest]   "E1.2 - API type removed" : CLASS public abstract interface org.netbeans.editor.ext.FormatLayer
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.FormatSupport
    [sigtest]   "E1.2 - API type removed" : CLASS public org.netbeans.editor.ext.FormatSupport
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.FormatTokenPosition
    [sigtest]   "E1.2 - API type removed" : CLASS public abstract interface org.netbeans.editor.ext.FormatTokenPosition
    [sigtest] 
    [sigtest] Class org.netbeans.editor.ext.FormatWriter
    [sigtest]   "E1.2 - API type removed" : CLASS public final org.netbeans.editor.ext.FormatWriter
    [sigtest] 
    [sigtest] /work/netbeans/main2m/editor.lib/build/test/sigtest/results/org-netbeans-modules-editor-lib.xml: 1 failures in /work/netbeans/main2m/editor.lib/nbproject/org-netbeans-modules-editor-lib.sig
  
  BUILD FAILED
  Signature tests return code is wrong (1), check the messages above
  

• May 5 '10 Support for heavyweight tooltips

  Adding flags to o.n.editor.ext.ToolTipSupport class that control tooltip behavior such as if the tooltip should be hidden on mouse move, timeout, etc. The flags are FLAG_HIDE_ON_MOUSE_MOVE, FLAG_HIDE_ON_TIMER, FLAG_PERMANENT and FLAGS_LIGHTWEIGHT_TOOLTIP, FLAGS_HEAVYWEIGHT_TOOLTIP.

  A new method ToolTipSupport.setTooltip() accepting the additional flags parameter has also been added.

• Mar 29 '10 Adding Utilities.createSingleLineEditor

  Adding o.n.editor.Utilities.createSingleLineEditor(String mimeType) method in order to give modules a unified way of creating simple TextField-like controls.

• Mar 1 '10 Hiding listener methods from public API

  A bunch of listener methods were accidentally made publically visible when ToolTipSupport class was first introduced. These were now removed and marked by @PatchedPublic in order to preserve binary compatibility.

• Mar 1 '10 Making ToolTipSupport.setToolTipVisible() public

  Making o.n.editor.ext.ToolTipSupport public in order to allow modules to use custom tooltip components and have full control over their displaying.

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.

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

Nothing.

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