headless/dev.fritz2.headless.components/SelectionMode

SelectionMode

class SelectionMode<T>(val job: Job) : WithJob

This Property alike class exposes the selection configuration of a data collection. There are two modes available:

single which needs a DatabindingProperty of T
multi which needs a DatabindingProperty of List of T

Of course both can be omitted if no selection is needed.

Constructors

constructor(job: Job)

Properties

val isSet: Boolean

open override val job: Job

val multi: DatabindingProperty<List<T>>

val single: DatabindingProperty<T?>

Functions

open fun errorHandler(cause: Throwable)

open infix fun <A> Flow<A>.handledBy(handler: Handler<A>)

open infix fun <A> Flow<A>.handledBy(execute: suspend (A) -> Unit): Job

open infix fun <E : Event> Flow<E>.handledBy(handler: Handler<Unit>)

open infix fun <E : Event> Flow<E>.handledBy(execute: suspend (E) -> Unit): Job

sanitizeSelection

fun sanitizeSelection(availableItems: Flow<List<T>>, data: CollectionData<T>)

Calling this function will connect the provided Flow of List of T with the current selection flow (one single item T for mode single and some List of T for mode multi). On every change of the external items flow, the current selection will be sanitized in the following way: If the selection contains some item, that is not part of the items flow, it will be removed from the selection.

fun selectItem(itemToSelect: Flow<T>, data: CollectionData<T>)

This function connects some Flow of T with a defined selection, either for single or multi mode.

fun use(other: SelectionMode<T>)