kotlin-vscode/vscode/Selection

Selection

open class Selection : Range(source)

Represents a text selection in an editor.

Online Documentation

Constructors

Selection

constructor(anchor: Position, active: Position)

Create a selection from two positions.

constructor(anchorLine: Int, anchorCharacter: Int, activeLine: Int, activeCharacter: Int)

Create a selection from four coordinates.

Properties

active

val active: Position

The position of the cursor. This position might be before or after anchor.

anchor

val anchor: Position

The position at which the selection starts. This position might be before or after active.

end

val end: Position

The end position. It is after or equal to start.

isEmpty

var isEmpty: Boolean

true if start and end are equal.

isReversed

val isReversed: Boolean

A selection is reversed if its anchor} is the {@link Selection.end end position.

isSingleLine

var isSingleLine: Boolean

true if start.line and end.line are equal.

start

val start: Position

The start position. It is before or equal to end.

Functions

contains

fun contains(positionOrRange: Position): Boolean

Check if a position or a range is contained in this range.

fun contains(positionOrRange: Range): Boolean

intersection

fun intersection(range: Range): Range?

Intersect range with this range and returns a new range or undefined if the ranges have no overlap.

isEqual

fun isEqual(other: Range): Boolean

Check if other equals this range.

union

fun union(other: Range): Range

Compute the union of other with this range.

with

fun with(change: Range.WithChange): Range

fun with(start: Position = definedExternally, end: Position = definedExternally): Range

Derived a new range from this range.