Package com.intellij.openapi.editor

Interface Inlay<T extends EditorCustomElementRenderer>

All Superinterfaces:

Disposable, UserDataHolder, UserDataHolderEx

public interface Inlay<T extends EditorCustomElementRenderer>
extends Disposable, UserDataHolderEx

A custom visual element displayed in editor. It is associated with a certain position in a document, but is not represented in document text in any way. Inlay's document position (offset) is updated on document changes just like for a RangeMarker. Both 'inline' (displayed within text lines) and 'block' (displayed between text lines) elements are supported.

Inlay becomes invalid on explicit disposal, or when a document range fully containing inlay's offset, is deleted.

See Also:

InlayModel

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Inlay.Placement

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

Disposable.Parent

Method Summary

Modifier and Type	Method and Description
java.awt.Rectangle	getBounds() Returns inlay element's bounds in editor coordinate system if it's visible (not folded), or null otherwise
Editor	getEditor() Returns editor, this custom visual element belongs to.
GutterIconRenderer	getGutterIconRenderer() Returns GutterIconRenderer instance defining an icon displayed in gutter, and associated actions (supported for block inlays at the moment).
int	getHeightInPixels() Returns current inlay's width.
int	getOffset() Returns current inlay's position in the document.
Inlay.Placement	getPlacement() Defines relative position of inlay element with respect to the containing text.
T	getRenderer() Returns renderer, which defines size and representation for this inlay.
VisualPosition	getVisualPosition() Returns current visual position of the inlay's left boundary.
int	getWidthInPixels() Returns current inlay's width.
boolean	isRelatedToPrecedingText() Tells whether this element is associated with preceding or following text.
boolean	isValid() Tells whether this element is valid.
void	repaint() Causes repaint of inlay in editor.
void	update() Updates inlay properties (width, height, gutter icon renderer) from inlay's renderer.
default void	updateSize() Deprecated. Use update() instead.

Methods inherited from interface com.intellij.openapi.Disposable

dispose

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

putUserDataIfAbsent, replace

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

getUserData, putUserData

Method Detail

getEditor

Editor getEditor()

Returns editor, this custom visual element belongs to.

getPlacement

Inlay.Placement getPlacement()

Defines relative position of inlay element with respect to the containing text.

isValid

boolean isValid()

Tells whether this element is valid. Inlay becomes invalid on explicit disposal, or when a document range fully containing inlay's offset, is deleted. It also becomes invalid on editor disposal.

getOffset

int getOffset()

Returns current inlay's position in the document. This position is updated on document changes just like for a RangeMarker.

isRelatedToPrecedingText

boolean isRelatedToPrecedingText()

Tells whether this element is associated with preceding or following text. This relation defines certain aspects of inlay's behaviour with respect to changes in editor, e.g. when text is inserted at inlay's position, inlay will end up before the inserted text if the returned value is false and after the text, if the returned value is true. Also, when Caret.moveToOffset(int) or similar offset-based method is invoked, and an inlay exists at the given offset, caret will be positioned to the left of inlay if returned value is true, and vice versa.

The value is determined at element's creation (see or {@link InlayModel#addBlockElement(int, boolean, boolean, EditorCustomElementRenderer)}.

getVisualPosition

VisualPosition getVisualPosition()

Returns current visual position of the inlay's left boundary. For 'block' elements, this is just a visual position associated with inlay's offset.

getBounds

java.awt.Rectangle getBounds()

Returns inlay element's bounds in editor coordinate system if it's visible (not folded), or null otherwise

getRenderer

T getRenderer()

Returns renderer, which defines size and representation for this inlay.

getWidthInPixels

int getWidthInPixels()

Returns current inlay's width. Width is defined at inlay's creation using information returned by inlay's renderer. To change width, update() method should be called.

getHeightInPixels

int getHeightInPixels()

Returns current inlay's width. Width is defined at inlay's creation using information returned by inlay's renderer. To change height (supported for 'block' elements only), update() method should be called.

getGutterIconRenderer

GutterIconRenderer getGutterIconRenderer()

Returns GutterIconRenderer instance defining an icon displayed in gutter, and associated actions (supported for block inlays at the moment). This provider is defined at inlay's creation using information returned by inlay's renderer. To change it, update() method should be called.

See Also:

EditorCustomElementRenderer.calcGutterIconRenderer(Inlay)

updateSize

@Deprecated
default void updateSize()

Deprecated. Use update() instead.

update

void update()

Updates inlay properties (width, height, gutter icon renderer) from inlay's renderer. Also, repaints the inlay.

See Also:

EditorCustomElementRenderer.calcWidthInPixels(Inlay), EditorCustomElementRenderer.calcHeightInPixels(Inlay), EditorCustomElementRenderer.calcGutterIconRenderer(Inlay), repaint()

repaint

void repaint()

Causes repaint of inlay in editor.