ImaginaryEditor (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.openapi.editor.impl.ImaginaryEditor

All Implemented Interfaces:: Editor, UserDataHolder, UserDataHolderEx

public class ImaginaryEditor
extends UserDataHolderBase
implements Editor

Field Summary
- Fields inherited from interface com.intellij.openapi.editor.Editor
  EMPTY_ARRAY

Constructor Summary

Constructors
Constructor and Description

ImaginaryEditor(Document document)

Constructors
Constructor and Description
`ImaginaryEditor(Document document)`

Method Summary

All Methods Instance Methods Concrete 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.
`void`	`addEditorMouseMotionListener(EditorMouseMotionListener listener)` Adds a listener for receiving notifications about mouse movement in the editor.
`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).
`protected java.lang.RuntimeException`	`notImplemented()`
`LogicalPosition`	`offsetToLogicalPosition(int offset)` Maps an offset in the document to a logical position.
`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.
`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.
`java.awt.geom.Point2D`	`visualPositionToPoint2D(VisualPosition pos)` Same as `Editor.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 {`Editor.xyToVisualPosition(Point)`}, but allows to specify target point with higher precision.

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase
changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.openapi.editor.Editor
addEditorMouseListener, addEditorMouseMotionListener, getAscent, offsetToPoint2D, offsetToPoint2D, offsetToXY, offsetToXY, visualLineToY, yToVisualLine

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

- Constructor Detail
  - ImaginaryEditor
```
public ImaginaryEditor(Document document)
```
- Method Detail
  - getDocument
```
public Document 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.
  - getCaretModel
```
public CaretModel getCaretModel()
```
    Description copied from interface: Editor
    
    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.
    
    Specified by:
    
    getCaretModel in interface Editor
    
    Returns:
    
    the caret model instance.
  - getSelectionModel
```
public SelectionModel getSelectionModel()
```
    Description copied from interface: Editor
    
    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.
    
    Specified by:
    
    getSelectionModel in interface Editor
    
    Returns:
    
    the selection model instance.
    
    See Also:
    
    Editor.getCaretModel()
  - notImplemented
```
protected java.lang.RuntimeException notImplemented()
```
  - isViewer
```
public boolean isViewer()
```
    Description copied from interface: Editor
    
    Returns the value indicating whether the editor operates in viewer mode, with all modification actions disabled.
    
    Specified by:
    
    isViewer in interface Editor
    
    Returns:
    
    true if the editor works as a viewer, false otherwise.
  - getComponent
```
public javax.swing.JComponent getComponent()
```
    Description copied from interface: Editor
    
    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.
    
    Specified by:
    
    getComponent in interface Editor
    
    Returns:
    
    the component instance.
  - getContentComponent
```
public javax.swing.JComponent getContentComponent()
```
    Description copied from interface: Editor
    
    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.
    
    Specified by:
    
    getContentComponent in interface Editor
    
    Returns:
    
    the component instance.
  - setBorder
```
public void setBorder(javax.swing.border.Border border)
```
    Specified by:
    
    setBorder in interface Editor
  - getInsets
```
public java.awt.Insets getInsets()
```
    Specified by:
    
    getInsets in interface Editor
  - getMarkupModel
```
public MarkupModel 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) EditorEx.getFilteredDocumentMarkupModel().
    
    Specified by:
    
    getMarkupModel in interface Editor
    
    Returns:
    
    the markup model instance.
  - getFoldingModel
```
public FoldingModel 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.
  - getScrollingModel
```
public ScrollingModel 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.
  - getSoftWrapModel
