picker-app/androidx.picker.features.observable/ObservableProperty

ObservableProperty

open class ObservableProperty<T>(state: MutableState<T>, onUpdated: (T) -> Unit? = null)(source)

A generic observable property that allows for value observation and modification.

This class encapsulates a value of type T and provides mechanisms to:

Get and set the value.
Register listeners that are notified before or after the value changes.
Bind to a callback that is invoked when the value changes or when the binding is established.

It uses a MutableState to manage the underlying state, making it compatible with Compose's state management system.

Parameters

The type of the value held by this observable property.

Inheritors

UpdateObservableProperty

SelectableItem

Constructors

ObservableProperty

constructor(state: MutableState<T>, onUpdated: (T) -> Unit? = null)

Functions

bind

fun bind(callback: (T) -> Unit? = null): DisposableHandle

Binds a callback to this observable property.

getState

fun getState(): T

Retrieves the current value of the observable property.

registerAfterChangeUpdateListener

fun registerAfterChangeUpdateListener(onValueUpdateListener: (T, T) -> Unit): DisposableHandle

Registers a listener that is notified after the value of this property has changed.

registerBeforeChangeUpdateListener

fun registerBeforeChangeUpdateListener(onValueUpdateListener: (T, T) -> Boolean): DisposableHandle

Registers a listener that is invoked before the property's value changes.

setState

fun setState(value: T)

Sets the value of the observable property using property delegation. This is a convenience method that delegates to MutableState.setValue.

setValue

fun setValue(value: T)

Sets the value of the observable property.

fun setValue(thisRef: Any?, prop: KProperty<*>, value: T)

setValueSilence

fun setValueSilence(value: T)

Sets the value of the property without invoking the beforeChange and afterChange listeners. However, the onUpdated callback (if set) and onBindCallback callback will still be triggered.