Package com.intellij.openapi.editor.impl

Class InlayModelImpl

java.lang.Object

com.intellij.openapi.editor.impl.InlayModelImpl

All Implemented Interfaces:

Dumpable, Disposable, DocumentListener, PrioritizedDocumentListener, InlayModel, java.util.EventListener

public class InlayModelImpl
extends java.lang.Object
implements InlayModel, PrioritizedDocumentListener, Disposable, Dumpable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.editor.InlayModel

InlayModel.ChangeFlags, InlayModel.Listener, InlayModel.SimpleAdapter

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from interface com.intellij.openapi.editor.ex.PrioritizedDocumentListener

COMPARATOR

Fields inherited from interface com.intellij.openapi.editor.event.DocumentListener

ARRAY_FACTORY, EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
<T extends EditorCustomElementRenderer> Inlay<T>	addAfterLineEndElement(int offset, boolean relatesToPrecedingText, T renderer) Introduces a visual element, which will be displayed after the end of corresponding logical line.
<T extends EditorCustomElementRenderer> Inlay<T>	addBlockElement(int offset, boolean relatesToPrecedingText, boolean showAbove, int priority, T renderer) Introduces a 'block' visual element at a given offset, its size and appearance is defined by the provided renderer.
<T extends EditorCustomElementRenderer> Inlay<T>	addInlineElement(int offset, boolean relatesToPrecedingText, T renderer) Introduces an inline visual element at a given offset, its width and appearance is defined by the provided renderer.
void	addListener(InlayModel.Listener listener, Disposable disposable) Adds a listener that will be notified after adding, updating and removal of custom visual elements.
void	beforeDocumentChange(DocumentEvent event) Called before the text of the document is changed.
void	dispose() Usually not invoked directly, see class javadoc.
void	documentChanged(DocumentEvent event) Called after the text of the document has been changed.
java.lang.String	dumpState()
void	execute(boolean batchMode, java.lang.Runnable operation) Allows to perform a group of inlay operations (adding, disposing, updating) in a batch mode.
java.util.List<Inlay>	getAfterLineEndElementsForLogicalLine(int logicalLine) Returns after-line-end elements for a given logical line, in creation order (this is the order they are displayed in).
java.util.List<Inlay>	getAfterLineEndElementsInRange(int startOffset, int endOffset) Returns a list of after-line-end elements for a given offset range (both limits are inclusive).
<T> java.util.List<Inlay<? extends T>>	getAfterLineEndElementsInRange(int startOffset, int endOffset, java.lang.Class<T> type) Same as InlayModel.getAfterLineEndElementsInRange(int, int), but returned list contains only inlays with renderer of given type.
java.util.List<Inlay>	getBlockElementsForVisualLine(int visualLine, boolean above) Returns a list of block elements displayed for a given visual line in appearance order (top to bottom).
java.util.List<Inlay>	getBlockElementsInRange(int startOffset, int endOffset) Returns a list of block elements for a given offset range (both limits are inclusive) in priority order (higher priority ones appear first).
<T> java.util.List<Inlay<? extends T>>	getBlockElementsInRange(int startOffset, int endOffset, java.lang.Class<T> type) Same as InlayModel.getBlockElementsInRange(int, int), but returned list contains only inlays with renderer of given type.
Inlay	getElementAt(java.awt.Point point) Return a custom visual element at given coordinates in editor's coordinate space, or null if there's no element at given point.
int	getHeightOfBlockElementsBeforeVisualLine(int visualLine)
Inlay	getInlineElementAt(VisualPosition visualPosition) Return a custom visual element at at a given visual position.
java.util.List<Inlay>	getInlineElementsInRange(int startOffset, int endOffset) Returns a list of inline elements for a given offset range (both limits are inclusive).
<T> java.util.List<Inlay<? extends T>>	getInlineElementsInRange(int startOffset, int endOffset, java.lang.Class<T> type) Same as InlayModel.getInlineElementsInRange(int, int), but returned list contains only inlays with renderer of given type.
int	getPriority()
boolean	hasAfterLineEndElements()
boolean	hasBlockElements() Tells whether there exists at least one block element currently.
boolean	hasInlineElementAt(int offset) Tells whether there exists an inline visual element at a given offset.
boolean	hasInlineElementAt(VisualPosition visualPosition) Tells whether there exists an inline visual element at a given visual position.
boolean	hasInlineElements() Tells whether there exists at least one inline element currently.
boolean	hasInlineElementsInRange(int startOffset, int endOffset) Tells whether given range of offsets (both sides inclusive) contains at least one inline element.
boolean	isInBatchMode() Tells whether the current code is executing as part of a batch inlay update operation.
void	setConsiderCaretPositionOnDocumentUpdates(boolean enabled) When text is inserted at inline element's offset, resulting element's position is determined by its Inlay.isRelatedToPrecedingText() property.
void	validateState()

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.InlayModel

addInlineElement, getElementAt

Methods inherited from interface com.intellij.openapi.editor.event.DocumentListener

bulkUpdateFinished, bulkUpdateStarting

Method Detail

getPriority

