ThreePaneScaffoldValue


The adapted value of ThreePaneScaffold. It contains each pane's adapted value. ThreePaneScaffold will use the adapted values to decide which panes should be displayed and how they should be displayed. With other input parameters of ThreePaneScaffold fixed, each possible instance of this class should represent a unique state of ThreePaneScaffold and developers can compare two ThreePaneScaffoldValue to decide if there is a layout structure change.

For a Material-opinionated layout, it's suggested to use calculateThreePaneScaffoldValue to calculate the current scaffold value.

Summary

Public constructors

ThreePaneScaffoldValue(
    primary: PaneAdaptedValue,
    secondary: PaneAdaptedValue,
    tertiary: PaneAdaptedValue
)

create an instance of ThreePaneScaffoldValue

Cmn

Public functions

open operator Boolean
equals(other: Any?)
Cmn
open operator PaneAdaptedValue

Returns the PaneAdaptedValue of the given role of a pane.

Cmn
open Int
Cmn
open String
Cmn

Public properties

open PaneExpansionStateKey

The key that represents the unique state of the provider to index PaneExpansionState.

Cmn
PaneAdaptedValue

PaneAdaptedValue of the primary pane of ThreePaneScaffold

Cmn
PaneAdaptedValue

PaneAdaptedValue of the secondary pane of ThreePaneScaffold

Cmn
PaneAdaptedValue

PaneAdaptedValue of the tertiary pane of ThreePaneScaffold

Cmn

Public constructors

ThreePaneScaffoldValue

ThreePaneScaffoldValue(
    primary: PaneAdaptedValue,
    secondary: PaneAdaptedValue,
    tertiary: PaneAdaptedValue
)

create an instance of ThreePaneScaffoldValue

Parameters
primary: PaneAdaptedValue

PaneAdaptedValue of the primary pane of ThreePaneScaffold

secondary: PaneAdaptedValue

PaneAdaptedValue of the secondary pane of ThreePaneScaffold

tertiary: PaneAdaptedValue

PaneAdaptedValue of the tertiary pane of ThreePaneScaffold

Public functions

equals

open operator fun equals(other: Any?): Boolean

get

open operator fun get(role: ThreePaneScaffoldRole): PaneAdaptedValue

Returns the PaneAdaptedValue of the given role of a pane.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

paneExpansionStateKey

open val paneExpansionStateKeyPaneExpansionStateKey

The key that represents the unique state of the provider to index PaneExpansionState.

primary

val primaryPaneAdaptedValue

PaneAdaptedValue of the primary pane of ThreePaneScaffold

secondary

val secondaryPaneAdaptedValue

PaneAdaptedValue of the secondary pane of ThreePaneScaffold

tertiary

val tertiaryPaneAdaptedValue

PaneAdaptedValue of the tertiary pane of ThreePaneScaffold