Change History for the Editor Utilities API - NetBeans API Javadoc (Current Development Version)

Introduction

This document lists changes made to the Editor Utilities API. Please ask on the dev@openide.netbeans.org mailing list if you have any questions about the details of a change, or are wondering how to convert existing code to be compatible.

Index of APIs

Uncategorized changes

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

(Oct 17 '06) ListenerList.getListeners() return type changed.
(Oct 11 '06) CompactMap.MapEntry made an abstract class (not interface).
(Mar 13 '05) Repackaged to org.netbeans.lib.editor.util package

All changes by date

(Mar 27 '07) Added DocumentUtilities.isReadLocked() and isWriteLocked().
(Jan 16 '07) Added FlyOffsetGapList.elementOrEndOffset().
(Dec 6 '06) DocumentListenerPriority.LEXER added
(Nov 16 '06) Added ArrayUtilities.unmodifiableList().
(Oct 17 '06) ListenerList.getListeners() return type changed.
(Oct 11 '06) CompactMap.MapEntry made an abstract class (not interface).
(Sep 13 '06) Added ListenerList and DocumentListenerPriority.VIEW.
(Jun 14 '05) Added PositionComparator and PositionRegion
(Mar 24 '05) Added document listeners ordering support
(Mar 13 '05) Repackaged to org.netbeans.lib.editor.util package

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.editor.util > 1.20

(1.17) Added DocumentUtilities.isReadLocked() and isWriteLocked().
(1.16) Added FlyOffsetGapList.elementOrEndOffset().
(1.15) DocumentListenerPriority.LEXER added
(1.14) Added ArrayUtilities.unmodifiableList().
(1.13) ListenerList.getListeners() return type changed.
(1.12) CompactMap.MapEntry made an abstract class (not interface).
(1.11) Added ListenerList and DocumentListenerPriority.VIEW.
(1.6) Added PositionComparator and PositionRegion
(1.5) Repackaged to org.netbeans.lib.editor.util package
(1.4) Added document listeners ordering support

Changes by affected class

Details of all changes by API and date

Uncategorized changes

Added DocumentUtilities.isReadLocked() and isWriteLocked().

Mar 27 '07; API spec. version: 1.17; made by: mmetelka

DocumentUtilities.isReadLocked() and isWriteLocked() allow to check whether AbstractDocument based documents are currently read/write-locked.

Added FlyOffsetGapList.elementOrEndOffset().

Jan 16 '07; API spec. version: 1.16; made by: mmetelka

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

`DocumentListenerPriority.LEXER` added

Dec 6 '06; API spec. version: 1.15; made by: mmetelka

DocumentListenerPriority.LEXER added for use by lexer module to update token list for a document.

Added ArrayUtilities.unmodifiableList().

Nov 16 '06; API spec. version: 1.14; made by: mmetelka

ArrayUtilities.unmodifiableList() return simple unmodifiable list for the given object array.

ListenerList.getListeners() return type changed.

Oct 17 '06; API spec. version: 1.13; made by: vstejskal

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.

CompactMap.MapEntry made an abstract class (not interface).

Oct 11 '06; API spec. version: 1.12; made by: mmetelka

CompactMap.MapEntry was made an abstract class (instead of original interface) to prevent misuse of CompactMap.MapEntry.setNextMapEntry(). CompactMap.AbstractMapEntry was removed.

Added ListenerList and DocumentListenerPriority.VIEW.

Sep 13 '06; API spec. version: 1.11; made by: mmetelka

Added ListenerList and added DocumentListenerPriority.VIEW.

Added PositionComparator and PositionRegion

Jun 14 '05; API spec. version: 1.6; made by: mmetelka; issues: #59388

Added two new classes PositionComparator and PositionRegion and a new level AFTER_CARET_UPDATE to DocumentListenerPriority class.

Added document listeners ordering support

Mar 24 '05; API spec. version: 1.4; made by: mmetelka; issues: #35034

Added document listeners ordering support through DocumentUtilities.addDocumentListener(doc, listener, priority).

Repackaged to org.netbeans.lib.editor.util package

Mar 13 '05; API spec. version: 1.5; made by: mmetelka; issues: #56339

The present classes were repackaged from org.netbeans.modules.editor.util into org.netbeans.lib.editor.util package to fulfil the editor module split proposal #51486 according to which the editor classes independent of the NB IDE should be placed under org.netbeans.lib package.