| |
org.eclipse.jface.text
Class Document
java.lang.Object
org.eclipse.jface.text.AbstractDocument
org.eclipse.jface.text.Document
-
All Implemented Interfaces:
-
IDocument,
IDocumentExtension,
IDocumentExtension2,
IDocumentExtension3,
IDocumentExtension4,
IRepairableDocument,
IRepairableDocumentExtension
-
public class Document
- extends
AbstractDocument
Default document implementation. Uses a
GapTextStore wrapped
inside a
CopyOnWriteTextStore as text store.
The used line tracker considers 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.
Performance: The implementation should perform reasonably well for typical
source code documents. It is not designed for very large documents of a size of several
megabytes. Space-saving implementations are initially used for both the text store and the line
tracker; the first modification after a
set incurs the cost to transform the
document structures to efficiently handle updates.
See
GapTextStore and TreeLineTracker for algorithmic behavior of the used
document structures.
-
See Also:
-
GapTextStore,
CopyOnWriteTextStore
|
Constructor Summary
|
Document
()
Creates a new empty document. |
Document
(
String initialContent)
Creates a new document with the given initial content. |
|
Method Summary
|
boolean
|
isLineInformationRepairNeeded
(int offset,
int length,
String text)
Tells whether the line information of the document implementing this
interface needs to be repaired. |
|
Methods inherited from class org.eclipse.jface.text.
AbstractDocument
|
acceptPostNotificationReplaces,
addDocumentListener,
addDocumentPartitioningListener,
addDocumentRewriteSessionListener,
addPosition,
addPosition,
addPositionCategory,
addPositionUpdater,
addPrenotifiedDocumentListener,
checkStateOfPartitioner,
completeInitialization,
computeIndexInCategory,
computeIndexInPositionList,
computeIndexInPositionList,
computeNumberOfLines,
computePartitioning,
computePartitioning,
containsPosition,
containsPositionCategory,
doFireDocumentChanged,
doFireDocumentChanged,
doFireDocumentChanged2,
fireDocumentAboutToBeChanged,
fireDocumentChanged,
fireDocumentPartitioningChanged,
fireDocumentPartitioningChanged,
fireDocumentPartitioningChanged,
fireRewriteSessionChanged,
get,
get,
getActiveRewriteSession,
getChar,
getContentType,
getContentType,
getDefaultLineDelimiter,
getDocumentListeners,
getDocumentManagedPositions,
getDocumentPartitioner,
getDocumentPartitioner,
getDocumentPartitioningListeners,
getLegalContentTypes,
getLegalContentTypes,
getLegalLineDelimiters,
getLength,
getLineDelimiter,
getLineInformation,
getLineInformationOfOffset,
getLineLength,
getLineOffset,
getLineOfOffset,
getModificationStamp,
getNumberOfLines,
getNumberOfLines,
getPartition,
getPartition,
getPartitionings,
getPositionCategories,
getPositions,
getPositions,
getPositionUpdaters,
getStore,
getTracker,
ignorePostNotificationReplaces,
insertPositionUpdater,
registerPostNotificationReplace,
removeDocumentListener,
removeDocumentPartitioningListener,
removeDocumentRewriteSessionListener,
removePosition,
removePosition,
removePositionCategory,
removePositionUpdater,
removePrenotifiedDocumentListener,
repairLineInformation,
replace,
replace,
resumeListenerNotification,
resumePostNotificationProcessing,
search,
set,
set,
setDocumentPartitioner,
setDocumentPartitioner,
setInitialLineDelimiter,
setLineTracker,
setTextStore,
startRewriteSession,
startRewriteSessionOnPartitioners,
startSequentialRewrite,
stopListenerNotification,
stopPostNotificationProcessing,
stopRewriteSession,
stopRewriteSessionOnPartitioners,
stopSequentialRewrite,
updateDocumentStructures,
updatePositions
|
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
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
isLineInformationRepairNeeded
public boolean isLineInformationRepairNeeded(int offset,
int length,
String text)
throws
BadLocationException
-
Description copied from class:
AbstractDocument
- Tells whether the line information of the document implementing this
interface needs to be repaired.
-
-
Specified by:
-
isLineInformationRepairNeeded
in interface
IRepairableDocumentExtension
-
Overrides:
-
isLineInformationRepairNeeded
in class
AbstractDocument
-
-
Parameters:
-
offset - the document offset -
length - the length of the specified range -
text - the substitution text to check
-
Returns:
-
true if the line information must be repaired
-
Throws:
-
BadLocationException
- if the offset is invalid in this document -
See Also:
-
IRepairableDocument.repairLineInformation()
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
