Editor (Unofficial IntelliJ Community Edition API docs)

All Superinterfaces:

UserDataHolder

All Known Subinterfaces:

EditorEx, EditorWindow, TextComponentEditor

All Known Implementing Classes:

EditorImpl, EditorWindowImpl, ImaginaryEditor, TextComponentEditorImpl
```
public interface Editor
extends UserDataHolder
```
Represents an instance of a text editor.

See Also:

EditorFactory.createEditor(Document), EditorFactory.createViewer(Document)

Field Summary

Fields
Modifier and Type Field and Description

static Editor[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static Editor[]`	`EMPTY_ARRAY`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addEditorMouseListener(EditorMouseListener listener)` Adds a listener for receiving notifications about mouse clicks in the editor and the mouse entering/exiting the editor.
`default void`	`addEditorMouseListener(EditorMouseListener listener, Disposable parentDisposable)` Adds a listener for receiving notifications about mouse clicks in the editor and the mouse entering/exiting the editor.
`void`	`addEditorMouseMotionListener(EditorMouseMotionListener listener)` Adds a listener for receiving notifications about mouse movement in the editor.
`default void`	`addEditorMouseMotionListener(EditorMouseMotionListener listener, Disposable parentDisposable)` Adds a listener for receiving notifications about mouse movement in the editor.
`default int`	`getAscent()` Vertical distance, in pixels, between the top of visual line (corresponding coordinate is returned by `visualLineToY(int)`, `visualPositionToXY(VisualPosition)`, etc) and baseline of text in that visual line.
`CaretModel`	`getCaretModel()` Returns the caret model for the document, which can be used to add and remove carets to the editor, as well as to query and update carets' and corresponding selections' positions.
`EditorColorsScheme`	`getColorsScheme()` Returns the editor color scheme for this editor instance.
`javax.swing.JComponent`	`getComponent()` Returns the component for the entire editor including the scrollbars, error stripe, gutter and other decorations.
`javax.swing.JComponent`	`getContentComponent()` Returns the component for the content area of the editor (the area displaying the document text).
`Document`	`getDocument()` Returns the document edited or viewed in the editor.
`EditorKind`	`getEditorKind()`
`FoldingModel`	`getFoldingModel()` Returns the folding model for the document, which can be used to add, remove, expand or collapse folded regions in the document.
`EditorGutter`	`getGutter()` Returns the gutter instance for the editor, which can be used to draw custom text annotations in the gutter.
`javax.swing.JComponent`	`getHeaderComponent()`
`IndentsModel`	`getIndentsModel()`
`InlayModel`	`getInlayModel()`
`java.awt.Insets`	`getInsets()`
`int`	`getLineHeight()` Returns the height of a single line of text in the current editor font.
`MarkupModel`	`getMarkupModel()` Returns the markup model for the editor.
`EditorMouseEventArea`	`getMouseEventArea(java.awt.event.MouseEvent e)` Returns the editor area (text, gutter, folding outline and so on) in which the specified mouse event occurred.
`Project`	`getProject()` Returns the project to which the editor is related.
`ScrollingModel`	`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.
`SelectionModel`	`getSelectionModel()` Returns the selection model for the editor, which can be used to select ranges of text in the document and retrieve information about the selection.
`EditorSettings`	`getSettings()` Returns the editor settings for this editor instance.
`SoftWrapModel`	`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.
`boolean`	`hasHeaderComponent()`
`boolean`	`isColumnMode()` Returns the block selection mode for the editor.
`boolean`	`isDisposed()` Checks if this editor instance has been disposed.
`boolean`	`isInsertMode()` Returns the insert/overwrite mode for the editor.
`boolean`	`isOneLineMode()` Checks if the current editor instance is a one-line editor (used in a dialog control, for example).
`boolean`	`isViewer()` Returns the value indicating whether the editor operates in viewer mode, with all modification actions disabled.
`int`	`logicalPositionToOffset(LogicalPosition pos)` Maps a logical position in the editor to the offset in the document.
`java.awt.Point`	`logicalPositionToXY(LogicalPosition pos)` Maps a logical position in the editor to pixel coordinates.
`VisualPosition`	`logicalToVisualPosition(LogicalPosition logicalPos)` Maps a logical position in the editor (the line and column ignoring folding) to a visual position (with folded lines and columns not included in the line and column count).
`LogicalPosition`	`offsetToLogicalPosition(int offset)` Maps an offset in the document to a logical position.
`default java.awt.geom.Point2D`	`offsetToPoint2D(int offset)`
`default java.awt.geom.Point2D`	`offsetToPoint2D(int offset, boolean leanForward, boolean beforeSoftWrap)`
`VisualPosition`	`offsetToVisualPosition(int offset)` Maps an offset in the document to visual position.
`VisualPosition`	`offsetToVisualPosition(int offset, boolean leanForward, boolean beforeSoftWrap)` Maps an offset in the document to visual position.
`default java.awt.Point`	`offsetToXY(int offset)`
`default java.awt.Point`	`offsetToXY(int offset, boolean leanForward, boolean beforeSoftWrap)`
`void`	`removeEditorMouseListener(EditorMouseListener listener)` Removes a listener for receiving notifications about mouse clicks in the editor and the mouse entering/exiting the editor.
`void`	`removeEditorMouseMotionListener(EditorMouseMotionListener listener)` Removes a listener for receiving notifications about mouse movement in the editor.
`void`	`setBorder(javax.swing.border.Border border)`
`void`	`setHeaderComponent(javax.swing.JComponent header)` Set up a header component for this text editor.
`default int`	`visualLineToY(int visualLine)`
`java.awt.geom.Point2D`	`visualPositionToPoint2D(VisualPosition pos)` Same as `visualPositionToXY(VisualPosition)`, but returns potentially more precise result.
`java.awt.Point`	`visualPositionToXY(VisualPosition visible)` Maps a visual position in the editor to pixel coordinates.
`LogicalPosition`	`visualToLogicalPosition(VisualPosition visiblePos)` Maps a visual position in the editor (with folded lines and columns not included in the line and column count) to a logical position (the line and column ignoring folding).
`LogicalPosition`	`xyToLogicalPosition(java.awt.Point p)` Maps the pixel coordinates in the editor to a logical position.
`VisualPosition`	`xyToVisualPosition(java.awt.Point p)` Maps the pixel coordinates in the editor to a visual position.
`VisualPosition`	`xyToVisualPosition(java.awt.geom.Point2D p)` Same as {`xyToVisualPosition(Point)`}, but allows to specify target point with higher precision.
`default int`	`yToVisualLine(int y)`

Methods inherited from interface com.intellij.openapi.util.UserDataHolder
getUserData, putUserData

- Field Detail
  - EMPTY_ARRAY
```
static final Editor[] EMPTY_ARRAY
```
- Method Detail
  - getDocument
```
Document getDocument()
```
    Returns the document edited or viewed in the editor.
    
    Returns:
    
    the document instance.
  - isViewer
```
boolean isViewer()
```
    Returns the value indicating whether the editor operates in viewer mode, with all modification actions disabled.
    
    Returns:
    
    true if the editor works as a viewer, false otherwise.
  - getComponent
```
javax.swing.JComponent getComponent()
```
    Returns the component for the entire editor including the scrollbars, error stripe, gutter and other decorations. The component can be used, for example, for converting logical to screen coordinates.
    
    Returns:
    
    the component instance.
  - getContentComponent
```
javax.swing.JComponent getContentComponent()
```
    Returns the component for the content area of the editor (the area displaying the document text). The component can be used, for example, for converting logical to screen coordinates. The instance is implementing DataProvider.
    
    Returns:
    
    the component instance.
  - setBorder
```
void setBorder(javax.swing.border.Border border)
```
  - getInsets
```
java.awt.Insets getInsets()
```
  - getSelectionModel
```
SelectionModel getSelectionModel()
```
    Returns the selection model for the editor, which can be used to select ranges of text in the document and retrieve information about the selection.
    To query or change selections for specific carets, CaretModel interface should be used.
    
    Returns:
    
    the selection model instance.
    
    See Also:
    
    getCaretModel()
  - getMarkupModel
```
MarkupModel getMarkupModel()
```
    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) EditorEx.getFilteredDocumentMarkupModel().
    
    Returns:
    
    the markup model instance.
  - getFoldingModel
