core/org.k3lp.runtime/K3TextRange

K3TextRange

class K3TextRange(val start: Int, val end: Int)(source)

A selection range from start to end in a text.

There is no restriction to the values nor ordering of start and end. It may happen that start > end, and that is perfectly fine. If ordering is important, min and max should be used.

If start == end, then this range represents a collapsed selection (commonly known as cursor).

Constructors

K3TextRange

constructor(start: Int, end: Int)

constructor(index: Int)

Shorthand constructor for creating a text range from a single cursor index.

Types

Companion

object Companion

Properties

end

val end: Int

The end index of the selection.

max

val max: Int

The maximum of start and end, represents the exclusive max index in the text.

min

val min: Int

The minimum of start and end, represents the inclusive min index in the text.

start

val start: Int

The start index of the selection.

Functions

asRange

fun asRange(): IntRange

Returns this range as a Kotlin IntRange.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isCollapsed

fun isCollapsed(): Boolean

Returns true if this range represents a collapsed selection (commonly known as cursor).

isNotCollapsed

fun isNotCollapsed(): Boolean

Returns true if this range represents a non-collapsed selection (commonly known as selection).

minus

operator fun minus(value: Int): K3TextRange

Returns a new text range with given value subtracted to both start and end.

plus

operator fun plus(value: Int): K3TextRange

Returns a new text range with given value added to both start and end.

toString

open override fun toString(): String

Returns the string representation of this range for debug purposes.