Package com.intellij.openapi.editor

Class VisualPosition

java.lang.Object

com.intellij.openapi.editor.VisualPosition

public class VisualPosition
extends java.lang.Object

Represents a visual position in the editor. Visual positions take folding into account - for example, if the top 10 lines of the document are folded, the 10th line in the document will have the line number 1 in its visual position.

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

See Also:

LogicalPosition, Editor.logicalToVisualPosition(LogicalPosition), Editor.offsetToVisualPosition(int), Editor.xyToVisualPosition(java.awt.Point)

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
VisualPosition(int line, int column)
VisualPosition(int line, int column, boolean leansRight)

Method Summary

Modifier and Type	Method and Description
boolean	after(VisualPosition other) Allows to answer if current visual position is located after the given one.
boolean	equals(java.lang.Object o)
int	getColumn()
int	getLine()
int	hashCode()
VisualPosition	leanRight(boolean value) Constructs a new VisualPosition instance with a given value of leansRight 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

leansRight

public final boolean leansRight

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

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

Constructor Detail

VisualPosition

public VisualPosition(int line,
                      int column)

VisualPosition

public VisualPosition(int line,
                      int column,
                      boolean leansRight)

Method Detail

after

public boolean after(VisualPosition other)

Allows to answer if current visual position is located after the given one.

One visual position is considered to be 'after' another only if one of the following is true:

 

   
its visual line is greater;
   
it has the same visual line but its column is greater;
 
 

Parameters:

other - visual position to compare with the current one

Returns:

true if current position is 'after' the given one; false otherwise

leanRight

public VisualPosition leanRight(boolean value)

Constructs a new VisualPosition instance with a given value of leansRight flag.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

getLine

public int getLine()

getColumn

public int getColumn()