```
FoldingModel getFoldingModel()
```
    Returns the folding model for the document, which can be used to add, remove, expand or collapse folded regions in the document.
    
    Returns:
    
    the folding model instance.
  - getScrollingModel
```
ScrollingModel 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.
    
    Returns:
    
    the scrolling model instance.
  - getCaretModel
```
CaretModel getCaretModel()
```
    Returns the caret model for the document, which can be used to add and remove carets to the editor, as well as to query and update carets' and corresponding selections' positions.
    
    Returns:
    
    the caret model instance.
  - getSoftWrapModel
```
SoftWrapModel 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.
    
    Returns:
    
    the soft wrap model instance.
  - getSettings
```
EditorSettings getSettings()
```
    Returns the editor settings for this editor instance. Changes to these settings affect only the current editor instance.
    
    Returns:
    
    the settings instance.
  - getColorsScheme
```
EditorColorsScheme getColorsScheme()
```
    Returns the editor color scheme for this editor instance. Changes to the scheme affect only the current editor instance.
    
    Returns:
    
    the color scheme instance.
  - getLineHeight
```
int getLineHeight()
```
    Returns the height of a single line of text in the current editor font.
    
    Returns:
    
    the line height in pixels.
  - logicalPositionToXY
```
java.awt.Point logicalPositionToXY(LogicalPosition pos)
```
    Maps a logical position in the editor to pixel coordinates.
    
    Parameters:
    
    pos - the logical position.
    
    Returns:
    
    the coordinates relative to the top left corner of the content component.
  - logicalPositionToOffset