public int getPriority()

Specified by:

getPriority in interface PrioritizedDocumentListener

beforeDocumentChange

public void beforeDocumentChange(DocumentEvent event)

Description copied from interface: DocumentListener

Called before the text of the document is changed.

Specified by:

beforeDocumentChange in interface DocumentListener

Parameters:

event - the event containing the information about the change.

documentChanged

public void documentChanged(DocumentEvent event)

Description copied from interface: DocumentListener

Called after the text of the document has been changed.

Specified by:

documentChanged in interface DocumentListener

Parameters:

event - the event containing the information about the change.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

addInlineElement

public <T extends EditorCustomElementRenderer> Inlay<T> addInlineElement(int offset,
                                                                         boolean relatesToPrecedingText,
                                                                         T renderer)

Description copied from interface: InlayModel

Introduces an inline visual element at a given offset, its width and appearance is defined by the provided renderer.

Specified by:

addInlineElement in interface InlayModel

relatesToPrecedingText - whether element is associated with preceding or following text (see Inlay.isRelatedToPrecedingText())

Returns:

null if requested element cannot be created, e.g. if corresponding functionality is not supported by current editor instance.

addBlockElement

public <T extends EditorCustomElementRenderer> Inlay<T> addBlockElement(int offset,
                                                                        boolean relatesToPrecedingText,
                                                                        boolean showAbove,
                                                                        int priority,
                                                                        T renderer)

Description copied from interface: InlayModel

Introduces a 'block' visual element at a given offset, its size and appearance is defined by the provided renderer. This element will be displayed between lines of text.

Specified by:

addBlockElement in interface InlayModel

relatesToPrecedingText - whether element is associated with preceding or following text (see Inlay.isRelatedToPrecedingText())

showAbove - whether element will be displayed above or below corresponding visual line

priority - if multiple elements are requested to be displayed for the same visual line, this parameter defines the relative positioning of such elements (larger priority value means the element will be rendered closer to the text)

Returns:

null if requested element cannot be created, e.g. if corresponding functionality is not supported by current editor instance.

See Also:

BlockInlayPriority

addAfterLineEndElement

public <T extends EditorCustomElementRenderer> Inlay<T> addAfterLineEndElement(int offset,
                                                                               boolean relatesToPrecedingText,
                                                                               T renderer)

Description copied from interface: InlayModel

Introduces a visual element, which will be displayed after the end of corresponding logical line.

Specified by:

addAfterLineEndElement in interface InlayModel

relatesToPrecedingText - whether element is associated with preceding or following text (see Inlay.isRelatedToPrecedingText())

Returns:

null if requested element cannot be created, e.g. if corresponding functionality is not supported by current editor instance.

getInlineElementsInRange

public java.util.List<Inlay> getInlineElementsInRange(int startOffset,
                                                      int endOffset)

Description copied from interface: InlayModel

Returns a list of inline elements for a given offset range (both limits are inclusive). Returned list is sorted by offset. Both visible and invisible (due to folding) elements are returned.

Specified by:

getInlineElementsInRange in interface InlayModel

getInlineElementsInRange

public <T> java.util.List<Inlay<? extends T>> getInlineElementsInRange(int startOffset,
                                                                       int endOffset,
                                                                       java.lang.Class<T> type)

Description copied from interface: InlayModel

Same as InlayModel.getInlineElementsInRange(int, int), but returned list contains only inlays with renderer of given type.

Specified by:

getInlineElementsInRange in interface InlayModel

getBlockElementsInRange

public java.util.List<Inlay> getBlockElementsInRange(int startOffset,
                                                     int endOffset)

Description copied from interface: InlayModel

Returns a list of block elements for a given offset range (both limits are inclusive) in priority order (higher priority ones appear first). Both visible and invisible (due to folding) elements are returned.

Specified by:

getBlockElementsInRange in interface InlayModel

getBlockElementsInRange

public <T> java.util.List<Inlay<? extends T>> getBlockElementsInRange(int startOffset,
                                                                      int endOffset,
                                                                      java.lang.Class<T> type)

Description copied from interface: InlayModel

Same as InlayModel.getBlockElementsInRange(int, int), but returned list contains only inlays with renderer of given type.

Specified by:

getBlockElementsInRange in interface InlayModel

getBlockElementsForVisualLine

public java.util.List<Inlay> getBlockElementsForVisualLine(int visualLine,
                                                           boolean above)

Description copied from interface: InlayModel

Returns a list of block elements displayed for a given visual line in appearance order (top to bottom). Only visible (not folded) elements are returned.

Specified by:

getBlockElementsForVisualLine in interface InlayModel

getHeightOfBlockElementsBeforeVisualLine

public int getHeightOfBlockElementsBeforeVisualLine(int visualLine)

hasBlockElements

public boolean hasBlockElements()

Description copied from interface: InlayModel

Tells whether there exists at least one block element currently.

Specified by:

hasBlockElements in interface InlayModel

hasInlineElementsInRange

public boolean hasInlineElementsInRange(int startOffset,
                                        int endOffset)

Description copied from interface: InlayModel

