Scrollable

interface Scrollable

A Scrollable object has a visible 2D space which might be smaller than its actual size. A scrollable maintains a visible "window" over its content which can be bigger either vertically or horizontally than its actual part.

Functions

equals
Link copied to clipboard
common
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open fun hashCode(): Int
scrollDownBy
Link copied to clipboard
common
abstract fun scrollDownBy(rows: Int): Position
Scrolls this Scrollable with rows rows down.
scrollLeftBy
Link copied to clipboard
common
abstract fun scrollLeftBy(columns: Int): Position
Scrolls this Scrollable with width width to the left.
scrollOneDown
Link copied to clipboard
common
abstract fun scrollOneDown(): Position
Scrolls this Scrollable with one depth down.
scrollOneLeft
Link copied to clipboard
common
abstract fun scrollOneLeft(): Position
Scrolls this Scrollable with one width to the left.
scrollOneRight
Link copied to clipboard
common
abstract fun scrollOneRight(): Position
Scrolls this Scrollable with one width to the right.
scrollOneUp
Link copied to clipboard
common
abstract fun scrollOneUp(): Position
Scrolls this Scrollable with one depth up.
scrollRightBy
Link copied to clipboard
common
abstract fun scrollRightBy(columns: Int): Position
Scrolls this Scrollable by width width to the right.
scrollTo
Link copied to clipboard
common
abstract fun scrollTo(position: Position)
Scrolls this Scrollable to the provided position
scrollUpBy
Link copied to clipboard
common
abstract fun scrollUpBy(rows: Int): Position
Scrolls this Scrollable by depth depth up.
toString
Link copied to clipboard
common
open fun toString(): String

Properties

actualSize
Link copied to clipboard
common
abstract var actualSize: Size
the Size of the virtual space this Scrollable can scroll through
visibleOffset
Link copied to clipboard
common
abstract val visibleOffset: Position
The offset where the visible part of this Scrollable starts.
visibleSize
Link copied to clipboard
common
abstract val visibleSize: Size
the size of the visible part of this Scrollable3D.

Inheritors

TextArea
Link copied to clipboard
DefaultScrollable
Link copied to clipboard
DefaultTextArea
Link copied to clipboard

Sources

(source)
Link copied to clipboard