Class AbstractDocument
- All Implemented Interfaces:
IDocument
,IDocumentExtension
,IDocumentExtension2
,IDocumentExtension3
,IDocumentExtension4
,IRepairableDocument
,IRepairableDocumentExtension
- Direct Known Subclasses:
Document
,ProjectionDocument
IDocument
and its extension
interfaces IDocumentExtension
,
IDocumentExtension2
,
IDocumentExtension3
,
IDocumentExtension4
, as well as
IRepairableDocument
.
An AbstractDocument
supports the following implementation
plug-ins:
- a text store implementing
ITextStore
for storing and managing the document's content, - a line tracker implementing
ILineTracker
to map character positions to line numbers and vice versa
This class must be subclassed. Subclasses must configure which implementation plug-ins the document instance should use. Subclasses are not intended to overwrite existing methods.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.jface.text.IDocumentExtension
IDocumentExtension.IReplace
-
Field Summary
Fields inherited from interface org.eclipse.jface.text.IDocument
DEFAULT_CATEGORY, DEFAULT_CONTENT_TYPE
Fields inherited from interface org.eclipse.jface.text.IDocumentExtension3
DEFAULT_PARTITIONING
Fields inherited from interface org.eclipse.jface.text.IDocumentExtension4
UNKNOWN_MODIFICATION_STAMP
-
Constructor Summary
ModifierConstructorDescriptionprotected
The default constructor does not perform any configuration but leaves it to the clients who must first initialize the implementation plug-ins and then callcompleteInitialization
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Tells the receiver to accept calls toregisterPostNotificationReplace
untilignorePostNotificationReplaces
is called.void
addDocumentListener
(IDocumentListener listener) Registers the document listener with the document.void
Registers the document partitioning listener with the document.void
Registers the document rewrite session listener with the document.void
addPosition
(String category, Position position) Adds the position to the specified position category of the document.void
addPosition
(Position position) Adds the position to the document's default position category.void
addPositionCategory
(String category) Adds a new position category to the document.void
addPositionUpdater
(IPositionUpdater updater) Appends a new position updater to the document's list of position updaters.void
Adds the given document listener as one which is notified before those document listeners added withaddDocumentListener
are notified.protected final void
checkStateOfPartitioner
(IDocumentPartitioner partitioner, String partitioning) Checks the state for the given partitioner and stops the active rewrite session.protected void
Initializes document listeners, positions, and position updaters.int
computeIndexInCategory
(String category, int offset) Computes the index at which aPosition
with the specified offset would be inserted into the given category.protected int
computeIndexInPositionList
(List<? extends Position> positions, int offset) Deprecated.protected int
computeIndexInPositionList
(List<? extends Position> positions, int offset, boolean orderedByOffset) Computes the index in the list of positions at which a position with the given position would be inserted.int
computeNumberOfLines
(String text) Computes the number of lines in the given text.computePartitioning
(int offset, int length) Computes the partitioning of the given document range using the document's partitioner.computePartitioning
(String partitioning, int offset, int length, boolean includeZeroLengthPartitions) Computes the partitioning of the given document range based on the given partitioning type.boolean
containsPosition
(String category, int offset, int length) Determines whether a position described by the parameters is managed by this document.boolean
containsPositionCategory
(String category) Checks the presence of the specified position category.protected void
Notifies all listeners about the given document change.protected void
doFireDocumentChanged
(DocumentEvent event, boolean firePartitionChange, IRegion partitionChange) Deprecated.as of 3.0.protected void
Notifies all listeners about the given document change.protected void
Fires the given document event to all registers document listeners informing them about the forthcoming document manipulation.protected void
fireDocumentChanged
(DocumentEvent event) Updates the internal document structures and informs all document listeners if listener notification has been enabled.protected void
Deprecated.as of 2.0.protected void
Fires the document partitioning changed notification to all registered document partitioning listeners.protected void
Deprecated.as of 3.0.protected void
Fires the given event to all registered rewrite session listeners.get()
Returns this document's complete text.get
(int pos, int length) Returns this document's text for the specified range.final DocumentRewriteSession
Returns the active rewrite session of this document ornull
.char
getChar
(int pos) Returns the character at the given document offset in this document.getContentType
(int offset) Returns the type of the document partition containing the given offset.getContentType
(String partitioning, int offset, boolean preferOpenPartitions) Returns the type of the document partition containing the given offset for the given partitioning.Returns this document's default line delimiter.protected List<IDocumentListener>
Returns the document's document listeners.Returns all positions managed by the document grouped by category.Returns this document's partitioner.getDocumentPartitioner
(String partitioning) Returns the partitioner for the given partitioning ornull
if no partitioner is registered.protected List<IDocumentPartitioningListener>
Returns the document's partitioning listeners.String[]
Returns the set of legal content types of document partitions.String[]
getLegalContentTypes
(String partitioning) Returns the set of legal content types of document partitions for the given partitioning This set can be empty.String[]
Returns the document's legal line delimiters.int
Returns the number of characters in this document.getLineDelimiter
(int line) Returns the line delimiter of that line ornull
if the line is not closed with a line delimiter.getLineInformation
(int line) Returns a description of the specified line.getLineInformationOfOffset
(int offset) Returns a description of the line at the given offset.int
getLineLength
(int line) Returns the length of the given line including the line's delimiter.int
getLineOffset
(int line) Determines the offset of the first character of the given line.int
getLineOfOffset
(int pos) Returns the number of the line at which the character of the specified position is located.long
Returns the modification stamp of this document.int
Returns the number of lines in this document.int
getNumberOfLines
(int offset, int length) Returns the number of lines which are occupied by a given text range.getPartition
(int offset) Returns the document partition in which the position is located.getPartition
(String partitioning, int offset, boolean preferOpenPartitions) Returns the document partition of the given partitioning in which the given offset is located.String[]
Returns the existing partitionings for this document.String[]
Returns all position categories of this document.Position[]
getPositions
(String category) Returns all positions of the given position category.Position[]
getPositions
(String category, int offset, int length, boolean canStartBefore, boolean canEndAfter) Returns all positions of the given category that are inside the given region.Returns the list of position updaters attached to the document.protected ITextStore
getStore()
Returns the document's text store.protected ILineTracker
Returns the document's line tracker.void
Tells the receiver to ignore calls toregisterPostNotificationReplace
untilacceptPostNotificationReplaces
is called.void
insertPositionUpdater
(IPositionUpdater updater, int index) Inserts the position updater at the specified index in the document's list of position updaters.boolean
isLineInformationRepairNeeded
(int offset, int length, String text) Tells whether the line information of the document implementing this interface needs to be repaired after replacing the given text.void
Callback for document listeners to be used insidedocumentChanged
to register a post notification replace operation on the document notifying them.void
removeDocumentListener
(IDocumentListener listener) Removes the listener from the document's list of document listeners.void
Removes the listener from this document's list of document partitioning listeners.void
Removes the listener from the document's list of document rewrite session listeners.void
removePosition
(String category, Position position) Removes the given position from the specified position category.void
removePosition
(Position position) Removes the given position from the document's default position category.void
removePositionCategory
(String category) Deletes the position category from the document.void
removePositionUpdater
(IPositionUpdater updater) Removes the position updater from the document's list of position updaters.void
Removes the given document listener from the document's list of pre-notified document listeners.void
Repairs the line information of the document implementing this interface.void
Substitutes the given text for the specified document range.void
Substitutes the given text for the specified document range.void
Resumes the notification of document listeners which must previously have been stopped by a call tostopListenerNotification
.void
Resumes the processing of post notification replace operations.int
search
(int startPosition, String findString, boolean forwardSearch, boolean caseSensitive, boolean wholeWord) Deprecated.as of 3.0 search is provided byFindReplaceDocumentAdapter
void
Replaces the content of the document with the given text.void
Replaces the content of the document with the given text.void
setDocumentPartitioner
(String partitioning, IDocumentPartitioner partitioner) Sets this document's partitioner.void
setDocumentPartitioner
(IDocumentPartitioner partitioner) Sets this document's partitioner.void
setInitialLineDelimiter
(String lineDelimiter) Sets this document's initial line delimiter i.e. the one which is returned bygetDefaultLineDelimiter
if the document does not yet contain any line delimiter.protected void
setLineTracker
(ILineTracker tracker) Sets the document's line tracker.protected void
setTextStore
(ITextStore store) Sets the document's text store.startRewriteSession
(DocumentRewriteSessionType sessionType) Tells the document that it is about to be rewritten.protected final void
Starts the given rewrite session.void
startSequentialRewrite
(boolean normalized) Deprecated.since 3.1.void
Can be called prior to areplace
operation.void
Stops the processing of registered post notification replace operations untilresumePostNotificationProcessing
is called.void
stopRewriteSession
(DocumentRewriteSession session) Tells the document to stop the rewrite session.protected final void
Stops the given rewrite session.void
Deprecated.As of 3.1, replaced byIDocumentExtension4.stopRewriteSession(DocumentRewriteSession)
protected void
Updates document partitioning and document positions according to the specification given by the document event.protected void
updatePositions
(DocumentEvent event) Updates all positions of all categories to the change described by the document event.
-
Constructor Details
-
AbstractDocument
protected AbstractDocument()The default constructor does not perform any configuration but leaves it to the clients who must first initialize the implementation plug-ins and then callcompleteInitialization
. Results in the construction of an empty document.
-
-
Method Details
-
getStore
Returns the document's text store. Assumes that the document has been initialized with a text store.- Returns:
- the document's text store
-
getTracker
Returns the document's line tracker. Assumes that the document has been initialized with a line tracker.- Returns:
- the document's line tracker
-
getDocumentListeners
Returns the document's document listeners.- Returns:
- the document's document listeners
-
getDocumentPartitioningListeners
Returns the document's partitioning listeners.- Returns:
- the document's partitioning listeners
-
getDocumentManagedPositions
Returns all positions managed by the document grouped by category.- Returns:
- the document's positions
-
getDocumentPartitioner
Description copied from interface:IDocument
Returns this document's partitioner.Use
IDocumentExtension3.getDocumentPartitioner(String)
when the document supports multiple partitionings. In that case this method is equivalent to:IDocumentExtension3 extension= (IDocumentExtension3) document; return extension.getDocumentPartitioner(IDocumentExtension3.DEFAULT_PARTITIONING);
- Specified by:
getDocumentPartitioner
in interfaceIDocument
- Returns:
- this document's partitioner
-
setTextStore
Sets the document's text store. Must be called at the beginning of the constructor.- Parameters:
store
- the document's text store
-
setLineTracker
Sets the document's line tracker. Must be called at the beginning of the constructor.- Parameters:
tracker
- the document's line tracker
-
setDocumentPartitioner
Description copied from interface:IDocument
Sets this document's partitioner. The caller of this method is responsible for disconnecting the document's old partitioner from the document and to connect the new partitioner to the document. Informs all document partitioning listeners about this change.Use
IDocumentExtension3.setDocumentPartitioner(String, IDocumentPartitioner)
when the document supports multiple partitionings. In that case this method is equivalent to:IDocumentExtension3 extension= (IDocumentExtension3) document; extension.setDocumentPartitioner(IDocumentExtension3.DEFAULT_PARTITIONING, partitioner);
- Specified by:
setDocumentPartitioner
in interfaceIDocument
- Parameters:
partitioner
- the document's new partitioner- See Also:
-
completeInitialization
protected void completeInitialization()Initializes document listeners, positions, and position updaters. Must be called inside the constructor after the implementation plug-ins have been set. -
addDocumentListener
Description copied from interface:IDocument
Registers the document listener with the document. After registration the IDocumentListener is informed about each change of this document. If the listener is already registered nothing happens.An
IDocumentListener
may call back to this method when being inside a document notification.- Specified by:
addDocumentListener
in interfaceIDocument
- Parameters:
listener
- the listener to be registered
-
removeDocumentListener
Description copied from interface:IDocument
Removes the listener from the document's list of document listeners. If the listener is not registered with the document nothing happens.An
IDocumentListener
may call back to this method when being inside a document notification.- Specified by:
removeDocumentListener
in interfaceIDocument
- Parameters:
listener
- the listener to be removed
-
addPrenotifiedDocumentListener
Description copied from interface:IDocument
Adds the given document listener as one which is notified before those document listeners added withaddDocumentListener
are notified. If the given listener is also registered usingaddDocumentListener
it will be notified twice. If the listener is already registered nothing happens.This method is not for public use.
- Specified by:
addPrenotifiedDocumentListener
in interfaceIDocument
- Parameters:
listener
- the listener to be added as pre-notified document listener- See Also:
-
removePrenotifiedDocumentListener
Description copied from interface:IDocument
Removes the given document listener from the document's list of pre-notified document listeners. If the listener is not registered with the document nothing happens.This method is not for public use.
- Specified by:
removePrenotifiedDocumentListener
in interfaceIDocument
- Parameters:
listener
- the listener to be removed- See Also:
-
addDocumentPartitioningListener
Description copied from interface:IDocument
Registers the document partitioning listener with the document. After registration the document partitioning listener is informed about each partition change cause by a document manipulation or by changing the document's partitioner. If a document partitioning listener is also a document listener, the following notification sequence is guaranteed if a document manipulation changes the document partitioning:- listener.documentAboutToBeChanged(DocumentEvent);
- listener.documentPartitioningChanged();
- listener.documentChanged(DocumentEvent);
An
IDocumentPartitioningListener
may call back to this method when being inside a document notification.- Specified by:
addDocumentPartitioningListener
in interfaceIDocument
- Parameters:
listener
- the listener to be added
-
removeDocumentPartitioningListener
Description copied from interface:IDocument
Removes the listener from this document's list of document partitioning listeners. If the listener is not registered with the document nothing happens.An
IDocumentPartitioningListener
may call back to this method when being inside a document notification.- Specified by:
removeDocumentPartitioningListener
in interfaceIDocument
- Parameters:
listener
- the listener to be removed
-
addPosition
public void addPosition(String category, Position position) throws BadLocationException, BadPositionCategoryException Description copied from interface:IDocument
Adds the position to the specified position category of the document. Positions may be added multiple times. The order of the category is maintained.Note: The position is only updated on each change applied to the document if a
IPositionUpdater
has been registered that handles the given category.- Specified by:
addPosition
in interfaceIDocument
- Parameters:
category
- the category to which to addposition
- the position to be added- Throws:
BadLocationException
- if position describes an invalid range in this documentBadPositionCategoryException
- if the category is undefined in this document
-
addPosition
Description copied from interface:IDocument
Adds the position to the document's default position category. This is a convenience method foraddPosition(DEFAULT_CATEGORY, position)
.- Specified by:
addPosition
in interfaceIDocument
- Parameters:
position
- the position to be added- Throws:
BadLocationException
- if position describes an invalid range in this document
-
addPositionCategory
Description copied from interface:IDocument
Adds a new position category to the document. If the position category already exists nothing happens.- Specified by:
addPositionCategory
in interfaceIDocument
- Parameters:
category
- the category to be added
-
addPositionUpdater
Description copied from interface:IDocument
Appends a new position updater to the document's list of position updaters. Position updaters may be added multiple times.An
IPositionUpdater
may call back to this method when being inside a document notification.- Specified by:
addPositionUpdater
in interfaceIDocument
- Parameters:
updater
- the updater to be added
-
containsPosition
Description copied from interface:IDocument
Determines whether a position described by the parameters is managed by this document.- Specified by:
containsPosition
in interfaceIDocument
- Parameters:
category
- the category to checkoffset
- the offset of the position to findlength
- the length of the position to find- Returns:
true
if position is found
-
containsPositionCategory
Description copied from interface:IDocument
Checks the presence of the specified position category.- Specified by:
containsPositionCategory
in interfaceIDocument
- Parameters:
category
- the category to check- Returns:
true
if category is defined
-
computeIndexInPositionList
@Deprecated protected int computeIndexInPositionList(List<? extends Position> positions, int offset) Deprecated.As of 3.4, replaced bycomputeIndexInPositionList(List, int, boolean)
Computes the index in the list of positions at which a position with the given offset would be inserted. The position is supposed to become the first in this list of all positions with the same offset.- Parameters:
positions
- the list in which the index is computedoffset
- the offset for which the index is computed- Returns:
- the computed index
- See Also:
-
computeIndexInPositionList
protected int computeIndexInPositionList(List<? extends Position> positions, int offset, boolean orderedByOffset) Computes the index in the list of positions at which a position with the given position would be inserted. The position to insert is supposed to become the first in this list of all positions with the same position.- Parameters:
positions
- the list in which the index is computedoffset
- the offset for which the index is computedorderedByOffset
-true
if ordered by offset, false if ordered by end position- Returns:
- the computed index
- Since:
- 3.4
-
computeIndexInCategory
public int computeIndexInCategory(String category, int offset) throws BadLocationException, BadPositionCategoryException Description copied from interface:IDocument
Computes the index at which aPosition
with the specified offset would be inserted into the given category. As the ordering inside a category only depends on the offset, the index must be chosen to be the first of all positions with the same offset.- Specified by:
computeIndexInCategory
in interfaceIDocument
- Parameters:
category
- the category in which would be addedoffset
- the position offset to be considered- Returns:
- the index into the category
- Throws:
BadLocationException
- if offset is invalid in this documentBadPositionCategoryException
- if category is undefined in this document
-
fireDocumentPartitioningChanged
Deprecated.as of 2.0. UsefireDocumentPartitioningChanged(IRegion)
instead.Fires the document partitioning changed notification to all registered document partitioning listeners. Uses a robust iterator. -
fireDocumentPartitioningChanged
Deprecated.as of 3.0. UsefireDocumentPartitioningChanged(DocumentPartitioningChangedEvent)
instead.Fires the document partitioning changed notification to all registered document partitioning listeners. Uses a robust iterator.- Parameters:
region
- the region in which partitioning has changed- Since:
- 2.0
- See Also:
-
fireDocumentPartitioningChanged
Fires the document partitioning changed notification to all registered document partitioning listeners. Uses a robust iterator.- Parameters:
event
- the document partitioning changed event- Since:
- 3.0
- See Also:
-
fireDocumentAboutToBeChanged
Fires the given document event to all registers document listeners informing them about the forthcoming document manipulation. Uses a robust iterator.- Parameters:
event
- the event to be sent out
-
updateDocumentStructures
Updates document partitioning and document positions according to the specification given by the document event.- Parameters:
event
- the document event describing the change to which structures must be adapted
-
doFireDocumentChanged
Notifies all listeners about the given document change. Uses a robust iterator.Executes all registered post notification replace operation.
- Parameters:
event
- the event to be sent out.
-
doFireDocumentChanged
@Deprecated protected void doFireDocumentChanged(DocumentEvent event, boolean firePartitionChange, IRegion partitionChange) Deprecated.as of 3.0. UsedoFireDocumentChanged2(DocumentEvent)
instead; this method will be removed.Notifies all listeners about the given document change. Uses a robust iterator.Executes all registered post notification replace operation.
- Parameters:
event
- the event to be sent outfirePartitionChange
-true
if a partition change notification should be sentpartitionChange
- the region whose partitioning changed- Since:
- 2.0
-
doFireDocumentChanged2
Notifies all listeners about the given document change. Uses a robust iterator.Executes all registered post notification replace operation.
This method will be renamed to
doFireDocumentChanged
.- Parameters:
event
- the event to be sent out- Since:
- 3.0
-
fireDocumentChanged
Updates the internal document structures and informs all document listeners if listener notification has been enabled. Otherwise it remembers the event to be sent to the listeners on resume.- Parameters:
event
- the document event to be sent out
-
getChar
Description copied from interface:IDocument
Returns the character at the given document offset in this document.- Specified by:
getChar
in interfaceIDocument
- Parameters:
pos
- a document offset- Returns:
- the character at the offset
- Throws:
BadLocationException
- if the offset is invalid in this document
-
getContentType
Description copied from interface:IDocument
Returns the type of the document partition containing the given offset. This is a convenience method forgetPartition(offset).getType()
.Use
IDocumentExtension3.getContentType(String, int, boolean)
when the document supports multiple partitionings. In that case this method is equivalent to:IDocumentExtension3 extension= (IDocumentExtension3) document; return extension.getContentType(IDocumentExtension3.DEFAULT_PARTITIONING, offset, false);
- Specified by:
getContentType
in interfaceIDocument
- Parameters:
offset
- the document offset- Returns:
- the partition type
- Throws:
BadLocationException
- if offset is invalid in this document
-
getLegalContentTypes
Description copied from interface:IDocument
Returns the set of legal content types of document partitions. This set can be empty. The set can contain more content types than contained by the result ofgetPartitioning(0, getLength())
.Use
IDocumentExtension3.getLegalContentTypes(String)
when the document supports multiple partitionings. In that case this method is equivalent to:IDocumentExtension3 extension= (IDocumentExtension3) document; return extension.getLegalContentTypes(IDocumentExtension3.DEFAULT_PARTITIONING);
- Specified by:
getLegalContentTypes
in interfaceIDocument
- Returns:
- the set of legal content types
-
getLength
public int getLength()Description copied from interface:IDocument
Returns the number of characters in this document. -
getLineDelimiter
Description copied from interface:IDocument
Returns the line delimiter of that line ornull
if the line is not closed with a line delimiter.- Specified by:
getLineDelimiter
in interfaceIDocument
- Parameters:
line
- the line of interest- Returns:
- the line's delimiter or
null
if line does not have a delimiter - Throws:
BadLocationException
- if the line number is invalid in this document
-
getLegalLineDelimiters
Description copied from interface:IDocument
Returns the document's legal line delimiters.- Specified by:
getLegalLineDelimiters
in interfaceIDocument
- Returns:
- the document's legal line delimiters
-
getDefaultLineDelimiter
Description copied from interface:IDocumentExtension4
Returns this document's default line delimiter.This default line delimiter should be used by clients who want unique delimiters (e.g. 'CR's) in the document.
- Specified by:
getDefaultLineDelimiter
in interfaceIDocumentExtension4
- Returns:
- the default line delimiter or
null
if none
-
setInitialLineDelimiter
Description copied from interface:IDocumentExtension4
Sets this document's initial line delimiter i.e. the one which is returned bygetDefaultLineDelimiter
if the document does not yet contain any line delimiter.- Specified by:
setInitialLineDelimiter
in interfaceIDocumentExtension4
- Parameters:
lineDelimiter
- the default line delimiter
-
getLineLength
Description copied from interface:IDocument
Returns the length of the given line including the line's delimiter.- Specified by:
getLineLength
in interfaceIDocument
- Parameters:
line
- the line of interest- Returns:
- the length of the line
- Throws:
BadLocationException
- if the line number is invalid in this document
-
getLineOfOffset
Description copied from interface:IDocument
Returns the number of the line at which the character of the specified position is located. The first line has the line number 0. A new line starts directly after a line delimiter.(offset == document length)
is a valid argument although there is no corresponding character.- Specified by:
getLineOfOffset
in interfaceIDocument
- Parameters:
pos
- the document offset- Returns:
- the number of the line
- Throws:
BadLocationException
- if the offset is invalid in this document
-
getLineOffset
Description copied from interface:IDocument
Determines the offset of the first character of the given line.- Specified by:
getLineOffset
in interfaceIDocument
- Parameters:
line
- the line of interest- Returns:
- the document offset
- Throws:
BadLocationException
- if the line number is invalid in this document
-
getLineInformation
Description copied from interface:IDocument
Returns a description of the specified line. The line is described by its offset and its length excluding the line's delimiter.- Specified by:
getLineInformation
in interfaceIDocument
- Parameters:
line
- the line of interest- Returns:
- a line description
- Throws:
BadLocationException
- if the line number is invalid in this document
-
getLineInformationOfOffset
Description copied from interface:IDocument
Returns a description of the line at the given offset. The description contains the offset and the length of the line excluding the line's delimiter.- Specified by:
getLineInformationOfOffset
in interfaceIDocument
- Parameters:
offset
- the offset whose line should be described- Returns:
- a region describing the line
- Throws:
BadLocationException
- if offset is invalid in this document
-
getNumberOfLines
public int getNumberOfLines()Description copied from interface:IDocument
Returns the number of lines in this document.Note that a document always has at least one line.
- Specified by:
getNumberOfLines
in interfaceIDocument
- Returns:
- the number of lines in this document.
-
getNumberOfLines
Description copied from interface:IDocument
Returns the number of lines which are occupied by a given text range.- Specified by:
getNumberOfLines
in interfaceIDocument
- Parameters:
offset
- the offset of the specified text rangelength
- the length of the specified text range- Returns:
- the number of lines occupied by the specified range
- Throws:
BadLocationException
- if specified range is invalid in this tracker
-
computeNumberOfLines
Description copied from interface:IDocument
Computes the number of lines in the given text. For a given implementer of this interface this method returns the same result asset(text); getNumberOfLines()
.- Specified by:
computeNumberOfLines
in interfaceIDocument
- Parameters:
text
- the text whose number of lines should be computed- Returns:
- the number of lines in the given text
-
getPartition
Description copied from interface:IDocument
Returns the document partition in which the position is located.Use
IDocumentExtension3.getPartition(String, int, boolean)
when the document supports multiple partitionings. In that case this method is equivalent:IDocumentExtension3 extension= (IDocumentExtension3) document; return extension.getPartition(IDocumentExtension3.DEFAULT_PARTITIONING, offset, false);
- Specified by:
getPartition
in interfaceIDocument
- Parameters:
offset
- the document offset- Returns:
- a specification of the partition
- Throws:
BadLocationException
- if offset is invalid in this document
-
computePartitioning
Description copied from interface:IDocument
Computes the partitioning of the given document range using the document's partitioner.Use
IDocumentExtension3.computePartitioning(String, int, int, boolean)
when the document supports multiple partitionings. In that case this method is equivalent:IDocumentExtension3 extension= (IDocumentExtension3) document; return extension.computePartitioning(IDocumentExtension3.DEFAULT_PARTITIONING, offset, length, false);
- Specified by:
computePartitioning
in interfaceIDocument
- Parameters:
offset
- the document offset at which the range startslength
- the length of the document range- Returns:
- a specification of the range's partitioning
- Throws:
BadLocationException
- if the range is invalid in this document
-
getPositions
Description copied from interface:IDocument
Returns all positions of the given position category. The positions are ordered according to the category's order. Manipulating this list does not affect the document, but manipulating the position does affect the document.- Specified by:
getPositions
in interfaceIDocument
- Parameters:
category
- the category- Returns:
- the list of all positions
- Throws:
BadPositionCategoryException
- if category is undefined in this document
-
getPositionCategories
Description copied from interface:IDocument
Returns all position categories of this document. This includes the default position category.- Specified by:
getPositionCategories
in interfaceIDocument
- Returns:
- the document's position categories
-
getPositionUpdaters
Description copied from interface:IDocument
Returns the list of position updaters attached to the document.- Specified by:
getPositionUpdaters
in interfaceIDocument
- Returns:
- the list of position updaters
-
get
Description copied from interface:IDocument
Returns this document's complete text. -
get
Description copied from interface:IDocument
Returns this document's text for the specified range.- Specified by:
get
in interfaceIDocument
- Parameters:
pos
- the document offsetlength
- the length of the specified range- Returns:
- the document's text for the specified range
- Throws:
BadLocationException
- if the range is invalid in this document
-
insertPositionUpdater
Description copied from interface:IDocument
Inserts the position updater at the specified index in the document's list of position updaters. Positions updaters may be inserted multiple times.An
IPositionUpdater
may call back to this method when being inside a document notification.- Specified by:
insertPositionUpdater
in interfaceIDocument
- Parameters:
updater
- the updater to be insertedindex
- the index in the document's updater list
-
removePosition
Description copied from interface:IDocument
Removes the given position from the specified position category. If the position is not part of the specified category nothing happens. If the position has been added multiple times, only the first occurrence is deleted.- Specified by:
removePosition
in interfaceIDocument
- Parameters:
category
- the category from which to deleteposition
- the position to be deleted- Throws:
BadPositionCategoryException
- if category is undefined in this document
-
removePosition
Description copied from interface:IDocument
Removes the given position from the document's default position category. This is a convenience method forremovePosition(DEFAULT_CATEGORY, position)
.- Specified by:
removePosition
in interfaceIDocument
- Parameters:
position
- the position to be removed
-
removePositionCategory
Description copied from interface:IDocument
Deletes the position category from the document. All positions in this category are thus deleted as well.- Specified by:
removePositionCategory
in interfaceIDocument
- Parameters:
category
- the category to be removed- Throws:
BadPositionCategoryException
- if category is undefined in this document
-
removePositionUpdater
Description copied from interface:IDocument
Removes the position updater from the document's list of position updaters. If the position updater has multiple occurrences only the first occurrence is removed. If the position updater is not registered with this document, nothing happens.An
IPositionUpdater
may call back to this method when being inside a document notification.- Specified by:
removePositionUpdater
in interfaceIDocument
- Parameters:
updater
- the updater to be removed
-
getModificationStamp
public long getModificationStamp()Description copied from interface:IDocumentExtension4
Returns the modification stamp of this document. The modification stamp is updated each time a modifying operation is called on this document. If two modification stamps of the same document are identical then the document content is too, however, same content does not imply same modification stamp.The magnitude or sign of the numerical difference between two modification stamps is not significant.
- Specified by:
getModificationStamp
in interfaceIDocumentExtension4
- Returns:
- the modification stamp of this document or
UNKNOWN_MODIFICATION_STAMP
-
replace
public void replace(int pos, int length, String text, long modificationStamp) throws BadLocationException Description copied from interface:IDocumentExtension4
Substitutes the given text for the specified document range. Sends aDocumentEvent
to all registeredIDocumentListener
.- Specified by:
replace
in interfaceIDocumentExtension4
- Parameters:
pos
- the document offsetlength
- the length of the specified rangetext
- the substitution textmodificationStamp
- of the document after replacing- Throws:
BadLocationException
- if the offset is invalid in this document- See Also:
-
isLineInformationRepairNeeded
public boolean isLineInformationRepairNeeded(int offset, int length, String text) throws BadLocationException Tells whether the line information of the document implementing this interface needs to be repaired after replacing the given text.- Specified by:
isLineInformationRepairNeeded
in interfaceIRepairableDocumentExtension
- Parameters:
offset
- the document offsetlength
- the length of the specified rangetext
- the substitution text to check- Returns:
true
if the line information must be repaired after replacing- Throws:
BadLocationException
- if the offset is invalid in this document- Since:
- 3.4
- See Also:
-
replace
Description copied from interface:IDocument
Substitutes the given text for the specified document range. Sends aDocumentEvent
to all registeredIDocumentListener
.- Specified by:
replace
in interfaceIDocument
- Parameters:
pos
- the document offsetlength
- the length of the specified rangetext
- the substitution text- Throws:
BadLocationException
- if the offset is invalid in this document- See Also:
-
set
Description copied from interface:IDocument
Replaces the content of the document with the given text. Sends aDocumentEvent
to all registeredIDocumentListener
. This method is a convenience method forreplace(0, getLength(), text)
. -
set
Description copied from interface:IDocumentExtension4
Replaces the content of the document with the given text. Sends aDocumentEvent
to all registeredIDocumentListener
. This method is a convenience method forreplace(0, getLength(), text)
.- Specified by:
set
in interfaceIDocumentExtension4
- Parameters:
text
- the new content of the documentmodificationStamp
- of the document after setting the content- See Also:
-
updatePositions
Updates all positions of all categories to the change described by the document event. All registered document updaters are called in the sequence they have been arranged. Uses a robust iterator.- Parameters:
event
- the document event describing the change to which to adapt the positions
-
search
@Deprecated public int search(int startPosition, String findString, boolean forwardSearch, boolean caseSensitive, boolean wholeWord) throws BadLocationException Deprecated.as of 3.0 search is provided byFindReplaceDocumentAdapter
Returns the offset of a given search string in the document based on a set of search criteria.- Specified by:
search
in interfaceIDocument
- Parameters:
startPosition
- document offset at which search startsfindString
- the string to findforwardSearch
- the search directioncaseSensitive
- indicates whether lower and upper case should be distinguishedwholeWord
- indicates whether the findString should be limited by white spaces as defined by Character.isWhiteSpace- Returns:
- the offset of the first occurrence of findString based on the parameters or -1 if no match is found
- Throws:
BadLocationException
- if startOffset is an invalid document offset
-
acceptPostNotificationReplaces
public void acceptPostNotificationReplaces()Description copied from interface:IDocumentExtension2
Tells the receiver to accept calls toregisterPostNotificationReplace
untilignorePostNotificationReplaces
is called.- Specified by:
acceptPostNotificationReplaces
in interfaceIDocumentExtension2
-
ignorePostNotificationReplaces
public void ignorePostNotificationReplaces()Description copied from interface:IDocumentExtension2
Tells the receiver to ignore calls toregisterPostNotificationReplace
untilacceptPostNotificationReplaces
is called.- Specified by:
ignorePostNotificationReplaces
in interfaceIDocumentExtension2
-
registerPostNotificationReplace
public void registerPostNotificationReplace(IDocumentListener owner, IDocumentExtension.IReplace replace) Description copied from interface:IDocumentExtension
Callback for document listeners to be used insidedocumentChanged
to register a post notification replace operation on the document notifying them.- Specified by:
registerPostNotificationReplace
in interfaceIDocumentExtension
- Parameters:
owner
- the owner of the replace operationreplace
- the replace operation to be executed
-
stopPostNotificationProcessing
public void stopPostNotificationProcessing()Description copied from interface:IDocumentExtension
Stops the processing of registered post notification replace operations untilresumePostNotificationProcessing
is called.- Specified by:
stopPostNotificationProcessing
in interfaceIDocumentExtension
-
resumePostNotificationProcessing
public void resumePostNotificationProcessing()Description copied from interface:IDocumentExtension
Resumes the processing of post notification replace operations. If the queue of registeredIDocumentExtension.IReplace
objects is not empty, they are immediately processed if the document is not inside a replace operation. If the document is inside a replace operation, they are processed directly after the replace operation has finished.- Specified by:
resumePostNotificationProcessing
in interfaceIDocumentExtension
-
startSequentialRewrite
Deprecated.since 3.1. UseIDocumentExtension4.startRewriteSession(DocumentRewriteSessionType)
instead.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. Thenormalize
flag indicates whether the rewrite is performed from the start of the document to its end or from an arbitrary start offset.The document is considered being in sequential rewrite mode as long as
stopSequentialRewrite
has not been called.- Specified by:
startSequentialRewrite
in interfaceIDocumentExtension
- Parameters:
normalized
-true
if performed from the start to the end of the document- Since:
- 2.0
-
stopSequentialRewrite
Deprecated.As of 3.1, replaced byIDocumentExtension4.stopRewriteSession(DocumentRewriteSession)
Tells the document that the sequential rewrite has been finished. This method has only any effect ifstartSequentialRewrite
has been called before.- Specified by:
stopSequentialRewrite
in interfaceIDocumentExtension
- Since:
- 2.0
-
resumeListenerNotification
public void resumeListenerNotification()Description copied from interface:IDocumentExtension2
Resumes the notification of document listeners which must previously have been stopped by a call tostopListenerNotification
.- Specified by:
resumeListenerNotification
in interfaceIDocumentExtension2
-
stopListenerNotification
public void stopListenerNotification()Description copied from interface:IDocumentExtension2
Can be called prior to areplace
operation. After thereplace
resumeListenerNotification
must be called. The effect of these calls is that no document listener is notified untilresumeListenerNotification
is called. This allows clients to update structure before any listener is informed about the change.Listener notification can only be stopped for a single
replace
operation. Otherwise, document change notifications will be lost.- Specified by:
stopListenerNotification
in interfaceIDocumentExtension2
-
computePartitioning
public ITypedRegion[] computePartitioning(String partitioning, int offset, int length, boolean includeZeroLengthPartitions) throws BadLocationException, BadPartitioningException Description copied from interface:IDocumentExtension3
Computes the partitioning of the given document range based on the given partitioning type.If
includeZeroLengthPartitions
istrue
, a zero-length partition of an open partition type (usually the default partition) is included between two closed partitions. If it isfalse
, no zero-length partitions are included.This is only supported if the connected
IDocumentPartitioner
supports it, i.e. implementsIDocumentPartitionerExtension2
. Otherwise,includeZeroLengthPartitions
is ignored.- Specified by:
computePartitioning
in interfaceIDocumentExtension3
- Parameters:
partitioning
- the document's partitioning typeoffset
- the document offset at which the range startslength
- the length of the document rangeincludeZeroLengthPartitions
-true
if zero-length partitions should be returned as part of the computed partitioning- Returns:
- a specification of the range's partitioning
- Throws:
BadLocationException
- if the range is invalid in this document$BadPartitioningException
- if partitioning is invalid for this document
-
getContentType
public String getContentType(String partitioning, int offset, boolean preferOpenPartitions) throws BadLocationException, BadPartitioningException Description copied from interface:IDocumentExtension3
Returns the type of the document partition containing the given offset for the given partitioning. This is a convenience method forgetPartition(partitioning, offset, boolean).getType()
.If
preferOpenPartitions
istrue
, precedence is given to an open partition ending atoffset
over a delimited partition starting atoffset
. If it isfalse
, precedence is given to the partition that does not end atoffset
.This is only supported if the connected
IDocumentPartitioner
supports it, i.e. implementsIDocumentPartitionerExtension2
. Otherwise,preferOpenPartitions
is ignored.- Specified by:
getContentType
in interfaceIDocumentExtension3
- Parameters:
partitioning
- the partitioningoffset
- the document offsetpreferOpenPartitions
-true
if precedence should be given to a open partition ending atoffset
over a closed partition starting atoffset
- Returns:
- the partition type
- Throws:
BadLocationException
- if offset is invalid in this documentBadPartitioningException
- if partitioning is invalid for this document
-
getDocumentPartitioner
Description copied from interface:IDocumentExtension3
Returns the partitioner for the given partitioning ornull
if no partitioner is registered.- Specified by:
getDocumentPartitioner
in interfaceIDocumentExtension3
- Parameters:
partitioning
- the partitioning for which to set the partitioner- Returns:
- the partitioner for the given partitioning
-
getLegalContentTypes
Description copied from interface:IDocumentExtension3
Returns the set of legal content types of document partitions for the given partitioning This set can be empty. The set can contain more content types than contained by the result ofgetPartitioning(partitioning, 0, getLength())
.- Specified by:
getLegalContentTypes
in interfaceIDocumentExtension3
- Parameters:
partitioning
- the partitioning for which to return the legal content types- Returns:
- the set of legal content types
- Throws:
BadPartitioningException
- if partitioning is invalid for this document
-
getPartition
public ITypedRegion getPartition(String partitioning, int offset, boolean preferOpenPartitions) throws BadLocationException, BadPartitioningException Description copied from interface:IDocumentExtension3
Returns the document partition of the given partitioning in which the given offset is located.If
preferOpenPartitions
istrue
, precedence is given to an open partition ending atoffset
over a delimited partition starting atoffset
. If it isfalse
, precedence is given to the partition that does not end atoffset
.This is only supported if the connected
IDocumentPartitioner
supports it, i.e. implementsIDocumentPartitionerExtension2
. Otherwise,preferOpenPartitions
is ignored.- Specified by:
getPartition
in interfaceIDocumentExtension3
- Parameters:
partitioning
- the partitioningoffset
- the document offsetpreferOpenPartitions
-true
if precedence should be given to a open partition ending atoffset
over a closed partition starting atoffset
- Returns:
- a specification of the partition
- Throws:
BadLocationException
- if offset is invalid in this documentBadPartitioningException
- if partitioning is invalid for this document
-
getPartitionings
Description copied from interface:IDocumentExtension3
Returns the existing partitionings for this document. This includes the default partitioning.- Specified by:
getPartitionings
in interfaceIDocumentExtension3
- Returns:
- the existing partitionings for this document
-
setDocumentPartitioner
Description copied from interface:IDocumentExtension3
Sets this document's partitioner. The caller of this method is responsible for disconnecting the document's old partitioner from the document and to connect the new partitioner to the document. Informs all document partitioning listeners about this change.- Specified by:
setDocumentPartitioner
in interfaceIDocumentExtension3
- Parameters:
partitioning
- the partitioning for which to set the partitionerpartitioner
- the document's new partitioner- See Also:
-
repairLineInformation
public void repairLineInformation()Description copied from interface:IRepairableDocument
Repairs the line information of the document implementing this interface.- Specified by:
repairLineInformation
in interfaceIRepairableDocument
-
fireRewriteSessionChanged
Fires the given event to all registered rewrite session listeners. Uses robust iterators.- Parameters:
event
- the event to be fired- Since:
- 3.1
-
getActiveRewriteSession
Description copied from interface:IDocumentExtension4
Returns the active rewrite session of this document ornull
.- Specified by:
getActiveRewriteSession
in interfaceIDocumentExtension4
- Returns:
- the active rewrite session or
null
-
startRewriteSession
Description copied from interface:IDocumentExtension4
Tells the document that it is about to be rewritten. That is, a sequence of replace operations that form a semantic unit will be performed on this document. A specification of the nature of the operation sequence is given in form of the session type.The document is considered being in rewrite mode as long as
stopRewriteSession
has not been called.- Specified by:
startRewriteSession
in interfaceIDocumentExtension4
- Parameters:
sessionType
- the session type- Returns:
- the started rewrite session
-
startRewriteSessionOnPartitioners
Starts the given rewrite session.- Parameters:
session
- the rewrite session- Since:
- 3.1
-
stopRewriteSession
Description copied from interface:IDocumentExtension4
Tells the document to stop the rewrite session. This method has only any effect ifstartRewriteSession
has been called before.This method does not have any effect if the given session is not the active rewrite session.
- Specified by:
stopRewriteSession
in interfaceIDocumentExtension4
- Parameters:
session
- the session to stop
-
stopRewriteSessionOnPartitioners
Stops the given rewrite session.- Parameters:
session
- the rewrite session- Since:
- 3.1
-
addDocumentRewriteSessionListener
Description copied from interface:IDocumentExtension4
Registers the document rewrite session listener with the document. After registration theIDocumentRewriteSessionListener
is informed about each state change of rewrite sessions performed on this document.If the listener is already registered nothing happens.
An
IRewriteSessionDocumentListener
may call back to this document when being inside a document notification.- Specified by:
addDocumentRewriteSessionListener
in interfaceIDocumentExtension4
- Parameters:
listener
- the listener to be registered
-
removeDocumentRewriteSessionListener
Description copied from interface:IDocumentExtension4
Removes the listener from the document's list of document rewrite session listeners. If the listener is not registered with the document nothing happens.An
IDocumentRewriteSessionListener
may call back to this document when being inside a document notification.- Specified by:
removeDocumentRewriteSessionListener
in interfaceIDocumentExtension4
- Parameters:
listener
- the listener to be removed
-
checkStateOfPartitioner
Checks the state for the given partitioner and stops the active rewrite session.- Parameters:
partitioner
- the document partitioner to be checkedpartitioning
- the document partitioning the partitioner is registered for- Since:
- 3.1
-
getPositions
public Position[] getPositions(String category, int offset, int length, boolean canStartBefore, boolean canEndAfter) throws BadPositionCategoryException Returns all positions of the given category that are inside the given region.- Parameters:
category
- the position categoryoffset
- the start position of the region, must be >= 0length
- the length of the region, must be >= 0canStartBefore
- iftrue
then positions are included which start before the region if they end at or after the regions startcanEndAfter
- iftrue
then positions are included which end after the region if they start at or before the regions end- Returns:
- all positions inside the region of the given category
- Throws:
BadPositionCategoryException
- if category is undefined in this document- Since:
- 3.4
-
computeIndexInPositionList(List, int, boolean)