Package com.intellij.openapi.editor.impl

Class FrozenDocument

java.lang.Object

com.intellij.openapi.editor.impl.FrozenDocument

All Implemented Interfaces:

Document, DocumentEx, UserDataHolder

public class FrozenDocument
extends java.lang.Object
implements DocumentEx

Field Summary

Fields inherited from interface com.intellij.openapi.editor.Document

EMPTY_ARRAY, PROP_WRITABLE

Method Summary

Modifier and Type	Method and Description
FrozenDocument	applyEvent(DocumentEvent event, int newStamp)
void	clearLineModificationFlags()
RangeMarker	createGuardedBlock(int startOffset, int endOffset) Marks a range of text in the document as read-only (attempts to modify text in the range cause ReadOnlyFragmentModificationException to be thrown).
LineIterator	createLineIterator()
RangeMarker	createRangeMarker(int startOffset, int endOffset, boolean surviveOnExternalChange) Creates a range marker which points to the specified range of text in the document and is automatically adjusted when the document text is changed.
void	deleteString(int startOffset, int endOffset) Deletes the specified range of text from the document.
java.lang.CharSequence	getCharsSequence() Use this method instead of Document.getText() if you do not need to create a copy of the content.
java.lang.CharSequence	getImmutableCharSequence()
int	getLineCount() Returns the number of lines in the document.
int	getLineEndOffset(int line) Returns the end offset for the line with the specified number.
int	getLineNumber(int offset) Returns the line number (0-based) corresponding to the specified offset in the document.
int	getLineSeparatorLength(int line)
int	getLineStartOffset(int line) Returns the start offset for the line with the specified number.
long	getModificationStamp() Gets the modification stamp value.
RangeMarker	getOffsetGuard(int offset) Returns the read-only marker covering the specified offset in the document.
RangeMarker	getRangeGuard(int start, int end) Returns the read-only marker covering the specified range in the document.
java.lang.String	getText() Retrieves a copy of the document content.
java.lang.String	getText(TextRange range)
<T> T	getUserData(Key<T> key)
void	insertString(int offset, java.lang.CharSequence s) Inserts the specified text at the specified offset in the document.
boolean	isWritable() Checks if the document text is read-only.
boolean	processRangeMarkers(Processor<? super RangeMarker> processor) Get all range markers and hand them to the processor in their RangeMarker.getStartOffset() order
boolean	processRangeMarkersOverlappingWith(int start, int end, Processor<? super RangeMarker> processor) Get range markers which TextRange.intersects(int, int) the specified range and hand them to the processor in their RangeMarker.getStartOffset() order
<T> void	putUserData(Key<T> key, T value) Add a new user data value to this object.
void	registerRangeMarker(RangeMarkerEx rangeMarker, int start, int end, boolean greedyToLeft, boolean greedyToRight, int layer)
void	removeEditReadOnlyListener(EditReadOnlyListener listener)
void	removeGuardedBlock(RangeMarker block) Removes a marker marking a range of text in the document as read-only.
boolean	removeRangeMarker(RangeMarkerEx rangeMarker)
void	replaceString(int startOffset, int endOffset, java.lang.CharSequence s) Replaces the specified range of text in the document with the specified string.
void	replaceText(java.lang.CharSequence chars, long newModificationStamp)
void	setModificationStamp(long modificationStamp)
void	setReadOnly(boolean isReadOnly) Marks the document as read-only or read/write.
void	setStripTrailingSpacesEnabled(boolean isEnabled)
void	setText(java.lang.CharSequence text)
void	startGuardedBlockChecking() Enables checking for read-only markers when the document is modified.
void	stopGuardedBlockChecking() Disables checking for read-only markers when the document is modified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.openapi.editor.ex.DocumentEx

addEditReadOnlyListener, getGuardedBlocks, getModificationSequence, isInEventsHandling, moveText, suppressGuardedExceptions, unSuppressGuardedExceptions

Methods inherited from interface com.intellij.openapi.editor.Document

addDocumentListener, addDocumentListener, addPropertyChangeListener, createRangeMarker, createRangeMarker, fireReadOnlyModificationAttempt, getChars, getTextLength, isInBulkUpdate, isLineModified, removeDocumentListener, removePropertyChangeListener, setCyclicBufferSize, setInBulkUpdate

Method Detail

applyEvent

public FrozenDocument applyEvent(DocumentEvent event,
                                 int newStamp)

createLineIterator

public LineIterator createLineIterator()

Specified by:

createLineIterator in interface DocumentEx

setModificationStamp

public void setModificationStamp(long modificationStamp)

Specified by:

setModificationStamp in interface DocumentEx

replaceText

public void replaceText(java.lang.CharSequence chars,
                        long newModificationStamp)

