Package com.intellij.openapi.editor

Class LogicalPosition

java.lang.Object

com.intellij.openapi.editor.LogicalPosition

All Implemented Interfaces:

java.lang.Comparable<LogicalPosition>

public class LogicalPosition
extends java.lang.Object
implements java.lang.Comparable<LogicalPosition>

Represents a logical position in the editor, including line and column values (both zero-based). Line value relates to the corresponding line in the editor's Document. Column value counts characters from the beginning of the logical line (tab character can occupy multiple columns - up to the tab size set for editor, surrogate pairs of characters are counted as one column). Positions beyond the end of line can be represented (in this case column number will be larger than the number of characters in the line).

Logical position corresponds to a boundary between two characters and can be associated with either a preceding or succeeding character (see leansForward). This association makes a difference in a bidirectional text, where a mapping from logical to visual position is not continuous.

Logical position of caret in current editor is displayed in IDE's status bar (displayed line and column values are one-based, so they are incremented before showing).

Note: two objects of this class are considered equal if their logical line and column are equal. I.e. all logical positions for soft wrap-introduced virtual space and the first document symbol after soft wrap are considered to be equal. Value of leansForward flag doesn't impact the equality of logical positions.

See Also:

Editor.offsetToLogicalPosition(int), Editor.logicalPositionToOffset(LogicalPosition), VisualPosition, Editor.visualToLogicalPosition(VisualPosition), Editor.xyToLogicalPosition(Point)

Field Summary

Fields

Modifier and Type	Field and Description
int	column
boolean	leansForward If true, this position is associated with succeeding character (in logical order), otherwise it's associated with preceding character.
int	line

Constructor Summary

Constructors

Constructor and Description
LogicalPosition(int line, int column)
LogicalPosition(int line, int column, boolean leansForward)

Method Summary

Modifier and Type	Method and Description
int	compareTo(LogicalPosition position)
boolean	equals(java.lang.Object o)
int	hashCode()
LogicalPosition	leanForward(boolean value) Constructs a new LogicalPosition instance with a given value of leansForward flag.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

line

public final int line

column

public final int column

leansForward

public final boolean leansForward

If true, this position is associated with succeeding character (in logical order), otherwise it's associated with preceding character. This can make difference in bidirectional text, where logical positions which differ only in this flag's value can have different visual positions.

This field has no impact on equality and comparison relationships between LogicalPosition instances.

Constructor Detail

LogicalPosition

public LogicalPosition(int line,
                       int column)
                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

LogicalPosition

public LogicalPosition(int line,
                       int column,
                       boolean leansForward)
                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

Method Detail

leanForward

public LogicalPosition leanForward(boolean value)

Constructs a new LogicalPosition instance with a given value of leansForward flag.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(LogicalPosition position)

Specified by:

compareTo in interface java.lang.Comparable<LogicalPosition>