Eclipse Platform
2.0

org.eclipse.jface.text
Class Document

java.lang.Object
  |
  +--org.eclipse.jface.text.AbstractDocument
        |
        +--org.eclipse.jface.text.Document
All Implemented Interfaces:
IDocument, IDocumentExtension

public class Document
extends AbstractDocument

Default document implementation. Uses a gap text store as text store and installs a line tracker considering the following strings as line delimiters "\n", "\r", "\r\n". The document is ready to use. It has a default position category for which a default position updater is installed.

See Also:
GapTextStore

Nested Class Summary
 
Nested classes inherited from class org.eclipse.jface.text.IDocumentExtension
IDocumentExtension.IReplace
 
Field Summary
 
Fields inherited from interface org.eclipse.jface.text.IDocument
DEFAULT_CATEGORY, DEFAULT_CONTENT_TYPE
 
Constructor Summary
Document()
          Creates a new empty document.
Document(String initialContent)
          Creates a new document with the given initial content.
 
Method Summary
 void startSequentialRewrite(boolean normalized)
          Tells the document that it is about to be sequentially rewritten.
 void stopSequentialRewrite()
          Tells the document that the sequential rewrite has been finished.
 
Methods inherited from class org.eclipse.jface.text.AbstractDocument
addDocumentListener, addDocumentPartitioningListener, addPosition, addPosition, addPositionCategory, addPositionUpdater, addPrenotifiedDocumentListener, completeInitialization, computeIndexInCategory, computeIndexInPositionList, computeNumberOfLines, computePartitioning, containsPosition, containsPositionCategory, fireDocumentAboutToBeChanged, fireDocumentChanged, fireDocumentPartitioningChanged, fireDocumentPartitioningChanged, get, get, getChar, getContentType, getDocumentListeners, getDocumentManagedPositions, getDocumentPartitioner, getDocumentPartitioningListeners, getLegalContentTypes, getLegalLineDelimiters, getLength, getLineDelimiter, getLineInformation, getLineInformationOfOffset, getLineLength, getLineOffset, getLineOfOffset, getNumberOfLines, getNumberOfLines, getPartition, getPositionCategories, getPositions, getPositionUpdaters, getStore, getTracker, insertPositionUpdater, registerPostNotificationReplace, removeDocumentListener, removeDocumentPartitioningListener, removePosition, removePosition, removePositionCategory, removePositionUpdater, removePrenotifiedDocumentListener, replace, resumePostNotificationProcessing, search, set, setDocumentPartitioner, setLineTracker, setTextStore, stopPostNotificationProcessing, updateDocumentStructures, updatePositions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Document

public Document()
Creates a new empty document.


Document

public Document(String initialContent)
Creates a new document with the given initial content.

Parameters:
initialContent - the document's initial content
Method Detail

startSequentialRewrite

public void startSequentialRewrite(boolean normalized)
Description copied from interface: IDocumentExtension
Tells the document that it is about to be sequentially rewritten. That is a sequence of non-overlapping replace operations will be performed on it. The normalize flag indicates whether the rewrite is preformed from the start of the document to its end or from an arbitrary start offset.

Specified by:
startSequentialRewrite in interface IDocumentExtension
Overrides:
startSequentialRewrite in class AbstractDocument
Parameters:
normalized - true if performed from the start to the end of the document

stopSequentialRewrite

public void stopSequentialRewrite()
Description copied from interface: IDocumentExtension
Tells the document that the sequential rewrite has been finished.

Specified by:
stopSequentialRewrite in interface IDocumentExtension
Overrides:
stopSequentialRewrite in class AbstractDocument

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.