controls/io.nacular.doodle.controls/MutableListModel

MutableListModel

interface MutableListModel<T> : DynamicListModel<T> (source)

A ListModel model that lets callers modify it.

Inheritors

SimpleMutableListModel

Inherited properties

abstract val changed: Pool<ModelObserver<T>>

Notifies of changes to the model

open val isEmpty: Boolean

Indicates whether the model has any contents

abstract val size: Int

Number of elements in the model

Functions

abstract fun add(value: T)

Adds a new value to the end of the model.

abstract fun add(index: Int, value: T)

Inserts a new value to the model at an index.

abstract fun addAll(values: Collection<T>)

Adds values to the end of the model.

abstract fun addAll(index: Int, values: Collection<T>)

Inserts values at index in the model.

abstract fun clear()

Removes all items from the model.

abstract fun notifyChanged(index: Int)

Forces the model to notify listeners that index changed. This is useful when the model has mutable items that change their internal state in some way that observers need to know about. Such changes cannot be detected by the model directly, since it relies on reference comparisons to detect changes.

abstract fun remove(value: T)

Removes value from the model.

abstract fun removeAll(values: Collection<T>)

Removes values from the model.

abstract fun removeAllAt(indexes: Collection<Int>)

Removes all values at the given indexes from the model.

abstract fun removeAt(index: Int): Result<T>

Removes the value at index from the model.

abstract fun replaceAll(values: Collection<T>)

Replaces all values in the model with new items.

abstract fun retainAll(values: Collection<T>)

Keeps only the items in the model that are contained within values.

abstract operator fun set(index: Int, value: T): Result<T>

Set the value at a specific index.

abstract fun <R : Comparable<R>> sortBy(selector: (T) -> R?)

Sorts the contents of the model ascending.

sortByDescending

abstract fun <R : Comparable<R>> sortByDescending(selector: (T) -> R?)

Sorts the contents of the model descending.

abstract fun sortWith(comparator: Comparator<in T>)

Sorts the contents of the model ascending.

sortWithDescending

abstract fun sortWithDescending(comparator: Comparator<in T>)

Sorts the contents of the model descending.

Inherited functions

abstract fun contains(value: T): Boolean

abstract operator fun get(index: Int): Result<T>

abstract operator fun iterator(): Iterator<T>

abstract fun section(range: ClosedRange<Int>): List<T>

fun <T : Comparable<T>> MutableListModel<T>.sort()

fun <T : Comparable<T>> MutableListModel<T>.sortDescending()