Specified by:

replaceText in interface DocumentEx

clearLineModificationFlags

public void clearLineModificationFlags()

Specified by:

clearLineModificationFlags in interface DocumentEx

removeRangeMarker

public boolean removeRangeMarker(RangeMarkerEx rangeMarker)

Specified by:

removeRangeMarker in interface DocumentEx

registerRangeMarker

public void registerRangeMarker(RangeMarkerEx rangeMarker,
                                int start,
                                int end,
                                boolean greedyToLeft,
                                boolean greedyToRight,
                                int layer)

Specified by:

registerRangeMarker in interface DocumentEx

processRangeMarkers

public boolean processRangeMarkers(Processor<? super RangeMarker> processor)

Description copied from interface: DocumentEx

Get all range markers and hand them to the processor in their RangeMarker.getStartOffset() order

Specified by:

processRangeMarkers in interface DocumentEx

processRangeMarkersOverlappingWith

public boolean processRangeMarkersOverlappingWith(int start,
                                                  int end,
                                                  Processor<? super RangeMarker> processor)

Description copied from interface: DocumentEx

Get range markers which TextRange.intersects(int, int) the specified range and hand them to the processor in their RangeMarker.getStartOffset() order

Specified by:

processRangeMarkersOverlappingWith in interface DocumentEx

getText

public java.lang.String getText()

Description copied from interface: Document

Retrieves a copy of the document content. For obvious performance reasons use Document.getCharsSequence() whenever it's possible.

Specified by:

getText in interface Document

Returns:

document content.

getText

public java.lang.String getText(TextRange range)

Specified by:

getText in interface Document

getCharsSequence

public java.lang.CharSequence getCharsSequence()

Description copied from interface: Document

Use this method instead of Document.getText() if you do not need to create a copy of the content. Content represented by returned CharSequence is subject to change whenever document is modified via delete/replace/insertString method calls. It is necessary to obtain Application.runWriteAction() to modify content of the document though so threading issues won't arise.

Specified by:

getCharsSequence in interface Document

Returns:

inplace document content.

See Also:

Document.getTextLength()

getImmutableCharSequence

public java.lang.CharSequence getImmutableCharSequence()

Specified by:

getImmutableCharSequence in interface Document

Returns:

a char sequence representing document content that's guaranteed to be immutable. No read- or write-action is necessary.

See Also:

ImmutableCharSequence

getLineCount

public int getLineCount()

Description copied from interface: Document

Returns the number of lines in the document.

Specified by:

getLineCount in interface Document

Returns:

the number of lines in the document.

getLineNumber

public int getLineNumber(int offset)

Description copied from interface: Document

Returns the line number (0-based) corresponding to the specified offset in the document.

Specified by:

getLineNumber in interface Document

Parameters:

offset - the offset to get the line number for (must be in the range from 0 to getTextLength()-1)

Returns:

the line number corresponding to the offset.

getLineStartOffset

public int getLineStartOffset(int line)

Description copied from interface: Document

Returns the start offset for the line with the specified number.

Specified by:

getLineStartOffset in interface Document

Parameters:

line - the line number (from 0 to getLineCount()-1)

Returns:

the start offset for the line.

getLineEndOffset

public int getLineEndOffset(int line)

Description copied from interface: Document

Returns the end offset for the line with the specified number.

Specified by:

getLineEndOffset in interface Document

Parameters:

line - the line number (from 0 to getLineCount()-1)

Returns:

the end offset for the line.

insertString

public void insertString(int offset,
                         java.lang.CharSequence s)

Description copied from interface: Document

Inserts the specified text at the specified offset in the document. Line breaks in the inserted text must be normalized as \n.

Specified by:

insertString in interface Document

Parameters:

offset - the offset to insert the text at.

s - the text to insert.

deleteString

public void deleteString(int startOffset,
                         int endOffset)

Description copied from interface: Document

Deletes the specified range of text from the document.

Specified by:

deleteString in interface Document

Parameters:

startOffset - the start offset of the range to delete.

endOffset - the end offset of the range to delete.

replaceString

public void replaceString(int startOffset,
                          int endOffset,
                          java.lang.CharSequence s)

Description copied from interface: Document

Replaces the specified range of text in the document with the specified string. Line breaks in the text to replace with must be normalized as \n.

Specified by:

replaceString in interface Document

Parameters:

startOffset - the start offset of the range to replace.

endOffset - the end offset of the range to replace.

s - the text to replace with.

isWritable

public boolean isWritable()

Description copied from interface: Document

Checks if the document text is read-only.

Specified by:

isWritable in interface Document

Returns:

true if the document text is writable, false if it is read-only.

See Also:

Document.fireReadOnlyModificationAttempt()

getModificationStamp

public long getModificationStamp()

Description copied from interface: Document

Gets the modification stamp value. Modification stamp is a value changed by any modification of the content of the file. Note that it is not related to the file modification time.

Specified by:

getModificationStamp in interface Document

Returns:

the modification stamp value.

See Also:

PsiFile.getModificationStamp(), VirtualFile.getModificationStamp()

createRangeMarker

public RangeMarker createRangeMarker(int startOffset,
                                     int endOffset,
                                     boolean surviveOnExternalChange)

Description copied from interface: Document

Creates a range marker which points to the specified range of text in the document and is automatically adjusted when the document text is changed. The marker is optionally invalidated by external changes to the document text (for example, reloading the file from disk).

Specified by:

createRangeMarker in interface Document

Parameters:

startOffset - the start offset for the range of text covered by the marker.

endOffset - the end offset for the range of text covered by the marker.

surviveOnExternalChange - if true, the marker is not invalidated by external changes.

Returns:

the marker instance.

setReadOnly

public void setReadOnly(boolean isReadOnly)

Description copied from interface: Document

Marks the document as read-only or read/write. This method only modifies the flag stored in the document instance - no checkouts or file changes are performed.

Specified by:

setReadOnly in interface Document

Parameters:

isReadOnly - the new value of the read-only flag.

See Also:

Document.isWritable(), Document.fireReadOnlyModificationAttempt()

createGuardedBlock

public RangeMarker createGuardedBlock(int startOffset,
                                      int endOffset)

Description copied from interface: Document

Marks a range of text in the document as read-only (attempts to modify text in the range cause ReadOnlyFragmentModificationException to be thrown).

Specified by:

createGuardedBlock in interface Document

Parameters:

startOffset - the start offset of the text range to mark as read-only.

endOffset - the end offset of the text range to mark as read-only.

Returns:

the marker instance.

See Also:

Document.removeGuardedBlock(RangeMarker), Document.startGuardedBlockChecking(), EditorActionManager.setReadonlyFragmentModificationHandler(com.intellij.openapi.editor.actionSystem.ReadonlyFragmentModificationHandler)

removeGuardedBlock

public void removeGuardedBlock(RangeMarker block)

Description copied from interface: Document

Removes a marker marking a range of text in the document as read-only.

Specified by:

removeGuardedBlock in interface Document

Parameters:

block - the marker to remove.

See Also:

Document.createGuardedBlock(int, int)

getOffsetGuard

public RangeMarker getOffsetGuard(int offset)

Description copied from interface: Document

Returns the read-only marker covering the specified offset in the document.

Specified by:

getOffsetGuard in interface Document

Parameters:

offset - the offset for which the marker is requested.

Returns:

the marker instance, or null if the specified offset is not covered by a read-only marker.

getRangeGuard

public RangeMarker getRangeGuard(int start,
                                 int end)

Description copied from interface: Document

Returns the read-only marker covering the specified range in the document.

Specified by:

getRangeGuard in interface Document

Parameters:

start - the start offset of the range for which the marker is requested.

end - the end offset of the range for which the marker is requested.

Returns:

the marker instance, or null if the specified range is not covered by a read-only marker.

startGuardedBlockChecking

public void startGuardedBlockChecking()

Description copied from interface: Document

Enables checking for read-only markers when the document is modified. Checking is disabled by default.

Specified by:

startGuardedBlockChecking in interface Document

See Also:

Document.createGuardedBlock(int, int), Document.stopGuardedBlockChecking()

stopGuardedBlockChecking

public void stopGuardedBlockChecking()

Description copied from interface: Document

Disables checking for read-only markers when the document is modified. Checking is disabled by default.

Specified by:

stopGuardedBlockChecking in interface Document

See Also:

Document.createGuardedBlock(int, int), Document.startGuardedBlockChecking()

setText

public void setText(java.lang.CharSequence text)

Specified by:

setText in interface Document

getLineSeparatorLength

public int getLineSeparatorLength(int line)

Specified by:

getLineSeparatorLength in interface Document

getUserData

public <T> T getUserData(Key<T> key)

Specified by:

getUserData in interface UserDataHolder

Returns:

a user data value associated with this object. Doesn't require read action.

putUserData

public <T> void putUserData(Key<T> key,
                            T value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder

setStripTrailingSpacesEnabled

public void setStripTrailingSpacesEnabled(boolean isEnabled)

Specified by:

setStripTrailingSpacesEnabled in interface DocumentEx

removeEditReadOnlyListener

public void removeEditReadOnlyListener(EditReadOnlyListener listener)

Specified by:

removeEditReadOnlyListener in interface DocumentEx