```
int logicalPositionToOffset(LogicalPosition pos)
```
    Maps a logical position in the editor to the offset in the document.
    
    Parameters:
    
    pos - the logical position.
    
    Returns:
    
    the corresponding offset in the document.
  - logicalToVisualPosition
```
VisualPosition logicalToVisualPosition(LogicalPosition logicalPos)
```
    Maps a logical position in the editor (the line and column ignoring folding) to a visual position (with folded lines and columns not included in the line and column count).
    
    Parameters:
    
    logicalPos - the logical position.
    
    Returns:
    
    the corresponding visual position.
  - visualPositionToXY
```
java.awt.Point visualPositionToXY(VisualPosition visible)
```
    Maps a visual position in the editor to pixel coordinates.
    
    Parameters:
    
    visible - the visual position.
    
    Returns:
    
    the coordinates relative to the top left corner of the content component.
  - visualPositionToPoint2D
```
java.awt.geom.Point2D visualPositionToPoint2D(VisualPosition pos)
```
    Same as visualPositionToXY(VisualPosition), but returns potentially more precise result.
  - visualToLogicalPosition
```
LogicalPosition visualToLogicalPosition(VisualPosition visiblePos)
```
    Maps a visual position in the editor (with folded lines and columns not included in the line and column count) to a logical position (the line and column ignoring folding).
    
    Parameters:
    
    visiblePos - the visual position.
    
    Returns:
    
    the corresponding logical position.
  - offsetToLogicalPosition
```
LogicalPosition offsetToLogicalPosition(int offset)
```
    Maps an offset in the document to a logical position.
    It's assumed that original position is associated with character immediately preceding given offset, so target logical position will have leansForward value set to false.
    
    Parameters:
    
    offset - the offset in the document.
    
    Returns:
    
    the corresponding logical position.
  - offsetToVisualPosition
```
VisualPosition offsetToVisualPosition(int offset)
```
    Maps an offset in the document to visual position.
    It's assumed that original position is associated with the character immediately preceding given offset, leansRight value for visual position will be determined correspondingly.
    If there's a soft wrap at the given offset, visual position on a line following the wrap will be returned.
    
    Parameters:
    
    offset - the offset in the document.
    
    Returns:
    
    the corresponding visual position.
  - offsetToVisualPosition
