ThreePaneScaffoldHorizontalOrder

class ThreePaneScaffoldHorizontalOrder internal constructor(
    internal val firstPane: ThreePaneScaffoldRole,
    internal val secondPane: ThreePaneScaffoldRole,
    internal val thirdPane: ThreePaneScaffoldRole,
) : PaneScaffoldHorizontalOrder<ThreePaneScaffoldRole>

Represents the horizontal order of panes in a ThreePaneScaffold from start to end. Currently this class only have two possible instances, i.e. ListDetailPaneScaffoldDefaults.PaneOrder and SupportingPaneScaffoldDefaults.PaneOrder, which will be used internally by ListDetailPaneScaffold and SupportingPaneScaffold respectively.

Note that this class is not supposed to be used directly by developers. It's defined as public to support ThreePaneScaffoldOverride, which can be replaced in the future by other mechanisms. By then we will hide this class as well.

Properties

size

override val size = 3

Functions

get

operator fun get(index: Int) =
        when (index) {
            0 -> firstPane
            1 -> secondPane
            2 -> thirdPane
            else -> throw IndexOutOfBoundsException("Invalid pane index $index")
        }

indexOf

override fun indexOf(role: ThreePaneScaffoldRole) =
        when (role) {
            firstPane -> 0
            secondPane -> 1
            thirdPane -> 2
            else -> -1
        }

forEach

override fun forEach(action: (ThreePaneScaffoldRole) -> Unit)

forEachIndexed

override fun forEachIndexed(action: (Int, ThreePaneScaffoldRole) -> Unit)

forEachIndexedReversed

override fun forEachIndexedReversed(action: (Int, ThreePaneScaffoldRole) -> Unit)

equals

override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int