TableState

A hoistable state holder for what a Table has selected, carrying the gesture that brings one of its rows into view.

Each row is named by its index into the table's rows - the model's own row space, never the position the row is drawn at - so a sort order and a row filter move where a row is shown and leave the index that names it alone.

selectedRowIndices is two-way: assigning it selects those rows, and the user selecting other ones - by click, drag or keyboard - writes them back here. It is snapshot-observable, so reading it inside a composable (or a snapshotFlow collector) subscribes to the user's later selecting as well.

The rows this state names are the composition's own and are re-applied on every pass, so a table driven by a state never stands on a selection the state does not hold, and a row the table's rows do not reach is left out of the selection while it goes on being named here - rows that reach it again show it selected.

revealRow brings one row into view when the application decides to - a row just added, a search hit:

val state = rememberTableState()

Button("Add", onClick = { people = people + Person() })
LaunchedEffect(people) { state.revealRow(people.lastIndex) }
ScrollPane {
    Table(rows = people, state = state, modifier = SwingModifier.viewport()) {
        column("Name") { it.name }
    }
}

rowCount and shownSelectedRowIndices answer for the table instead of for what this state holds. Each reads the bound table where it is called, so what it reports is what the table stands on - which is not always what was declared, since a selection mode narrower than the declaration keeps only part of it and a row filter takes the rows it hides out of the selection. They are not snapshot state, so reading one subscribes to nothing; a composable that has to follow the user reads selectedRowIndices. An unbound state has no table to answer for and reports no rows and nothing selected.

A state drives at most one table: passing it to a second one moves it there and leaves the first unbound.

The order and the widths of the columns are not this state's: Table declares them through its own columnLayout.

Parameters

See also