```
VisualPosition offsetToVisualPosition(int offset,
                                      boolean leanForward,
                                      boolean beforeSoftWrap)
```
    Maps an offset in the document to visual position.
    
    Parameters:
    
    offset - the offset in the document.
    
    leanForward - if true, original position is associated with character after given offset, if false - with character before given offset. This can make a difference in bidirectional text (see LogicalPosition, VisualPosition)
    
    beforeSoftWrap - if true, visual position at line preceeding the wrap will be returned, otherwise - visual position at line following the wrap.
    
    Returns:
    
    the corresponding visual position.
  - xyToLogicalPosition
```
LogicalPosition xyToLogicalPosition(java.awt.Point p)
```
    Maps the pixel coordinates in the editor to a logical position.
    
    Parameters:
    
    p - the coordinates relative to the top left corner of the content component.
    
    Returns:
    
    the corresponding logical position.
  - xyToVisualPosition
```
VisualPosition xyToVisualPosition(java.awt.Point p)
```
    Maps the pixel coordinates in the editor to a visual position.
    
    Parameters:
    
    p - the coordinates relative to the top left corner of the content component.
    
    Returns:
    
    the corresponding visual position.
  - xyToVisualPosition
```
VisualPosition xyToVisualPosition(java.awt.geom.Point2D p)
```
    Same as {xyToVisualPosition(Point)}, but allows to specify target point with higher precision.
  - offsetToXY
```
default java.awt.Point offsetToXY(int offset)
```
  - offsetToXY
```
default java.awt.Point offsetToXY(int offset,
                                  boolean leanForward,
                                  boolean beforeSoftWrap)
```
    See Also:
    
    offsetToVisualPosition(int, boolean, boolean)
  - offsetToPoint2D
```
default java.awt.geom.Point2D offsetToPoint2D(int offset)
```
  - offsetToPoint2D
```
default java.awt.geom.Point2D offsetToPoint2D(int offset,
                                              boolean leanForward,
                                              boolean beforeSoftWrap)
```
    See Also:
    
    offsetToVisualPosition(int, boolean, boolean)
  - visualLineToY
```
default int visualLineToY(int visualLine)
```
  - yToVisualLine
```
default int yToVisualLine(int y)
```
  - addEditorMouseListener
```
void addEditorMouseListener(EditorMouseListener listener)
```
    Adds a listener for receiving notifications about mouse clicks in the editor and the mouse entering/exiting the editor.
    
    Parameters:
    
    listener - the listener instance.
  - addEditorMouseListener
```
default void addEditorMouseListener(EditorMouseListener listener,
                                    Disposable parentDisposable)
```
    Adds a listener for receiving notifications about mouse clicks in the editor and the mouse entering/exiting the editor. The listener is removed when the given parent disposable is disposed.
    
    Parameters:
    
    listener - the listener instance.
    
    parentDisposable - the parent Disposable instance.
  - removeEditorMouseListener
```
void removeEditorMouseListener(EditorMouseListener listener)
```
    Removes a listener for receiving notifications about mouse clicks in the editor and the mouse entering/exiting the editor.
    
    Parameters:
    
    listener - the listener instance.
  - addEditorMouseMotionListener
```
void addEditorMouseMotionListener(EditorMouseMotionListener listener)
```
    Adds a listener for receiving notifications about mouse movement in the editor.
    
    Parameters:
    
    listener - the listener instance.
  - addEditorMouseMotionListener
```
default void addEditorMouseMotionListener(EditorMouseMotionListener listener,
                                          Disposable parentDisposable)
```
    Adds a listener for receiving notifications about mouse movement in the editor. The listener is removed when the given parent disposable is disposed.
    
    Parameters:
    
    listener - the listener instance.
    
    parentDisposable - the parent Disposable instance.
  - removeEditorMouseMotionListener
