Package com.intellij.openapi.editor.ex

Interface EditorEx

All Superinterfaces:

Editor, UserDataHolder

All Known Implementing Classes:

EditorImpl

public interface EditorEx
extends Editor

Field Summary

Fields

Modifier and Type	Field and Description
static Key<TextRange>	LAST_PASTED_REGION
static java.lang.String	PROP_COLUMN_MODE
static java.lang.String	PROP_FONT_SIZE
static java.lang.String	PROP_INSERT_MODE
static int	VERTICAL_SCROLLBAR_LEFT
static int	VERTICAL_SCROLLBAR_RIGHT

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

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
void	addFocusListener(FocusChangeListener listener)
void	addFocusListener(FocusChangeListener listener, Disposable parentDisposable)
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener, Disposable parentDisposable)
EditorColorsScheme	createBoundColorSchemeDelegate(EditorColorsScheme customGlobalScheme) Creates color scheme delegate which is bound to current editor.
java.awt.Color	getBackgroundColor()
java.awt.Dimension	getContentSize()
java.lang.String	getContextMenuGroupId() Returns id of action group what will be used to construct context menu displayed by default editor popup handler on mouse right button's click (null value meaning no context menu).
CopyProvider	getCopyProvider()
CutProvider	getCutProvider()
DataContext	getDataContext()
DeleteProvider	getDeleteProvider()
DocumentEx	getDocument() Returns the document edited or viewed in the editor.
int	getExpectedCaretOffset()
MarkupModelEx	getFilteredDocumentMarkupModel() Returns the markup model for the underlying Document.
FoldingModelEx	getFoldingModel() Returns the folding model for the document, which can be used to add, remove, expand or collapse folded regions in the document.
EditorGutterComponentEx	getGutterComponentEx()
EditorHighlighter	getHighlighter()
MarkupModelEx	getMarkupModel() Returns the markup model for the editor.
int	getMaxWidthInRange(int startOffset, int endOffset)
PasteProvider	getPasteProvider()
javax.swing.JComponent	getPermanentHeaderComponent()
int	getPrefixTextWidthInPixels()
ScrollingModelEx	getScrollingModel() Returns the scrolling model for the document, which can be used to scroll the document and retrieve information about the current position of the scrollbars.
javax.swing.JScrollPane	getScrollPane()
SoftWrapModelEx	getSoftWrapModel() Returns the soft wrap model for the document, which can be used to get information about soft wraps registered for the editor document at the moment and provides basic management functions for them.
TextDrawingCallback	getTextDrawingCallback()
int	getVerticalScrollbarOrientation()
VirtualFile	getVirtualFile()
void	installPopupHandler(EditorPopupHandler popupHandler) Allows to override default editor's context popup logic.
boolean	isEmbeddedIntoDialogWrapper()
boolean	isPurePaintingMode()
boolean	isRendererMode()
boolean	isStickySelection() Allows to answer if 'sticky selection' is active for the current editor.
boolean	processKeyTyped(java.awt.event.KeyEvent e)
void	registerLineExtensionPainter(java.util.function.IntFunction<java.util.Collection<LineExtensionInfo>> lineExtensionPainter) Registers a function which will be applied to a line number to obtain additional text fragments.
void	registerScrollBarRepaintCallback(ButtonlessScrollBarUI.ScrollbarRepaintCallback callback) Allows to register a callback that will be called one each repaint of the editor vertical scrollbar.
void	reinitSettings()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	repaint(int startOffset, int endOffset)
void	setBackgroundColor(java.awt.Color color)
boolean	setCaretEnabled(boolean enabled)
boolean	setCaretVisible(boolean b)
void	setColorsScheme(EditorColorsScheme scheme)
void	setColumnMode(boolean val)
void	setContextMenuGroupId(java.lang.String groupId) Sets id of action group what will be used to construct context menu displayed by default editor popup handler on mouse right button's click (with null value disabling context menu).
void	setCustomCursor(java.lang.Object requestor, java.awt.Cursor cursor) If cursor parameter value is not null, sets custom cursor to editor's content component, otherwise restores default editor cursor management logic (requestor parameter value should be the same in both setting and restoring requests).
void	setEmbeddedIntoDialogWrapper(boolean b)
void	setFile(VirtualFile vFile)
void	setFontSize(int fontSize)
void	setHighlighter(EditorHighlighter highlighter)
void	setHorizontalScrollbarVisible(boolean b)
void	setInsertMode(boolean val)
void	setOneLineMode(boolean b)
void	setPermanentHeaderComponent(javax.swing.JComponent component)
void	setPlaceholder(java.lang.CharSequence text) Allows to define 'placeholder text' for the current editor, i.e.
void	setPlaceholderAttributes(TextAttributes attributes) Sets text attributes for a placeholder.
void	setPrefixTextAndAttributes(java.lang.String prefixText, TextAttributes attributes) Allows to define prefix to be displayed on every editor line and text attributes to use for its coloring.
void	setPurePaintingMode(boolean enabled) We often re-use the logic encapsulated at the editor.
void	setRendererMode(boolean isRendererMode)
void	setShowPlaceholderWhenFocused(boolean show) Controls whether 'placeholder text' is visible when editor is focused.
void	setStickySelection(boolean enable) Allows to set current sticky selection mode.
void	setVerticalScrollbarOrientation(int type)
void	setVerticalScrollbarVisible(boolean b)
void	setViewer(boolean isViewer) shouldn't be called during Document update
void	uninstallPopupHandler(EditorPopupHandler popupHandler) Removes previously installed EditorPopupHandler.

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

