glok-model/uk.co.nickthecoder.glok.collections

Package-level declarations

Types

ListChange

interface ListChange<out E>

The data describing changes to an ObservableList.

ListChangeListener

interface ListChangeListener<out E>

When programming in the typical Kotlin style, this isn't used, because you'll use a lambda instead.

MutableObservableList

interface MutableObservableList<E> : MutableList<E> , ObservableList<E>

A mutable list, which can be observed by ListChangeListeners and InvalidationListeners.

MutableObservableSet

interface MutableObservableSet<E> : MutableSet<E> , ObservableSet<E>

Any changes made to the underlying set will NOT cause change events to be fired. Therefore, it is not advisable to keep references to the underlying set.

ObservableList

interface ObservableList<out E> : List<E> , Observable

A list, which can be observed by ListChangeListeners and InvalidationListeners.

ObservableListSize

class ObservableListSize(val list: ObservableList<*>) : ObservableValueBase<Int> , ObservableInt

An ObservableInt whose value is the size of an ObservableList.

ObservableSet

interface ObservableSet<E> : Set<E> , Observable

A set, which can be observed by SetChangeListeners and InvalidationListeners.

ObservableSetSize

class ObservableSetSize(val list: ObservableSet<*>) : ObservableValueBase<Int> , ObservableInt

An ObservableInt whose value is the size of an ObservableSet.

SetChange

interface SetChange<E>

The data describing changes to an ObservableSet.

SetChangeListener

interface SetChangeListener<E>

When programming in the typical Kotlin style, this isn't used, because you'll use a lambda instead.

WeakListChangeListener

class WeakListChangeListener<out E>(wraps: ListChangeListener<E>) : ListChangeListener<E>

Using weak listeners can help prevent memory leaks.

WeakSetChangeListener

class WeakSetChangeListener<E>(wraps: SetChangeListener<E>) : SetChangeListener<E>

Using weak listeners can help prevent memory leaks.

Functions

asMutableObservableList

fun <E> MutableList<E>.asMutableObservableList(): MutableObservableList<E>

Wraps a regular list, creating a MutableObservableList.

asMutableObservableSet

fun <E> MutableSet<E>.asMutableObservableSet(): MutableObservableSet<E>

asObservableList

fun <E> List<E>.asObservableList(): ObservableList<E>

Wraps a regular list, creating a MutableObservableList.

emptyObservableList

fun <E> emptyObservableList(): ObservableList<E>

emptyObservableSet

fun <E> emptyObservableSet(): ObservableSet<E>

isEmptyProperty

fun ObservableList<*>.isEmptyProperty(): ObservableBoolean

fun ObservableSet<*>.isEmptyProperty(): ObservableBoolean

isNotEmptyProperty

fun ObservableList<*>.isNotEmptyProperty(): ObservableBoolean

fun ObservableSet<*>.isNotEmptyProperty(): ObservableBoolean

listChangeListener

fun <E> listChangeListener(lambda: (list: ObservableList<E>, change: ListChange<E>) -> Unit): ListChangeListener<E>

setChangeListener

fun <E> setChangeListener(lambda: (list: ObservableSet<E>, change: SetChange<E>) -> Unit): SetChangeListener<E>

sizeProperty

fun ObservableList<*>.sizeProperty(): ObservableInt

fun ObservableSet<*>.sizeProperty(): ObservableInt

syncWith

fun <E> MutableObservableList<E>.syncWith(other: MutableObservableList<out E>): ListChangeListener<E>

Sync this mutable list with other. Returns a ListChangeListener for this list. To stop syncing, remove the listener using MutableObservableList.removeListener. As Glok uses weak references for listeners, you must keep a reference to this listener, otherwise the garbage collector will end the sync.