controls/io.nacular.doodle.controls.list/List

List

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> (source)

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.

Note that this class assumes the given ListModel is immutable and will not automatically respond to changes in the model. See DynamicList or MutableList if this behavior is desirable.

List does not provide scrolling internally, so it should be embedded in a ScrollPanel or similar component if needed.

Parameters

model

that holds the data for this List

itemVisualizer

that maps T to View for each item in the List

selectionModel

that manages the List's selection state

fitContent

determines whether the List scales to fit its items' width or total height

scrollCache

determining how many "hidden" items are rendered above and below the List's view-port. A value of 0 means only visible items are rendered, but quick scrolling is more likely to show blank areas.

Inheritors

Constructors

constructor(model: M, itemVisualizer: ItemVisualizer<T, IndexedItem>? = null, selectionModel: SelectionModel<Int>? = null, fitContent: Set<Dimension> = setOf(Width, Height), scrollCache: Int = 0)

Types

object Companion

Properties

var acceptsThemes: Boolean

accessibilityDescriptionProvider

var accessibilityDescriptionProvider: View?

accessibilityLabel

var accessibilityLabel: String?

accessibilityLabelProvider

var accessibilityLabelProvider: View?

accessibilityRole

var accessibilityRole: AccessibilityRole?

backgroundColor

var backgroundColor: Color?

var behavior: ListBehavior<T>?

Controls how the List behaves and how its items are rendered. A List will not render without a behavior specified.

var boundingBox: Rectangle

override var bounds: Rectangle

val boundsChanged: PropertyObservers<View, Rectangle>

var camera: Camera

val cameraChanged: PropertyObservers<View, Camera>

var cellAlignment: ConstraintDslContext.(Bounds) -> Unit?

Defines how the contents of an item should be aligned within it.

protected open val children: ObservableList<View>

childrenChanged

protected val childrenChanged: Pool<ChildObserver<View>>

childrenClipPath

protected var childrenClipPath: View.ClipPath?

clipCanvasToBounds

protected var clipCanvasToBounds: Boolean

contentDirection

val contentDirection: ContentDirection

contentDirectionChanged

val contentDirectionChanged: ChangeObservers<View>

var cursor: Cursor?

val cursorChanged: PropertyObservers<View, Cursor?>

val displayChange: BooleanObservers

val displayed: Boolean

val displayRect: Rectangle

displayRectHandlingChanged

val displayRectHandlingChanged: BooleanObservers

var dragRecognizer: DragRecognizer?

var dropReceiver: DropReceiver?

var enabled: Boolean

val enabledChanged: BooleanObservers

val firstRender: ChangeObservers<View>

firstSelectable

open override val firstSelectable: Int?

open override val firstSelection: Int?

firstVisibleItem

protected var firstVisibleItem: Int

focusabilityChanged

val focusabilityChanged: BooleanObservers

open var focusable: Boolean

val focusChanged: BooleanObservers

protected val focusCycleRoot: View?

focusTraversalPolicy

protected open var focusTraversalPolicy: FocusTraversalPolicy?

var font: Font?

foregroundColor

var foregroundColor: Color?

var hasFocus: Boolean

override var height: Double

override var idealSize: Size?

open override var insets: Insets

val isEmpty: Boolean

isFocusCycleRoot

open override var isFocusCycleRoot: Boolean

val itemVisualizer: ItemVisualizer<T, IndexedItem>? = null

that maps T to View for each item in the List

val keyChanged: Pool<KeyListener>

val keyFilter: Pool<KeyListener>

open override val lastSelectable: Int?

open override val lastSelection: Int?

lastVisibleItem

protected var lastVisibleItem: Int

protected open var layout: Layout?

localContentDirection

var localContentDirection: ContentDirection?

override var minimumSize: Size

val mirrored: Boolean

mirrorWhenRightLeft

var mirrorWhenRightLeft: Boolean

protected open val model: M

that holds the data for this List

monitorsDisplayRect

var monitorsDisplayRect: Boolean

nextInAccessibleReadOrder

var nextInAccessibleReadOrder: View?

open override val numItems: Int

var opacity: Float

val opacityChanged: PropertyObservers<View, Float>

var parent: View?

val parentChange: PropertyObservers<View, View?>

val pointerChanged: Pool<PointerListener>

