glok-model/uk.co.nickthecoder.glok.property.boilerplate/ObservableBoolean

ObservableBoolean

interface ObservableBoolean : ObservableValue<Boolean>

Boilerplate which avoids having to use generics. Instead of ObservableValue<Boolean>, use ObservableBoolean.

Inheritors

ReadOnlyBooleanProperty

BooleanUnaryFunction

BooleanBinaryFunction

BooleanTernaryFunction

IndirectObservableBoolean

DefaultIndirectObservableBoolean

Properties

abstract val value: Boolean

Functions

addBindChangeListener

open fun addBindChangeListener(lambda: (ObservableValue<Boolean>, Boolean, Boolean) -> Unit): ChangeListener<Boolean, ObservableValue<Boolean>>

abstract fun addBindChangeListener(listener: ChangeListener<Boolean, ObservableValue<Boolean>>)

Identical to addChangeListener, but these listeners are guaranteed to fire BEFORE other listeners. These should be used for the sole purpose of updating single ObservableValues which are dependent on this ObservableValue. This helps (but doesn't guarantee) that properties change atomically. i.e. when one property changes, a related property also changes before other (regular) listeners fire. Therefore, the (regular) listeners cannot read inconsistent values.

addBindListener

open fun addBindListener(lambda: (Observable) -> Unit): InvalidationListener

abstract fun addBindListener(listener: InvalidationListener)

Identical to addListener, but these listeners are guaranteed to fire BEFORE regular listeners. These should be used for the sole purpose of updating other ObservableValues which are dependent on this Observable.

addChangeListener

open fun addChangeListener(lambda: (ObservableValue<Boolean>, Boolean, Boolean) -> Unit): ChangeListener<Boolean, ObservableValue<Boolean>>

abstract fun addChangeListener(listener: ChangeListener<Boolean, ObservableValue<Boolean>>)

open fun addListener(lambda: (Observable) -> Unit): InvalidationListener

abstract fun addListener(listener: InvalidationListener)

addWeakChangeListener

open fun addWeakChangeListener(lambda: (ObservableValue<Boolean>, Boolean, Boolean) -> Unit): ChangeListener<Boolean, ObservableValue<Boolean>>

addWeakListener

open fun addWeakListener(lambda: (Observable) -> Unit): InvalidationListener

infix fun ObservableBoolean.and(other: ObservableBoolean): ObservableBoolean

fun <T : Any> ObservableValue<T>.asNullable(): ObservableValue<T?>

Converts an ObservableValue, with a non-nullable to value, to an ObservableValue whose value IS nullable.

open fun equalTo(other: Boolean): ObservableBoolean

open fun equalTo(other: ObservableValue<Boolean>): ObservableBoolean

open operator fun getValue(thisRef: Any, kProperty: KProperty<*>): Boolean

Lets us declare a val using a for the value of this property, using this as a delegate. e.g.

fun <A> ObservableBoolean.ifElse(trueValue: A, falseValue: A): UnaryFunction<A, Boolean, ObservableBoolean>

open fun isNotNull(): ObservableBoolean

open fun isNull(): ObservableBoolean

operator fun ObservableBoolean.not(): ObservableBoolean

open fun notEqualTo(other: Boolean): ObservableBoolean

open fun notEqualTo(other: ObservableValue<Boolean>): ObservableBoolean

notSameInstance

open fun notSameInstance(other: Boolean): ObservableBoolean

open fun notSameInstance(other: ObservableValue<Boolean>): ObservableBoolean

infix fun ObservableBoolean.or(other: ObservableBoolean): ObservableBoolean

removeChangeListener

abstract fun removeChangeListener(listener: ChangeListener<Boolean, ObservableValue<Boolean>>)

abstract fun removeListener(listener: InvalidationListener)

replaceNullWith

fun <T : Any> ObservableValue<T?>.replaceNullWith(defaultValue: T): ObservableValue<T>

Converts an ObservableValue, with a nullable to value, to an ObservableValue whose value is NOT nullable, by supplying a defaultValue.

open fun sameInstance(other: Boolean): ObservableBoolean

open fun sameInstance(other: ObservableValue<Boolean>): ObservableBoolean

toObservableString

open fun toObservableString(): ObservableString

open fun toObservableString(nullString: String): ObservableString

infix fun ObservableBoolean.xor(other: ObservableBoolean): ObservableBoolean