Represents an ongoing edit operation of some View. The operation defines any View associated with the edit and the data that gets returned when completed.

ExpandableItem

interface ExpandableItem : IndexedItem

An indexed item with an expanded state that is often used as the context with ItemVisualizer.

IndexedItem

interface IndexedItem

A selectable item with an index that is often used as the context with ItemVisualizer.

ItemVisualizer

interface ItemVisualizer<T, in C>

Provides a mapping between an item and a View to represent it.

LazyPhoto

@ExperimentalCoroutinesApi

class LazyPhoto(pendingImage: Deferred<Image>, initialized: (imageSize: Size) -> Unit = {}, placeHolder: Canvas.() -> Unit = {}) : View

A simple wrapper around a deferred Image. It renders a placeHolder while the image loads. Then the image is scaled to fit within the bounds of the Photo when it finally loads.

ListModel

interface ListModel<T> : Iterable<T>

Holds data in a list-like structure for use with controls like List.

ListSelectionManager

class ListSelectionManager(selectionModel: SelectionModel<Int>?, numRows: () -> Int) : Selectable<Int>

ModelObserver

typealias ModelObserver<T> = (source: DynamicListModel<T>, Differences<T>) -> Unit

MultiSelectionModel

open class MultiSelectionModel<T> : SelectionModel<T>

MutableListModel

interface MutableListModel<T> : DynamicListModel<T>

A ListModel model that lets callers modify it.

Photo

class Photo(image: Image) : View

A simple wrapper around an Image. The image is scaled to fit within the bounds of this Photo when drawn.

ProgressBar

class ProgressBar(model: ConfinedValueModel<Double> = BasicConfinedValueModel(0.0 .. 100.0), val orientation: Orientation = Horizontal) : ProgressIndicator

Represents a progress indicator that can be Horizontal or Vertical.

ProgressIndicator

abstract class ProgressIndicator(model: ConfinedValueModel<Double>, role: RangeRole = ProgressBarRole()) : View

Control that shows progress of some activity. That progress comes via the model. Changes to the model will update the control.

ScrollPanelVisualizer

open class ScrollPanelVisualizer : ItemVisualizer<View, Any>

Places the item (which is a View) within a ScrollPanel.

Selectable

interface Selectable<T>

Created by Nicholas Eddy on 3/19/18.

SelectionModel

interface SelectionModel<T> : Iterable<T>

SimpleIndexedItem

open class SimpleIndexedItem(val index: Int, val selected: Boolean) : IndexedItem

SimpleListModel

open class SimpleListModel<T>(list: List<T>) : ListModel<T>

ListModel based directly on a List.

SimpleMutableListModel

open class SimpleMutableListModel<T>(list: ObservableList<T>) : SimpleListModel<T> , MutableListModel<T>

MutableListModel based directly on an ObservableList.

SingleItemSelectionModel

class SingleItemSelectionModel<T> : MultiSelectionModel<T>

StarRater

class StarRater(max: Int = 5, displayRounded: Float = 0.0f, pathMetrics: PathMetrics? = null) : View

Creates a control that shows a star rating.

StringVisualizer

open class StringVisualizer(fitText: Set<Dimension>? = null) : ItemVisualizer<String, Any>

Visualizes Strings using Labels.

StyledTextVisualizer

open class StyledTextVisualizer(fitText: Set<Dimension>? = null) : ItemVisualizer<StyledText, Any>

Visualizes StyledText using Labels.

ViewVisualizer

object ViewVisualizer : ItemVisualizer<View, Any>

Simply uses the item (which is a View) as its own visualizer

Functions

after

fun <T, R, C> ItemVisualizer<R, C>.after(mapper: (T) -> R): ItemVisualizer<T, C>

Creates a visualizer for T using a visualizer for R by mapping T -> R.

bind

fun <T : Number, Comparable<T>> RangeRole.bind(model: ConfinedValueModel<T>): Binding

Creates a binding between the role and model, keeping the role synchronized with the given model

binding

fun binding(initial: Binding): ReadWriteProperty<Any, Binding>

Tracks a Binding and unbinds it when a new one replaces it.

invoke

operator fun <T> ItemVisualizer<T, Any>.invoke(item: T, previous: View? = null): View

itemVisualizer

inline fun <T, C> itemVisualizer(crossinline block: (item: T, previous: View?, context: C) -> View): ItemVisualizer<T, C>

Creates an ItemVisualizer from the given lambda.

mutableListModelOf

fun <T> mutableListModelOf(vararg elements: T): MutableListModel<T>

Creates a MutableListModel from the given set of elements.

sort

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

sortDescending

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

toString

fun <T, C> toString(delegate: ItemVisualizer<String, C>, mapper: (T) -> String = { "$it" }): ItemVisualizer<T, C>

Visualizes a string representation of the item (obtained from mapper) using delegate.