addEditorMouseListener, addEditorMouseListener, addEditorMouseMotionListener, addEditorMouseMotionListener, getAscent, getCaretModel, getColorsScheme, getComponent, getContentComponent, getEditorKind, getGutter, getHeaderComponent, getIndentsModel, getInlayModel, getInsets, getLineHeight, getMouseEventArea, getProject, getSelectionModel, getSettings, hasHeaderComponent, isColumnMode, isDisposed, isInsertMode, isOneLineMode, isViewer, logicalPositionToOffset, logicalPositionToXY, logicalToVisualPosition, offsetToLogicalPosition, offsetToPoint2D, offsetToPoint2D, offsetToVisualPosition, offsetToVisualPosition, offsetToXY, offsetToXY, removeEditorMouseListener, removeEditorMouseMotionListener, setBorder, setHeaderComponent, visualLineToY, visualPositionToPoint2D, visualPositionToXY, visualToLogicalPosition, xyToLogicalPosition, xyToVisualPosition, xyToVisualPosition, yToVisualLine

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

getUserData, putUserData

Field Detail

PROP_INSERT_MODE

static final java.lang.String PROP_INSERT_MODE

See Also:

Constant Field Values

PROP_COLUMN_MODE

static final java.lang.String PROP_COLUMN_MODE

See Also:

Constant Field Values

PROP_FONT_SIZE

static final java.lang.String PROP_FONT_SIZE

See Also:

Constant Field Values

LAST_PASTED_REGION

static final Key<TextRange> LAST_PASTED_REGION

VERTICAL_SCROLLBAR_LEFT

static final int VERTICAL_SCROLLBAR_LEFT

See Also:

Constant Field Values

VERTICAL_SCROLLBAR_RIGHT

static final int VERTICAL_SCROLLBAR_RIGHT

See Also:

Constant Field Values

Method Detail

getDocument

DocumentEx getDocument()

Description copied from interface: Editor

Returns the document edited or viewed in the editor.

Specified by:

getDocument in interface Editor

Returns:

the document instance.

getMarkupModel

MarkupModelEx getMarkupModel()

Description copied from interface: Editor

Returns the markup model for the editor. This model contains editor-specific highlighters (for example, highlighters added by "Highlight usages in file"), which are painted in addition to the highlighters contained in the markup model for the document.

See also DocumentMarkupModel.forDocument(Document, Project, boolean) getFilteredDocumentMarkupModel().

Specified by:

getMarkupModel in interface Editor

Returns:

the markup model instance.

getFilteredDocumentMarkupModel

MarkupModelEx getFilteredDocumentMarkupModel()

Returns the markup model for the underlying Document.

This model differs from the one from DocumentMarkupModel#forDocument, as it does not contain highlighters that should not be visible in this Editor. (for example, debugger breakpoints in a diff viewer editors)

Returns:

the markup model instance.

See Also:

MarkupEditorFilter, EditorImpl.setHighlightingFilter(Condition), DocumentMarkupModel.forDocument(Document, Project, boolean)

getGutterComponentEx

EditorGutterComponentEx getGutterComponentEx()

getHighlighter

EditorHighlighter getHighlighter()

getPermanentHeaderComponent

javax.swing.JComponent getPermanentHeaderComponent()

setViewer

void setViewer(boolean isViewer)

shouldn't be called during Document update

setPermanentHeaderComponent

void setPermanentHeaderComponent(javax.swing.JComponent component)

setHighlighter

void setHighlighter(EditorHighlighter highlighter)

setColorsScheme

void setColorsScheme(EditorColorsScheme scheme)

setInsertMode

