Class Selection

Represents a text selection in an editor.

Hierarchy

Range
- Selection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Selection(anchor: Position, active: Position): Selection
new Selection(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number): Selection

Overrides Range.constructor
- Defined in packages/plugin/src/theia.d.ts:358
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:368
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

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: Range | Position): boolean

Inherited from Range.contains
- Defined in packages/plugin/src/theia.d.ts:289
Check if a position or a range is in this range.

Parameters
- positionOrRange: Range | Position
  
  a position or a range
Returns boolean

intersection

intersection(range: Range): undefined | Range

Inherited from Range.intersection
- Defined in packages/plugin/src/theia.d.ts:303
Intersect range with this range and returns new range or undefined

Parameters
- range: Range
  
  a range
Returns undefined | Range

isEqual

isEqual(other: Range): boolean

Inherited from Range.isEqual
- Defined in packages/plugin/src/theia.d.ts:296
Check other equals this range.

Parameters
- other: Range
  
  a range
Returns boolean

union

union(other: Range): Range

Inherited from Range.union
- Defined in packages/plugin/src/theia.d.ts:310
Compute the union of other with this range.

Parameters
- other: Range
  
  a range
Returns Range

with

with(start?: Position, end?: Position): Range
with(change: { end?: Position; start?: Position }): Range

Inherited from Range.with
- Defined in packages/plugin/src/theia.d.ts:320
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:329
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.