```
void removeEditorMouseMotionListener(EditorMouseMotionListener listener)
```
    Removes a listener for receiving notifications about mouse movement in the editor.
    
    Parameters:
    
    listener - the listener instance.
  - isDisposed
```
boolean isDisposed()
```
    Checks if this editor instance has been disposed.
    
    Returns:
    
    true if the editor has been disposed, false otherwise.
  - getProject
```
Project getProject()
```
    Returns the project to which the editor is related.
    
    Returns:
    
    the project instance, or null if the editor is not related to any project.
  - isInsertMode
```
boolean isInsertMode()
```
    Returns the insert/overwrite mode for the editor.
    
    Returns:
    
    true if the editor is in insert mode, false otherwise.
  - isColumnMode
```
boolean isColumnMode()
```
    Returns the block selection mode for the editor.
    
    Returns:
    
    true if the editor uses column selection, false if it uses regular selection.
  - isOneLineMode
```
boolean isOneLineMode()
```
    Checks if the current editor instance is a one-line editor (used in a dialog control, for example).
    
    Returns:
    
    true if the editor is one-line, false otherwise.
  - getGutter
```
EditorGutter getGutter()
```
    Returns the gutter instance for the editor, which can be used to draw custom text annotations in the gutter.
    
    Returns:
    
    the gutter instance.
  - getMouseEventArea
```
EditorMouseEventArea getMouseEventArea(java.awt.event.MouseEvent e)
```
    Returns the editor area (text, gutter, folding outline and so on) in which the specified mouse event occurred.
    
    Parameters:
    
    e - the mouse event for which the area is requested.
    
    Returns:
    
    the editor area, or null if the event occurred over an unknown area.
  - setHeaderComponent
```
void setHeaderComponent(javax.swing.JComponent header)
```
    Set up a header component for this text editor. Please note this is used for textual find feature so your component will most probably will be reset once the user presses Ctrl+F.
    
    Parameters:
    
    header - a component to setup as header for this text editor or null to remove existing one.
  - hasHeaderComponent
```
boolean hasHeaderComponent()
```
    Returns:
    
    true if this editor has active header component set up by setHeaderComponent(JComponent)
  - getHeaderComponent
```
javax.swing.JComponent getHeaderComponent()
```
    Returns:
    
    a component set by setHeaderComponent(JComponent) or null if no header currently installed.
  - getIndentsModel
```
IndentsModel getIndentsModel()
```
  - getInlayModel
```
InlayModel getInlayModel()
```
  - getEditorKind
```
EditorKind getEditorKind()
```
  - getAscent
```
default int getAscent()
```
    Vertical distance, in pixels, between the top of visual line (corresponding coordinate is returned by visualLineToY(int), visualPositionToXY(VisualPosition), etc) and baseline of text in that visual line.

Interface Editor

Field Summary

Method Summary

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

Field Detail

EMPTY_ARRAY

Method Detail

getDocument

isViewer

getComponent

getContentComponent

setBorder

getInsets

getSelectionModel

getMarkupModel

getFoldingModel

getScrollingModel

getCaretModel

getSoftWrapModel

getSettings

getColorsScheme

getLineHeight

logicalPositionToXY

logicalPositionToOffset

logicalToVisualPosition

visualPositionToXY

visualPositionToPoint2D

visualToLogicalPosition

offsetToLogicalPosition

offsetToVisualPosition

offsetToVisualPosition

xyToLogicalPosition

xyToVisualPosition

xyToVisualPosition

offsetToXY

offsetToXY

offsetToPoint2D

offsetToPoint2D

visualLineToY

yToVisualLine

addEditorMouseListener

addEditorMouseListener

removeEditorMouseListener

addEditorMouseMotionListener

addEditorMouseMotionListener

removeEditorMouseMotionListener

isDisposed

getProject

isInsertMode

isColumnMode

isOneLineMode

getGutter

getMouseEventArea

setHeaderComponent

hasHeaderComponent

getHeaderComponent

getIndentsModel

getInlayModel

getEditorKind

getAscent