void setInsertMode(boolean val)

setColumnMode

void setColumnMode(boolean val)

setVerticalScrollbarOrientation

void setVerticalScrollbarOrientation(int type)

getVerticalScrollbarOrientation

int getVerticalScrollbarOrientation()

setVerticalScrollbarVisible

void setVerticalScrollbarVisible(boolean b)

setHorizontalScrollbarVisible

void setHorizontalScrollbarVisible(boolean b)

getCutProvider

CutProvider getCutProvider()

getCopyProvider

CopyProvider getCopyProvider()

getPasteProvider

PasteProvider getPasteProvider()

getDeleteProvider

DeleteProvider getDeleteProvider()

repaint

void repaint(int startOffset,
             int endOffset)

reinitSettings

void reinitSettings()

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener,
                               Disposable parentDisposable)

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

getMaxWidthInRange

int getMaxWidthInRange(int startOffset,
                       int endOffset)

setCaretVisible

boolean setCaretVisible(boolean b)

setCaretEnabled

boolean setCaretEnabled(boolean enabled)

addFocusListener

void addFocusListener(FocusChangeListener listener)

addFocusListener

void addFocusListener(FocusChangeListener listener,
                      Disposable parentDisposable)

setOneLineMode

void setOneLineMode(boolean b)

getScrollPane

javax.swing.JScrollPane getScrollPane()

isRendererMode

boolean isRendererMode()

setRendererMode

void setRendererMode(boolean isRendererMode)

setFile

void setFile(VirtualFile vFile)

getDataContext

DataContext getDataContext()

processKeyTyped

boolean processKeyTyped(java.awt.event.KeyEvent e)

setFontSize

void setFontSize(int fontSize)

getBackgroundColor

java.awt.Color getBackgroundColor()

setBackgroundColor

void setBackgroundColor(java.awt.Color color)

getContentSize

java.awt.Dimension getContentSize()

isEmbeddedIntoDialogWrapper

boolean isEmbeddedIntoDialogWrapper()

setEmbeddedIntoDialogWrapper

void setEmbeddedIntoDialogWrapper(boolean b)

getVirtualFile

VirtualFile getVirtualFile()

getTextDrawingCallback

TextDrawingCallback getTextDrawingCallback()

getFoldingModel

FoldingModelEx getFoldingModel()

Description copied from interface: Editor

Returns the folding model for the document, which can be used to add, remove, expand or collapse folded regions in the document.

Specified by:

getFoldingModel in interface Editor

Returns:

the folding model instance.

getSoftWrapModel

SoftWrapModelEx getSoftWrapModel()

Description copied from interface: Editor

Returns the soft wrap model for the document, which can be used to get information about soft wraps registered for the editor document at the moment and provides basic management functions for them.

Specified by:

getSoftWrapModel in interface Editor

Returns:

the soft wrap model instance.

getScrollingModel

ScrollingModelEx getScrollingModel()

Description copied from interface: Editor

Returns the scrolling model for the document, which can be used to scroll the document and retrieve information about the current position of the scrollbars.

Specified by:

getScrollingModel in interface Editor

Returns:

the scrolling model instance.

createBoundColorSchemeDelegate

EditorColorsScheme createBoundColorSchemeDelegate(EditorColorsScheme customGlobalScheme)

Creates color scheme delegate which is bound to current editor. E.g. all schema changes will update editor state.

setPlaceholder

void setPlaceholder(java.lang.CharSequence text)

Allows to define 'placeholder text' for the current editor, i.e. virtual text that will be represented until any user data is entered. Feel free to see the detailed feature definition here.

Parameters:

text - virtual text to show until user data is entered or the editor is focused

setPlaceholderAttributes

void setPlaceholderAttributes(TextAttributes attributes)

Sets text attributes for a placeholder. Font style and color are currently supported. null means default values should be used.

See Also:

setPlaceholder(CharSequence)

setShowPlaceholderWhenFocused

void setShowPlaceholderWhenFocused(boolean show)

Controls whether 'placeholder text' is visible when editor is focused.

Parameters:

show - flag indicating whether placeholder is visible when editor is focused.

See Also:

setPlaceholder(CharSequence)

isStickySelection

boolean isStickySelection()

Allows to answer if 'sticky selection' is active for the current editor.

'Sticky selection' means that every time caret position changes, selection end offset is automatically set to the same position. Selection start is always caret offset on setStickySelection(boolean) call with 'true' argument.

Returns:

true if 'sticky selection' mode is active at the current editor; false otherwise

setStickySelection

void setStickySelection(boolean enable)

Allows to set current sticky selection mode.

