ScrollPane

A scrolling view onto content larger than the room it has - a JScrollPane, with the viewport it scrolls and the headers and corners that stay put beside it declared as content.

The pane holds each of its children in one of its own regions - the viewport, the row header, the column header, and each of the four corners - rather than as an indexed child. So every child names the region it goes in, through ScrollPaneScope, and a child naming none is refused. Each region holds one view, so two children naming the same one are refused as well, and a child that goes away releases the region it held:

ScrollPane {
    LongList(modifier = SwingModifier.viewport())
    ColumnTitles(modifier = SwingModifier.columnHeader())
    CornerBadge(modifier = SwingModifier.corner(JScrollPane.UPPER_TRAILING_CORNER))
}

Set a fixed viewport size with modifier = SwingModifier.preferredSize(...).

The scroll position is hoistable state, so the application can read it, drive it, and follow the user's scrolling:

val scroll = rememberScrollState()
Button(text = "To the bottom", onClick = { scroll.y = scroll.maxY })
ScrollPane(state = scroll) {
    LongList(modifier = SwingModifier.viewport())
}

How far the pane scrolls per arrow button and per page, and whether the content is laid out at the viewport's own width or height, are the content's to declare - see ScrollPaneScope.viewport.

Parameters

See also