Package com.intellij.openapi.editor.impl

Class EditorTextFieldRendererDocument

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.editor.impl.EditorTextFieldRendererDocument

All Implemented Interfaces:

Document, DocumentEx, UserDataHolder, UserDataHolderEx

public class EditorTextFieldRendererDocument
extends UserDataHolderBase
implements DocumentEx

Read-only document optimized for rendering of millions of EditorTextFields. The only mutating method is setText() which is extremely cheap.

Field Summary

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

EMPTY_ARRAY, PROP_WRITABLE

Constructor Summary

Constructors

Constructor and Description
EditorTextFieldRendererDocument()

Method Summary

Modifier and Type	Method and Description
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.
char []	getChars()
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	getLineStartOffset(int line) Returns the start offset for the line with the specified number.
long	getModificationStamp() Gets the modification stamp value.
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
void	registerRangeMarker(RangeMarkerEx rangeMarker, int start, int end, boolean greedyToLeft, boolean greedyToRight, int layer)
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	setText(java.lang.CharSequence text)

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

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

addEditReadOnlyListener, clearLineModificationFlags, getGuardedBlocks, getModificationSequence, isInEventsHandling, moveText, removeEditReadOnlyListener, setStripTrailingSpacesEnabled, suppressGuardedExceptions, unSuppressGuardedExceptions

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

addDocumentListener, addDocumentListener, addPropertyChangeListener, createRangeMarker, createRangeMarker, fireReadOnlyModificationAttempt, getCharsSequence, getLineSeparatorLength, getOffsetGuard, getRangeGuard, getText, getText, getTextLength, isInBulkUpdate, isLineModified, removeDocumentListener, removeGuardedBlock, removePropertyChangeListener, setCyclicBufferSize, setInBulkUpdate, setReadOnly, startGuardedBlockChecking, stopGuardedBlockChecking

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Constructor Detail

EditorTextFieldRendererDocument

public EditorTextFieldRendererDocument()

Method Detail

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

setText

public void setText(java.lang.CharSequence text)

Specified by:

setText in interface Document

createLineIterator

public LineIterator createLineIterator()

Specified by:

createLineIterator 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

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

getChars

public char [] getChars()

Specified by:

getChars in interface Document

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.

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)