```
public SoftWrapModel 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.
  - getSettings
```
public EditorSettings getSettings()
```
    Description copied from interface: Editor
    
    Returns the editor settings for this editor instance. Changes to these settings affect only the current editor instance.
    
    Specified by:
    
    getSettings in interface Editor
    
    Returns:
    
    the settings instance.
  - getColorsScheme
```
public EditorColorsScheme getColorsScheme()
```
    Description copied from interface: Editor
    
    Returns the editor color scheme for this editor instance. Changes to the scheme affect only the current editor instance.
    
    Specified by:
    
    getColorsScheme in interface Editor
    
    Returns:
    
    the color scheme instance.
  - getLineHeight
```
public int getLineHeight()
```
    Description copied from interface: Editor
    
    Returns the height of a single line of text in the current editor font.
    
    Specified by:
    
    getLineHeight in interface Editor
    
    Returns:
    
    the line height in pixels.
  - logicalPositionToXY
```
public java.awt.Point logicalPositionToXY(LogicalPosition pos)
```
    Description copied from interface: Editor
    
    Maps a logical position in the editor to pixel coordinates.
    
    Specified by:
    
    logicalPositionToXY in interface Editor
    
    Parameters:
    
    pos - the logical position.
    
    Returns:
    
    the coordinates relative to the top left corner of the content component.
  - logicalPositionToOffset
```
public int logicalPositionToOffset(LogicalPosition pos)
```
    Description copied from interface: Editor
    
    Maps a logical position in the editor to the offset in the document.
    
    Specified by:
    
    logicalPositionToOffset in interface Editor
    
    Parameters:
    
    pos - the logical position.
    
    Returns:
    
    the corresponding offset in the document.
  - logicalToVisualPosition
```
public VisualPosition logicalToVisualPosition(LogicalPosition logicalPos)
```
    Description copied from interface: Editor
    
    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).
    
    Specified by:
    
    logicalToVisualPosition in interface Editor
    
    Parameters:
    
    logicalPos - the logical position.
    
    Returns:
    
    the corresponding visual position.
  - visualPositionToXY
```
public java.awt.Point visualPositionToXY(VisualPosition visible)
```
    Description copied from interface: Editor
    
    Maps a visual position in the editor to pixel coordinates.
    
    Specified by:
    
    visualPositionToXY in interface Editor
    
    Parameters:
    
    visible - the visual position.
    
    Returns:
    
    the coordinates relative to the top left corner of the content component.
  - visualPositionToPoint2D
```
public java.awt.geom.Point2D visualPositionToPoint2D(VisualPosition pos)
```
    Description copied from interface: Editor
    
    Same as Editor.visualPositionToXY(VisualPosition), but returns potentially more precise result.
    
    Specified by:
    
    visualPositionToPoint2D in interface Editor
  - visualToLogicalPosition
```
public LogicalPosition visualToLogicalPosition(VisualPosition visiblePos)
```
    Description copied from interface: Editor
    
    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).
    
    Specified by:
    
    visualToLogicalPosition in interface Editor
    
    Parameters:
    
    visiblePos - the visual position.
    
    Returns:
    
    the corresponding logical position.
  - offsetToLogicalPosition
```
public LogicalPosition offsetToLogicalPosition(int offset)
```
    Description copied from interface: Editor
    
    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.
    
    Specified by:
    
    offsetToLogicalPosition in interface Editor
    
    Parameters:
    
    offset - the offset in the document.
    
    Returns:
    
    the corresponding logical position.
  - offsetToVisualPosition
```
public VisualPosition offsetToVisualPosition(int offset)
```
    Description copied from interface: Editor
    
    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.
    
    Specified by:
    
    offsetToVisualPosition in interface Editor
    
    Parameters:
    
    offset - the offset in the document.
    
    Returns:
    
    the corresponding visual position.
  - offsetToVisualPosition
```
public VisualPosition offsetToVisualPosition(int offset,
                                             boolean leanForward,
                                             boolean beforeSoftWrap)