Parameters:

enable - flag that identifies if 'sticky selection' mode should be enabled

getPrefixTextWidthInPixels

int getPrefixTextWidthInPixels()

Returns:

width in pixels of the prefix used with the current editor if any; zero otherwise

setPrefixTextAndAttributes

void setPrefixTextAndAttributes(java.lang.String prefixText,
                                TextAttributes attributes)

Allows to define prefix to be displayed on every editor line and text attributes to use for its coloring.

Parameters:

prefixText - target prefix text

attributes - text attributes to use during given prefix painting

isPurePaintingMode

boolean isPurePaintingMode()

Returns:

current 'pure painting mode' status

See Also:

setPurePaintingMode(boolean)

setPurePaintingMode

void setPurePaintingMode(boolean enabled)

We often re-use the logic encapsulated at the editor. For example, every time we show editor fragment (folding, preview etc) we create a dedicated graphics object and ask the editor to paint into it.

The thing is that the editor itself may change its state if any postponed operation is triggered by the painting request (e.g. soft wraps recalculation is triggered by the paint request and newly calculated soft wraps cause caret to change its position).

This method allows to inform the editor that all subsequent painting request should not change the editor state.

In 'pure painting mode' editor also behaves as if soft wraps were not enabled.

Parameters:

enabled - 'pure painting mode' status to use

registerLineExtensionPainter

void registerLineExtensionPainter(java.util.function.IntFunction<java.util.Collection<LineExtensionInfo>> lineExtensionPainter)

Registers a function which will be applied to a line number to obtain additional text fragments. The fragments returned by the function will be drawn in the editor after end of the line (together with fragments returned by EditorLinePainter extensions).

registerScrollBarRepaintCallback

void registerScrollBarRepaintCallback(ButtonlessScrollBarUI.ScrollbarRepaintCallback callback)

Allows to register a callback that will be called one each repaint of the editor vertical scrollbar. This is needed to allow a parent component draw above the scrollbar components (e.g. in the merge tool), otherwise the drawings are cleared once the scrollbar gets repainted (which may happen suddenly, because the scrollbar UI uses the Animator to draw itself.

Parameters:

callback - callback which will be called from the JComponent.paint(Graphics) method of the editor vertical scrollbar.

getExpectedCaretOffset

int getExpectedCaretOffset()

Returns:

the offset that the caret is expected to be but maybe not yet. This can be used in EditorMouseListener.mousePressed(EditorMouseEvent) implementation, as at the time this method is invoked caret wasn't yet moved to the press position. In other circumstances it's just equal to primary caret's offset.

setContextMenuGroupId

void setContextMenuGroupId(java.lang.String groupId)

Sets id of action group what will be used to construct context menu displayed by default editor popup handler on mouse right button's click (with null value disabling context menu). This method might have no effect if default editor's popup handler was overridden using installPopupHandler(EditorPopupHandler).

See Also:

getContextMenuGroupId()

getContextMenuGroupId

java.lang.String getContextMenuGroupId()

Returns id of action group what will be used to construct context menu displayed by default editor popup handler on mouse right button's click (null value meaning no context menu). Returned value might be meaningless if default editor's popup handler was overridden using installPopupHandler(EditorPopupHandler).

See Also:

setContextMenuGroupId(String)

installPopupHandler

void installPopupHandler(EditorPopupHandler popupHandler)

Allows to override default editor's context popup logic.

Default handler shows a context menu corresponding to a certain action group registered in ActionManager. Group's id can be changed using setContextMenuGroupId(String). For inline custom visual elements (inlays) action group is determined by EditorCustomElementRenderer.getContextMenuGroupId(Inlay) and EditorCustomElementRenderer.getContextMenuGroup(Inlay).

If multiple handlers are installed, they are processed in order, starting from the most recently installed one. Processing stops when some handler returns true from EditorPopupHandler.handlePopup(EditorMouseEvent) method.

See Also:

uninstallPopupHandler(EditorPopupHandler)

uninstallPopupHandler

void uninstallPopupHandler(EditorPopupHandler popupHandler)

Removes previously installed EditorPopupHandler.

See Also:

installPopupHandler(EditorPopupHandler)

setCustomCursor

void setCustomCursor(java.lang.Object requestor,
                     java.awt.Cursor cursor)

If cursor parameter value is not null, sets custom cursor to editor's content component, otherwise restores default editor cursor management logic (requestor parameter value should be the same in both setting and restoring requests). 'Restoring' call for a requestor, which hasn't set a cursor previously, has no effect. If multiple requestors have currently set custom cursors, one of them will be used (it is unspecified, which one).