TextRange
-
Cmn
value class TextRange
An immutable text range class, represents a text range from start (inclusive) to end (exclusive). end can be smaller than start and in those cases min and max can be used in order to fetch the values.
Summary
Public functions |
||
|---|---|---|
operator Boolean |
Returns true if the given offset is a part of this range. |
Cmn
|
operator Boolean |
Returns true if this range covers including equals with the given range. |
Cmn
|
Boolean |
intersects(other: TextRange)Returns true if the given range has intersection with this range |
Cmn
|
open String |
toString() |
Cmn
|
Public properties |
||
|---|---|---|
Boolean |
Returns true if the range is collapsed |
Cmn
|
Int |
Cmn
|
|
Int |
Returns the length of the range. |
Cmn
|
Int |
The maximum offset of the range. |
Cmn
|
Int |
The minimum offset of the range. |
Cmn
|
Boolean |
Returns true if the start offset is larger than the end offset. |
Cmn
|
Int |
Cmn
|
Extension functions |
||
|---|---|---|
TextRange |
Ensures that |
Cmn
|
Public functions
contains
operator fun contains(offset: Int): Boolean
Returns true if the given offset is a part of this range.
contains
operator fun contains(other: TextRange): Boolean
Returns true if this range covers including equals with the given range.
intersects
fun intersects(other: TextRange): Boolean
Returns true if the given range has intersection with this range
Public properties
Extension functions
coerceIn
fun TextRange.coerceIn(minimumValue: Int, maximumValue: Int): TextRange
Ensures that TextRange.start and TextRange.end values lies in the specified range minimumValue and maximumValue. For each TextRange.start and TextRange.end values:
-
if value is smaller than
minimumValue, value is replaced byminimumValue -
if value is greater than
maximumValue, value is replaced bymaximumValue
| Parameters | |
|---|---|
minimumValue: Int |
the minimum value that |
maximumValue: Int |
the exclusive maximum value that |