```
    Description copied from interface: Editor
    
    Maps an offset in the document to visual position.
    
    Specified by:
    
    offsetToVisualPosition in interface Editor
    
    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
```
public LogicalPosition xyToLogicalPosition(java.awt.Point p)
```
    Description copied from interface: Editor
    
    Maps the pixel coordinates in the editor to a logical position.
    
    Specified by:
    
    xyToLogicalPosition in interface Editor
    
    Parameters:
    
    p - the coordinates relative to the top left corner of the content component.
    
    Returns:
    
    the corresponding logical position.
  - xyToVisualPosition
```
public VisualPosition xyToVisualPosition(java.awt.Point p)
```
    Description copied from interface: Editor
    
    Maps the pixel coordinates in the editor to a visual position.
    
    Specified by:
    
    xyToVisualPosition in interface Editor
    
    Parameters:
    
    p - the coordinates relative to the top left corner of the content component.
    
    Returns:
    
    the corresponding visual position.
  - xyToVisualPosition
```
public VisualPosition xyToVisualPosition(java.awt.geom.Point2D p)
```
    Description copied from interface: Editor
    
    Same as {Editor.xyToVisualPosition(Point)}, but allows to specify target point with higher precision.
    
    Specified by:
    
    xyToVisualPosition in interface Editor
  - addEditorMouseListener
```
public void addEditorMouseListener(EditorMouseListener listener)
```
    Description copied from interface: Editor
    
    Adds a listener for receiving notifications about mouse clicks in the editor and the mouse entering/exiting the editor.
    
    Specified by:
    
    addEditorMouseListener in interface Editor
    
    Parameters:
    
    listener - the listener instance.
  - removeEditorMouseListener
```
public void removeEditorMouseListener(EditorMouseListener listener)
```
    Description copied from interface: Editor
    
    Removes a listener for receiving notifications about mouse clicks in the editor and the mouse entering/exiting the editor.
    
    Specified by:
    
    removeEditorMouseListener in interface Editor
    
    Parameters:
    
    listener - the listener instance.
  - addEditorMouseMotionListener
```
public void addEditorMouseMotionListener(EditorMouseMotionListener listener)
```
    Description copied from interface: Editor
    
    Adds a listener for receiving notifications about mouse movement in the editor.
    
    Specified by:
    
    addEditorMouseMotionListener in interface Editor
    
    Parameters:
    
    listener - the listener instance.
  - removeEditorMouseMotionListener
```
public void removeEditorMouseMotionListener(EditorMouseMotionListener listener)
```
    Description copied from interface: Editor
    
    Removes a listener for receiving notifications about mouse movement in the editor.
    
    Specified by:
    
    removeEditorMouseMotionListener in interface Editor
    
    Parameters:
    
    listener - the listener instance.
  - isDisposed
```
public boolean isDisposed()
```
    Description copied from interface: Editor
    
    Checks if this editor instance has been disposed.
    
    Specified by:
    
    isDisposed in interface Editor
    
    Returns:
    
    true if the editor has been disposed, false otherwise.
  - getProject
```
public Project getProject()
```
    Description copied from interface: Editor
    
    Returns the project to which the editor is related.
    
    Specified by:
    
    getProject in interface Editor
    
    Returns:
    
    the project instance, or null if the editor is not related to any project.
  - isInsertMode
```
public boolean isInsertMode()
```
    Description copied from interface: Editor
    
    Returns the insert/overwrite mode for the editor.
    
    Specified by:
    
    isInsertMode in interface Editor
    
    Returns:
    
    true if the editor is in insert mode, false otherwise.
  - isColumnMode
```
public boolean isColumnMode()
```
    Description copied from interface: Editor
    
    Returns the block selection mode for the editor.
    
    Specified by:
    
    isColumnMode in interface Editor
    
    Returns:
    
    true if the editor uses column selection, false if it uses regular selection.
  - isOneLineMode
```
public boolean isOneLineMode()
```
    Description copied from interface: Editor
    
    Checks if the current editor instance is a one-line editor (used in a dialog control, for example).
    
    Specified by:
    
    isOneLineMode in interface Editor
    
    Returns:
    
    true if the editor is one-line, false otherwise.
  - getGutter
```
public EditorGutter getGutter()
```
    Description copied from interface: Editor
    
    Returns the gutter instance for the editor, which can be used to draw custom text annotations in the gutter.
    
    Specified by:
    
    getGutter in interface Editor
    
    Returns:
    
    the gutter instance.
  - getMouseEventArea
```
public EditorMouseEventArea getMouseEventArea(java.awt.event.MouseEvent e)
```
    Description copied from interface: Editor
    
    Returns the editor area (text, gutter, folding outline and so on) in which the specified mouse event occurred.
    
    Specified by:
    
    getMouseEventArea in interface Editor
    
    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
```
public void setHeaderComponent(javax.swing.JComponent header)
```
    Description copied from interface: Editor
    
    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.
    
    Specified by:
    
    setHeaderComponent in interface Editor
    
    Parameters:
    
    header - a component to setup as header for this text editor or null to remove existing one.
  - hasHeaderComponent
```
public boolean hasHeaderComponent()
```
    Specified by:
    
    hasHeaderComponent in interface Editor
    
    Returns:
    
    true if this editor has active header component set up by Editor.setHeaderComponent(JComponent)
  - getHeaderComponent
```
public javax.swing.JComponent getHeaderComponent()
```
    Specified by:
    
    getHeaderComponent in interface Editor
    
    Returns:
    
    a component set by Editor.setHeaderComponent(JComponent) or null if no header currently installed.
  - getIndentsModel
```
public IndentsModel getIndentsModel()
```
    Specified by:
    
    getIndentsModel in interface Editor
  - getInlayModel
```
public InlayModel getInlayModel()
```
    Specified by:
    
    getInlayModel in interface Editor
  - getEditorKind
```
public EditorKind getEditorKind()
```
    Specified by:
    
    getEditorKind in interface Editor

Class ImaginaryEditor

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

Methods inherited from class java.lang.Object

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

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

Constructor Detail

ImaginaryEditor

Method Detail

getDocument

getCaretModel

getSelectionModel

notImplemented

isViewer

getComponent

getContentComponent

setBorder

getInsets

getMarkupModel

getFoldingModel

getScrollingModel

getSoftWrapModel

getSettings

getColorsScheme

getLineHeight

logicalPositionToXY

logicalPositionToOffset

logicalToVisualPosition

visualPositionToXY

visualPositionToPoint2D

visualToLogicalPosition

offsetToLogicalPosition

offsetToVisualPosition

offsetToVisualPosition

xyToLogicalPosition

xyToVisualPosition

xyToVisualPosition

addEditorMouseListener

removeEditorMouseListener

addEditorMouseMotionListener

removeEditorMouseMotionListener

isDisposed

getProject

isInsertMode

isColumnMode

isOneLineMode

getGutter

getMouseEventArea

setHeaderComponent

hasHeaderComponent

getHeaderComponent

getIndentsModel

getInlayModel

getEditorKind