PaneScaffoldHorizontalOrder

Known direct subclasses
ThreePaneScaffoldHorizontalOrder

Represents the horizontal order of panes in a ThreePaneScaffold from start to end.


Represents the horizontal order of panes in a pane scaffold. An implementation of this interface is supposed to represent an 1-to-1 mapping between all the possible pane roles supported by the associated pane scaffold, and those panes' index in the order. For example, ThreePaneScaffoldHorizontalOrder represents an order of three panes supported by the three pane scaffold implementations like ListDetailPaneScaffold and SupportingPaneScaffold.

Summary

Public functions

Unit
forEach(action: (Role) -> Unit)

Performs the given action for each pane in the order.

Cmn
Unit
forEachIndexed(action: (Int, Role) -> Unit)

Performs the given action for each pane in the order, with its index.

Cmn
Unit
forEachIndexedReversed(action: (Int, Role) -> Unit)

Performs the given action for each pane in the order, with its index, in reverse order.

Cmn
Int
indexOf(role: Role)

Returns the index of the given role in the order.

Cmn

Public properties

Int

The number of panes in the order.

Cmn

Public functions

forEach

fun forEach(action: (Role) -> Unit): Unit

Performs the given action for each pane in the order.

forEachIndexed

fun forEachIndexed(action: (Int, Role) -> Unit): Unit

Performs the given action for each pane in the order, with its index.

forEachIndexedReversed

fun forEachIndexedReversed(action: (Int, Role) -> Unit): Unit

Performs the given action for each pane in the order, with its index, in reverse order.

indexOf

fun indexOf(role: Role): Int

Returns the index of the given role in the order.

Public properties

size

val sizeInt

The number of panes in the order.