Package-level declarations

Types

Link copied to clipboard
open class DynamicList<T, M : DynamicListModel<T>>(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), scrollCache: Int = 0) : List<T, M>

A List component that renders a potentially mutable list of items of type T using a ListBehavior. Items are obtained via the model and selection is managed via the optional selectionModel. Large ("infinite") lists are supported efficiently, since List recycles the Views generated to render its rows.

Link copied to clipboard
class HorizontalDynamicList<T, M : DynamicListModel<T>>(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), numRows: Int = 1, scrollCache: Int = 0) : DynamicList<T, M>

DynamicList that is intended to display contents horizontally with a configurable number of rows.

Link copied to clipboard
class HorizontalList<T, out M : ListModel<T>>(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), numRows: Int = 1, scrollCache: Int = 0) : List<T, M>

List that is intended to display contents horizontally with a configurable number of rows.

Link copied to clipboard
class HorizontalMutableList<T, M : MutableListModel<T>>(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), numRows: Int = 1, scrollCache: Int = 0) : MutableList<T, M>

MutableList that is intended to display contents horizontally with a configurable number of rows.

Link copied to clipboard
typealias ItemsObserver<T> = (source: List<T, *>, differences: Differences<T>) -> Unit
Link copied to clipboard
open class List<T, out M : ListModel<T>>(val model: M, val itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, val selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), scrollCache: Int = 0) : View, ListLike, Selectable<Int>

A visual component that renders an immutable list of items of type T using a ListBehavior. Items are obtained via the model and selection is managed via the optional selectionModel. Large ("infinite") lists are supported efficiently, since List recycles the Views generated to render its items.

Link copied to clipboard
interface ListBehavior<T> : Behavior<List<T, *>>

Controls how a List behaves and is rendered, by providing key strategies.

Link copied to clipboard
interface ListEditor<T>

Manages editing for a MutableList.

Link copied to clipboard
interface ListLike : Selectable<Int>
Link copied to clipboard
open class MutableList<T, M : MutableListModel<T>>(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), scrollCache: Int = 0) : DynamicList<T, M> , Editable

A DynamicList component that renders a mutable list of items of type T using a ListBehavior. Items are obtained via the model and selection is managed via the optional selectionModel. Large ("infinite") lists are supported efficiently, since List recycles the Views generated to render its items.

Link copied to clipboard
class VerticalDynamicList<T, M : DynamicListModel<T>>(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), numColumns: Int = 1, scrollCache: Int = 0) : DynamicList<T, M>

DynamicList that is intended to display contents vertically with a configurable number of columns.

Link copied to clipboard
class VerticalList<T, out M : ListModel<T>>(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), numColumns: Int = 1, scrollCache: Int = 0) : List<T, M>

List that is intended to display contents vertically with a configurable number of columns.

Link copied to clipboard
class VerticalMutableList<T, M : MutableListModel<T>>(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), numColumns: Int = 1, scrollCache: Int = 0) : MutableList<T, M>

MutableList that is intended to display contents vertically with a configurable number of columns.

Functions

Link copied to clipboard
inline fun <T> itemGenerator(crossinline block: (list: List<T, *>, item: T, index: Int, current: View?) -> View): ListBehavior.ItemGenerator<T>

Creates an ItemGenerator from the given lambda.

Link copied to clipboard
inline fun <T> listEditor(crossinline block: (list: MutableList<T, *>, item: T, index: Int, current: View) -> EditOperation<T>): ListEditor<T>

Creates a ListEditor that calls block to perform its edit operation.