glok-core/uk.co.nickthecoder.glok.property/StylableProperty

StylableProperty

interface StylableProperty<V> : Property<V>

Properties which can be styled by a theme must use this instead of a Property.

The purpose of a StylableProperty is to hold the value prior to being styled, so that it can be reverted if the property becomes un-styled.

For example, imagine we have a Label with black text, and we add a "highlight" style, which causes the text to turn bright green.

Later, when we remove the "highlight" style, the text will revert to black (using revert).

If a StylableProperty's value is set after it has been styled, the value applied by the Theme will be overwritten. removing the theme will have no effect, the new value will remain.

Inheritors

SimpleStylableProperty

Properties

bean

abstract val bean: Any?

beanName

abstract val beanName: String?

value

abstract override var value: V

Functions

addBindChangeListener

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

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

addBindListener

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

abstract fun addBindListener(listener: InvalidationListener)

addChangeListener

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

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

addListener

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

abstract fun addListener(listener: InvalidationListener)

addWeakChangeListener

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

addWeakListener

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

bidirectionalBind

abstract fun bidirectionalBind(other: Property<V>): BidirectionalBind

open fun <B> bidirectionalBind(other: Property<B>, converter: Converter<V, B>): BidirectionalBind

bidirectionalUnbind

abstract fun bidirectionalUnbind(other: Property<*>?)

bindCastTo

open fun <T : V> bindCastTo(bindTo: ObservableValue<T>)

bindTo

abstract fun bindTo(to: ObservableValue<V>)

equalTo

open fun equalTo(other: V): ObservableBoolean

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

getValue

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

isBound

abstract fun isBound(): Boolean

isNotNull

open fun isNotNull(): ObservableBoolean

isNull

open fun isNull(): ObservableBoolean

kclass

abstract fun kclass(): KClass<*>

Returns the Class for this Property's value, or null if bean or beanName have not been specified.

notEqualTo

open fun notEqualTo(other: V): ObservableBoolean

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

notSameInstance

open fun notSameInstance(other: V): ObservableBoolean

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

removeChangeListener

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

removeListener

abstract fun removeListener(listener: InvalidationListener)

revert

abstract fun revert()

sameInstance

open fun sameInstance(other: V): ObservableBoolean

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

setValue

open operator fun setValue(thisRef: Any, kProperty: KProperty<*>, newValue: V)

style

abstract fun style(newValue: Any)

toObservableString

open fun toObservableString(): ObservableString

open fun toObservableString(nullString: String): ObservableString

unbind

abstract fun unbind()