Class Selection

Represents a text selection in an editor.

Hierarchy (view full)

Range
- Selection

Index

Constructors

Properties

active anchor end isEmpty isReversed isSingleLine start

Methods

contains intersection isEqual union with

Constructors

constructor

new Selection(anchor, active): Selection
Create a selection from two positions.
Parameters
- anchor: Position
  a position
- active: Position
  a position
Returns Selection
Overrides Range.constructor
- Defined in packages/plugin/src/theia.d.ts:380
new Selection(anchorLine, anchorCharacter, activeLine, activeCharacter): Selection
Create a selection from coordinates.
Parameters
- anchorLine: number
  a zero based line value
- anchorCharacter: number
  a zero based character value
- activeLine: number
  a zero based line value
- activeCharacter: number
  a zero based character value
Returns Selection
Overrides Range.constructor
- Defined in packages/plugin/src/theia.d.ts:390

Properties

active

active: Position

Position of the cursor

anchor

anchor: Position

Position where selection starts.

`Readonly` end

End position.

isEmpty

isEmpty: boolean

true if start and end are equal

isReversed

isReversed: boolean

A selection is reversed if active.isBefore(anchor)

isSingleLine

isSingleLine: boolean

true if start.line and end.line are equal

`Readonly` start

start: Position

Start position.

Methods

contains

contains(positionOrRange): boolean
Check if a position or a range is in this range.
Parameters
- positionOrRange: Range | Position
  a position or a range
Returns boolean
Inherited from Range.contains
- Defined in packages/plugin/src/theia.d.ts:311

intersection

intersection(range): undefined | Range
Intersect range with this range and returns new range or undefined
Parameters
- range: Range
  a range
Returns undefined | Range
Inherited from Range.intersection
- Defined in packages/plugin/src/theia.d.ts:325

isEqual

isEqual(other): boolean
Check other equals this range.
Parameters
- other: Range
  a range
Returns boolean
Inherited from Range.isEqual
- Defined in packages/plugin/src/theia.d.ts:318

union

union(other): Range
Compute the union of other with this range.
Parameters
- other: Range
  a range
Returns Range
Inherited from Range.union
- Defined in packages/plugin/src/theia.d.ts:332

with

with(start?, end?): Range
Derived a new range from this range.
Parameters
- Optional start: Position
  A position that should be used as start. The default value is the current start.
- Optional end: Position
  A position that should be used as end. The default value is the current end.
Returns Range
A range derived from this range with the given start and end position. If start and end are not different this range will be returned.
Inherited from Range.with
- Defined in packages/plugin/src/theia.d.ts:342
with(change): Range
Derived a new range from this range.
Parameters
- change: {
  end?: Position;
  start?: Position;
  }
  An object that describes a change to this range.
  - Optional end?: Position
  - Optional start?: Position
Returns Range
A range that reflects the given change. Will return this range if the change is not changing anything.
Inherited from Range.with
- Defined in packages/plugin/src/theia.d.ts:351