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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.util/1 1.17

PREV NEXT

FRAMES NO FRAMES

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

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

Mar 27 '07 Added DocumentUtilities.isReadLocked() and isWriteLocked().

DocumentUtilities.isReadLocked() and isWriteLocked() allow to check whether AbstractDocument based documents are currently read/write-locked.
Jan 16 '07 Added FlyOffsetGapList.elementOrEndOffset().

FlyOffsetGapList.elementOrEndOffset() added for use by lexer module to get either an element's offset or end offset of the last element.
Dec 6 '06 DocumentListenerPriority.LEXER added

DocumentListenerPriority.LEXER added for use by lexer module to update token list for a document.
Nov 16 '06 Added ArrayUtilities.unmodifiableList().

ArrayUtilities.unmodifiableList() return simple unmodifiable list for the given object array.
Oct 17 '06 ListenerList.getListeners() return type changed.

ListenerList.getListeners now returns List<T> instead of T[]. The listeners are returned in exactly the same order as they were added to the ListenerList.

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.