Editor Utilities
Friend, Private or Third Party

The module defines EditorUtilitiesAPI.

See:
Description

Editor Utilities

org.netbeans.lib.editor.util
org.netbeans.lib.editor.util.swing

The module defines EditorUtilitiesAPI.
The present clients are editor/lib and editor/fold modules.

What is New (see all changes)?

• Jun 16 '08 Added DocumentUtilities.debugOffset(doc, offset)

  Adding DocumentUtilities.debugOffset(doc, offset) to dump both the integer offset and line and column as seen in editor's status bar. PositionRegion.toString(doc) debugs its bounds using debugOffset(). Added PositionRegion.getText() and PositionRegion.getString() to obtain text of the region.

• Jan 10 '08 Added DocumentUtilities.getMimeType

  Adding DocumentUtilities.getMimeType(Document) and DocumentUtilities.getMimeType(JTextComponent) in order to standardize access to documents' mimetype.

• Oct 17 '07 Added CharacterConversions class

  Adding CharacterConversions as a replacement for org.netbeans.editor.LineSeparatorConversion, which was deprecated.

• Sep 21 '07 Added DocumentListenerPriority.FIRST

  DocumentListenerPriority.FIRST is called prior any other priority levels.

• Sep 17 '07 Added DocumentUtilities.getDocumentListenerCount().

  DocumentUtilities.getDocumentListenerCount() returns total count of document listeners attached to a document covering the case when the document priority listening is used.

Use Cases

GapList

The GapList class is a java.util.List implementation similar to java.util.ArrayList but containing a gap in its underlying array. After a first modification at a particular index the subsequent modifications around that index are cheap.
The class is suitable for storage of any elements related to editing such as positions, elements, views etc.

PriorityMutex

The PriorityMutex is a simple mutex implementation allowing to find out that a priority thread (by default Event Dispatch Thread) is waiting to enter the mutex.
It's used e.g. in editor's view hierarchy or in editor fold hierarchy.

GapBranchElement

GapList-based element implementation suitable for line elements and any other branch element types.

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?
EditorUtilitiesAPI	Exported	Friend

Implementation Details

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.