glok-core/uk.co.nickthecoder.glok.control/ScrollPane

ScrollPane

class ScrollPane(content: Node? = null) : Region, WithContent

Displays a portion of a content node, with scrollbars to pan. Some Glok controls have a built-in ScrollPanes (e.g. TextArea, ListView).

Constructors

constructor(content: Node? = null)

Types

ScrollPaneActions

object ScrollPaneActions : Actions

Properties

open override val children: ObservableList<Region>

The base class Node has no children, so this is an empty list.

val commands: Commands

open override var content: Node?

contentProperty

val contentProperty: OptionalNodeProperty

var fitToHeight: Boolean

fitToHeightProperty

val fitToHeightProperty: BooleanProperty

If content is taller than the viewport, should it be expanded to fill the whole height of the viewport?

var fitToWidth: Boolean

fitToWidthProperty

val fitToWidthProperty: BooleanProperty

If content is narrower than the viewport, should it be expanded to fill the whole width of the viewport?

var hPolicy: ScrollBarPolicy

hPolicyProperty

val hPolicyProperty: StylableScrollBarPolicyProperty

val hScrollMax: Float

hScrollMaxProperty

val hScrollMaxProperty: ReadOnlyFloatProperty

var hScrollValue: Float

hScrollValueProperty

val hScrollValueProperty: FloatProperty

var vPolicy: ScrollBarPolicy

vPolicyProperty

val vPolicyProperty: StylableScrollBarPolicyProperty

val vScrollMax: Float

vScrollMaxProperty

val vScrollMaxProperty: ReadOnlyFloatProperty

var vScrollValue: Float

vScrollValueProperty

val vScrollValueProperty: FloatProperty

Functions

fun fullHeight(): Float

The height the ScrollPane would have to be, so that the viewport could display the full height of the content.

fun fullWidth(): Float

The width the ScrollPane would have to be, so that the viewport could display the full width of the content.

open override fun nodePrefHeight(): Float

Each subclass of node can determine its preferred height. As most nodes are composed of smaller nodes, this is typically calculated using evalPrefWidth of the child nodes, with extra added for spacing, padding and borders.

open override fun nodePrefWidth(): Float

Each subclass of node can determine its preferred width. As most nodes are composed of smaller nodes, this is typically calculated using evalPrefWidth of the child nodes, with extra added for spacing, padding and borders.

fun scrollTo(contentDescendant: Node)

Ensures that contentDescendant is fully visible. contentDescendant must be a descendant of content.

fun scrollToX(contentX: Float)

fun scrollToY(contentY: Float)

open override fun toString(): String

visibleContentBounds

fun visibleContentBounds(): GlokRect