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

SpinnerBase

abstract class SpinnerBase<V, P : Property<V>> : Region, HasReadOnly

Displays a TextField where a value can by typed in, as well 'up' and 'down' buttons where the value can be adjusted stepwise. This base class doesn't define what stepwise means. For example, IntSpinner has a IntSpinner.smallStep, therefore stepwise does not mean increment/decrement. The value of a spinner does not have to be Comparable, but is required for the subclass ComparableSpinner.

Inheritors

ComparableSpinner

Constructors

SpinnerBase

constructor()

Types

SpinnerActions

object SpinnerActions : Actions

Properties

autoUpdate

var autoUpdate: Boolean

autoUpdateProperty

val autoUpdateProperty: BooleanProperty

Should value change while typing into the text-field? The default is false. value will only be updated when the spinner loses input focus, or when the Enter key is pressed.

children

open override val children: ObservableList<Node>

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

editor

val editor: TextField

largeStep

abstract var largeStep: V

largeStepProperty

abstract val largeStepProperty: P

readOnly

override var readOnly: Boolean

readOnlyProperty

override val readOnlyProperty: BooleanProperty

smallStep

abstract var smallStep: V

smallStepProperty

abstract val smallStepProperty: P

spinnerArrowPositions

var spinnerArrowPositions: SpinnerArrowPositions

spinnerArrowPositionsProperty

val spinnerArrowPositionsProperty: StylableSpinnerArrowPositionsProperty

value

abstract var value: V

valueProperty

abstract val valueProperty: P

Functions

adjust

open fun adjust(direction: Int, byLargeStep: Boolean = false)

adjustment

abstract fun adjustment(direction: Int, byLargeStep: Boolean): V

open override fun Number.em(): ObservableOptionalFloat

Converts em units to LogicalPixels.

isValid

abstract fun isValid(newValue: V): Boolean

nodeMinHeight

open override fun nodeMinHeight(): Float

Each subclass of node can determine the minimum width it requires. This can be overridden on an ad-hoc basis using overrideMinHeight. The default implementation returns 0.

nodeMinWidth

open override fun nodeMinWidth(): Float

Each subclass of node can determine the minimum width it requires. This can be overridden on an ad-hoc basis using overrideMinWidth. The default implementation returns 0.

nodePrefHeight

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.

nodePrefWidth

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.

toString

open override fun toString(): String