Overview (Editor Utilities)

Editor Utilities
Package	Description
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)?

Dec 10 '12 Added String escape utils

Added StringEscapeUtils.escapeHtml and StringEscapeUtil.unescapeHtml to escape text to html.
Jul 30 '12 Added BlockCompare.invalidX() and invalidY()

Added BlockCompare.invalidX() and BlockCompare.invalidY() to check for invalid bounds of compared blocks.
Mar 9 '10 Added support for document property listeners

Adding DocumentUtilities.addPropertyChangeListener(Document, PropertyChangeListener) and DocumentUtilities.removePropertyChangeListener(Document, PropertyChangeListener) in order to support listening on document property changes.
Jan 14 '10 Added DocumentUtilities.getDocumentTimestamp(Document)

Adding DocumentUtilities.getDocumentTimestamp(Document) to provide access to documents' timestamp property.
Feb 1 '09 Added DocumentUtilities.getDocumentVersion(Document)

Adding DocumentUtilities.getDocumentVersion(Document) to provide access to documents' version property.

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	Under Development

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.

Editor UtilitiesUnder Development