Package com.intellij.openapi.editor

Class CaretState

java.lang.Object

com.intellij.openapi.editor.CaretState

public class CaretState
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CaretState(LogicalPosition caretPosition, int visualColumnAdjustment, LogicalPosition selectionStart, LogicalPosition selectionEnd)
CaretState(LogicalPosition caretPosition, LogicalPosition selectionStart, LogicalPosition selectionEnd)

Method Summary

Modifier and Type	Method and Description
LogicalPosition	getCaretPosition()
LogicalPosition	getSelectionEnd()
LogicalPosition	getSelectionStart()
int	getVisualColumnAdjustment() Sometimes logical caret position is not fully determining its visual position (e.g.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CaretState

public CaretState(LogicalPosition caretPosition,
                  LogicalPosition selectionStart,
                  LogicalPosition selectionEnd)

CaretState

public CaretState(LogicalPosition caretPosition,
                  int visualColumnAdjustment,
                  LogicalPosition selectionStart,
                  LogicalPosition selectionEnd)

Parameters:

visualColumnAdjustment - see getVisualColumnAdjustment()

Method Detail

getCaretPosition

public LogicalPosition getCaretPosition()

getVisualColumnAdjustment

public int getVisualColumnAdjustment()

Sometimes logical caret position is not fully determining its visual position (e.g. around inlays). This value should be added to the result of editor.logicalToVisualPosition(caretState.getCaretPosition())'s column, if one needs to calculate caret's visual position.

getSelectionStart

public LogicalPosition getSelectionStart()

getSelectionEnd

public LogicalPosition getSelectionEnd()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object