val pointerFilter: Pool<PointerListener>

pointerMotionChanged

val pointerMotionChanged: Pool<PointerMotionListener>

pointerMotionFilter

val pointerMotionFilter: Pool<PointerMotionListener>

pointerMotionPassedThrough

val pointerMotionPassedThrough: Pool<PointerMotionListener>

pointerPassedThrough

val pointerPassedThrough: Pool<PointerListener>

override var position: Point

var rendered: Boolean

open override val selection: Set<Int>

selectionAnchor

open override val selectionAnchor: Int?

selectionChanged

val selectionChanged: SetObservers<List<T, M>, Int>

Notifies of changes to the List's selection.

protected val selectionModel: SelectionModel<Int>? = null

that manages the List's selection state only visible items are rendered, but quick scrolling is more likely to show blank areas.

override var size: Size

sizePreferencesChanged

val sizePreferencesChanged: PropertyObservers<View, View.SizePreferences>

val styleChanged: ChangeObservers<View>

var toolTipText: String

open var transform: AffineTransform

transformChanged

val transformChanged: PropertyObservers<View, AffineTransform>

visibilityChanged

val visibilityChanged: BooleanObservers

override var visible: Boolean

override var width: Double

override var x: Double

override var y: Double

var zOrder: Int

Functions

protected open override fun addedToDisplay()

open override fun addSelection(items: Set<Int>)

protected open infix fun ancestorOf(view: View): Boolean

protected open fun child(at: Point): View?

open override fun clearSelection()

fun contains(value: T): Boolean

protected operator fun contains(child: View): Boolean

open operator override fun contains(point: Point): Boolean

contentDirectionChanged

protected fun contentDirectionChanged()

protected fun cursorChanged(old: Cursor?, new: Cursor?)

protected open fun doLayout()

protected fun enabledChanged(old: Boolean, new: Boolean, filter: (View) -> Boolean)

protected open fun filterKeyEvent(event: KeyEvent)

filterPointerEvent

protected open fun filterPointerEvent(event: PointerEvent)

filterPointerMotionEvent

protected open fun filterPointerMotionEvent(event: PointerEvent)

fun fromAbsolute(point: Point): Point

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

Returns the item at index if one exists, null otherwise.

operator fun get(traversalType: FocusTraversalPolicy.TraversalType): Set<KeyState>?

handleDisplayRectEvent

protected open override fun handleDisplayRectEvent(old: Rectangle, new: Rectangle)

protected open fun handleKeyEvent(event: KeyEvent)

handlePointerEvent

protected open fun handlePointerEvent(event: PointerEvent)

handlePointerMotionEvent

protected open fun handlePointerMotionEvent(event: PointerEvent)

open infix fun intersects(point: Point): Boolean

protected fun layout(view: View, item: T, index: Int)

open override fun next(after: Int): Int?

open override fun previous(before: Int): Int?

protected open fun relayout()

removedFromDisplay

protected open override fun removedFromDisplay()

removeSelection

open override fun removeSelection(items: Set<Int>)

open override fun render(canvas: Canvas)

fun rerenderNow()

protected fun revalidate()

fun scrollTo(item: Int)

Scrolls item into view if the List is within a ScrollPanel.

scrollToSelection

fun scrollToSelection()

Scrolls the last selected item into view if the List is within a ScrollPanel.

open override fun selectAll()

open override fun selected(item: Int): Boolean

operator fun set(traversalType: FocusTraversalPolicy.TraversalType, keyStates: Set<KeyState>?)

open override fun setSelection(items: Set<Int>)

shouldHandlePointerEvent

protected open fun shouldHandlePointerEvent(event: PointerEvent): Boolean

shouldHandlePointerMotionEvent

protected open fun shouldHandlePointerMotionEvent(event: PointerEvent): Boolean

shouldYieldFocus

open fun shouldYieldFocus(): Boolean

protected fun styleChanged(filter: (View) -> Boolean)

fun toAbsolute(point: Point): Point

toggleSelection

open override fun toggleSelection(items: Set<Int>)

fun toLocal(point: Point, from: View?): Point

open fun toolTipText(for: PointerEvent): String

fun toParent(point: Point): Point

protected fun update(children: MutableList<View>, index: Int)

updateVisibleHeight

protected fun updateVisibleHeight()