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

CheckBox

class CheckBox(text: String) : SelectButtonBase

A CheckBox can have either two states : selected == true , selected == false. Or, if you set allowIndeterminate, then it can have three states :

state          |  indeterminate value |  selected value
-------------------------------------------------------
unselected     |  false               |  false
selected       |  false               |  true
indeterminate  |  true                |  n/a

It is displayed using one of two/three graphics. Clicking will cycle through the two/three states.

Theme DSL

"check_box" {

     graphic( Image )
     graphic( images : NamedImages, imageName: String )

     ":selected" { graphic( ... ) }
     ":intermediate" { graphic( ... ) }
}

CheckBox inherits all the features of ButtonBase.

Constructors

CheckBox

constructor()

constructor(text: String)

Properties

allowIndeterminate

var allowIndeterminate: Boolean

allowIndeterminateProperty

val allowIndeterminateProperty: BooleanProperty

When set to true, this has three states, rather than the usual selected / not-selected. The third state is when indeterminate is true (and when indeterminate is true, selected has no meaning).

indeterminate

var indeterminate: Boolean

indeterminateProperty

val indeterminateProperty: BooleanProperty

selected

open override var selected: Boolean

selectedProperty

open override val selectedProperty: BooleanProperty

Functions

toString

open override fun toString(): String