Tells whether given range of offsets (both sides inclusive) contains at least one inline element.

Specified by:

hasInlineElementsInRange in interface InlayModel

hasInlineElements

public boolean hasInlineElements()

Description copied from interface: InlayModel

Tells whether there exists at least one inline element currently.

Specified by:

hasInlineElements in interface InlayModel

hasInlineElementAt

public boolean hasInlineElementAt(int offset)

Description copied from interface: InlayModel

Tells whether there exists an inline visual element at a given offset.

Specified by:

hasInlineElementAt in interface InlayModel

hasInlineElementAt

public boolean hasInlineElementAt(VisualPosition visualPosition)

Description copied from interface: InlayModel

Tells whether there exists an inline visual element at a given visual position. Only visual position to the left of the element is recognized.

Specified by:

hasInlineElementAt in interface InlayModel

getInlineElementAt

public Inlay getInlineElementAt(VisualPosition visualPosition)

Description copied from interface: InlayModel

Return a custom visual element at at a given visual position. Only visual position to the left of the element is recognized.

Specified by:

getInlineElementAt in interface InlayModel

getElementAt

public Inlay getElementAt(java.awt.Point point)

Description copied from interface: InlayModel

Return a custom visual element at given coordinates in editor's coordinate space, or null if there's no element at given point.

Specified by:

getElementAt in interface InlayModel

getAfterLineEndElementsInRange

public java.util.List<Inlay> getAfterLineEndElementsInRange(int startOffset,
                                                            int endOffset)

Description copied from interface: InlayModel

Returns a list of after-line-end elements for a given offset range (both limits are inclusive). Returned list is sorted by offset. Both visible and invisible (due to folding) elements are returned.

Specified by:

getAfterLineEndElementsInRange in interface InlayModel

See Also:

InlayModel.addAfterLineEndElement(int, boolean, EditorCustomElementRenderer)

getAfterLineEndElementsInRange

public <T> java.util.List<Inlay<? extends T>> getAfterLineEndElementsInRange(int startOffset,
                                                                             int endOffset,
                                                                             java.lang.Class<T> type)

Description copied from interface: InlayModel

Same as InlayModel.getAfterLineEndElementsInRange(int, int), but returned list contains only inlays with renderer of given type.

Specified by:

getAfterLineEndElementsInRange in interface InlayModel

getAfterLineEndElementsForLogicalLine

public java.util.List<Inlay> getAfterLineEndElementsForLogicalLine(int logicalLine)

Description copied from interface: InlayModel

Returns after-line-end elements for a given logical line, in creation order (this is the order they are displayed in). Elements are returned regardless of whether they are currently visible.

Specified by:

getAfterLineEndElementsForLogicalLine in interface InlayModel

See Also:

InlayModel.addAfterLineEndElement(int, boolean, EditorCustomElementRenderer)

hasAfterLineEndElements

public boolean hasAfterLineEndElements()

setConsiderCaretPositionOnDocumentUpdates

public void setConsiderCaretPositionOnDocumentUpdates(boolean enabled)

Description copied from interface: InlayModel

When text is inserted at inline element's offset, resulting element's position is determined by its Inlay.isRelatedToPrecedingText() property. But to enable natural editing experience around inline elements (so that typed text appears at caret visual position), caret position is also taken into account at document insertion. This method allows to disable accounting for caret position, and can be useful for document modifications which don't originate directly from user actions.

Specified by:

setConsiderCaretPositionOnDocumentUpdates in interface InlayModel

execute

public void execute(boolean batchMode,
                    java.lang.Runnable operation)

Description copied from interface: InlayModel

Allows to perform a group of inlay operations (adding, disposing, updating) in a batch mode. For large number of operations, this decreases the total time taken by the operations. Batch mode introduces an additional overhead though (roughly proportional to the file size), so for a small number of operations in a big file, using it will result in the larger total execution time. Using batch mode can also change certain outcomes of the applied changes. In particular, resulting caret's visual position might be different in batch mode (due to simplified update logic), if inlays are added or removed at caret offset. The number of changes which justifies using batch mode can be determined empirically, but usually it's around hundred(s).

Executed code should not perform document- or editor-related operations other than those operating on inlays. In particular, modifying document, querying or updating folding, soft-wrap or caret state, as well as performing editor coordinate transformations (e.g. visual to logical position conversions) might lead to incorrect results or throw an exception.

Specified by:

execute in interface InlayModel

Parameters:

batchMode - whether to enable batch mode for executed inlay operations

isInBatchMode

public boolean isInBatchMode()

Description copied from interface: InlayModel

Tells whether the current code is executing as part of a batch inlay update operation.

Specified by:

isInBatchMode in interface InlayModel

See Also:

InlayModel.execute(boolean, Runnable)

addListener

public void addListener(InlayModel.Listener listener,
                        Disposable disposable)

Description copied from interface: InlayModel

Adds a listener that will be notified after adding, updating and removal of custom visual elements.

Specified by:

addListener in interface InlayModel

validateState

public void validateState()

dumpState

public java.lang.String dumpState()

Specified by:

dumpState in interface Dumpable