org.eclipse.jface.text

Provides a framework for creating and manipulating text documents.

Package Specification

IDocument is the major text model abstraction. It provides content management, position management using position categories, document partition management, and change notification. In order to be notified about document changes, an object must implements IDocumentListener and must be registered with the document. Position updating in responds to a document change is performed by implementers of IDocumentPositionUpdater. Partition updating in responds to a document change is performed by implements of IDocumentPartitioner. In order to be notified about document partition changes, objects must implement IDocumentParititoningListener and must be registered with the document.

The package contains default implementations for document position updaters and for documents. AbstractDocument uses ITextStorage for storing and managing its content and ILineTracker to maintain a line structure of its content. As defaults a gap text implementation of ITextStore is provided, together with a line tracker understanding the three standard line delimiters ("\r", "\n", "\r\n") and a line tracker which can be freely configured to consider any given set of strings as valid line delimiters.

An AbstractDocument supports the following implementation plug-ins:

• a text store implementing org.eclipse.jface.text.ITextStore for storing and managing the document's content,
• a line tracker implementing org.eclipse.jface.text.ILineTracker to map character positions to line numbers and vice versa

This class must be subclassed.

The line tracker can be configured with the set of legal line delimiters. Line delimiters are unconstrained.

A default position updater must be configured with the position category whose positions it will update.

• text manipulation
• positions
• partitions
• line information
• document change listeners
• document partition change listeners

It introduces the notion of sequentially rewriting a document.

It adds configuration methods to post notification replaces and document listener notification.

Adds the concept of multiple partitionings and the concept of zero-length partitions in conjunction with open and delimited partitions.

Extends the original concept of a document partitioner to answer the position categories that are used to manage the partitioning information.

This extension also introduces the concept of open and delimited partitions. A delimited partition has a predefined textual token delimiting its start and end, while an open partition can fill any space between two delimited partitions.

An open partition of length zero can occur between two delimited partitions, thus having the same offset as the following delimited partition.

Clients may implement this interface.

In order to provided backward compatibility for clients of IDocumentPartitioningListener, extension interfaces are used to provide a means of evolution.