Package com.intellij.openapi.editor

Interface InlayModel

All Known Implementing Classes:

InlayModelImpl

public interface InlayModel

Provides an ability to introduce custom visual elements into editor's representation. Such elements are not reflected in document contents. Elements are 'anchored' to a certain document offset at creation, this offset behaves similar to a zero-range RangeMarker with respect to document changes.

See Also:

Editor.getInlayModel()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InlayModel.ChangeFlags Flags provided by InlayModel.Listener.onUpdated(Inlay, int).
static interface	InlayModel.Listener
static class	InlayModel.SimpleAdapter An adapter useful for the cases, when the same action is to be performed after custom visual element's adding, updating and removal.

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.
default <T extends EditorCustomElementRenderer> Inlay<T>	addInlineElement(int offset, T renderer) Same as addInlineElement(int, boolean, EditorCustomElementRenderer), making created element associated with following text.
void	addListener(InlayModel.Listener listener, Disposable disposable) Adds a listener that will be notified after adding, updating and removal of custom visual elements.
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).
default <T> java.util.List<Inlay<? extends T>>	getAfterLineEndElementsInRange(int startOffset, int endOffset, java.lang.Class<T> type) Same as 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).
default <T> java.util.List<Inlay<? extends T>>	getBlockElementsInRange(int startOffset, int endOffset, java.lang.Class<T> type) Same as 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.
default <T> Inlay<? extends T>	getElementAt(java.awt.Point point, java.lang.Class<T> type) Return a custom visual element with renderer of given type at given coordinates in editor's coordinate space, or null if there's no such element at given point.
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).
default <T> java.util.List<Inlay<? extends T>>	getInlineElementsInRange(int startOffset, int endOffset, java.lang.Class<T> type) Same as getInlineElementsInRange(int, int), but returned list contains only inlays with renderer of given type.
default 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.
default boolean	hasInlineElementAt(VisualPosition visualPosition) Tells whether there exists an inline visual element at a given visual position.
default boolean	hasInlineElements() Tells whether there exists at least one inline element currently.
default 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.

Method Detail

addInlineElement

default <T extends EditorCustomElementRenderer> Inlay<T> addInlineElement(int offset,
                                                                          T renderer)

Same as addInlineElement(int, boolean, EditorCustomElementRenderer), making created element associated with following text.

addInlineElement

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

Parameters:

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

<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. This element will be displayed between lines of text.

Parameters:

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

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

Parameters:

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

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

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.

getInlineElementsInRange

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

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

getBlockElementsInRange

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). Both visible and invisible (due to folding) elements are returned.

getBlockElementsInRange

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

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

getBlockElementsForVisualLine

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). Only visible (not folded) elements are returned.

hasBlockElements

default boolean hasBlockElements()

Tells whether there exists at least one block element currently.

hasInlineElementsInRange

default boolean hasInlineElementsInRange(int startOffset,
                                         int endOffset)

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

hasInlineElements

default boolean hasInlineElements()

Tells whether there exists at least one inline element currently.

hasInlineElementAt

boolean hasInlineElementAt(int offset)

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

hasInlineElementAt

default boolean hasInlineElementAt(VisualPosition visualPosition)

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

getInlineElementAt

Inlay getInlineElementAt(VisualPosition visualPosition)

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

getElementAt

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.

getElementAt

default <T> Inlay<? extends T> getElementAt(java.awt.Point point,
                                            java.lang.Class<T> type)

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

getAfterLineEndElementsInRange

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). Returned list is sorted by offset. Both visible and invisible (due to folding) elements are returned.

See Also:

addAfterLineEndElement(int, boolean, EditorCustomElementRenderer)

getAfterLineEndElementsInRange

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

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

getAfterLineEndElementsForLogicalLine

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). Elements are returned regardless of whether they are currently visible.

See Also:

addAfterLineEndElement(int, boolean, EditorCustomElementRenderer)

setConsiderCaretPositionOnDocumentUpdates

void setConsiderCaretPositionOnDocumentUpdates(boolean enabled)

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.

execute

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

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.

Parameters:

batchMode - whether to enable batch mode for executed inlay operations

isInBatchMode

boolean isInBatchMode()

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

See Also:

execute(boolean, Runnable)

addListener

void addListener(InlayModel.Listener listener,
                 Disposable disposable)

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