ThreePaneScaffoldRole
-
Cmn
enum ThreePaneScaffoldRole : Enum
The set of the available pane roles of ThreePaneScaffold.
Summary
Enum Values |
|
|---|---|
Primary |
The primary pane of |
Secondary |
The secondary pane of |
Tertiary |
The tertiary pane of |
Public functions |
||
|---|---|---|
ThreePaneScaffoldRole |
Returns the enum constant of this type with the specified name. |
Cmn
|
Array<ThreePaneScaffoldRole> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Cmn
|
Public properties |
||
|---|---|---|
EnumEntries<ThreePaneScaffoldRole> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
Cmn
|
Enum Values
Primary
val ThreePaneScaffoldRole.Primary: ThreePaneScaffoldRole
The primary pane of ThreePaneScaffold. It is supposed to have the highest priority during layout adaptation and usually contains the most important content of the screen, like content details in a list-detail settings.
Secondary
val ThreePaneScaffoldRole.Secondary: ThreePaneScaffoldRole
The secondary pane of ThreePaneScaffold. It is supposed to have the second highest priority during layout adaptation and usually contains the supplement content of the screen, like content list in a list-detail settings.
Tertiary
val ThreePaneScaffoldRole.Tertiary: ThreePaneScaffoldRole
The tertiary pane of ThreePaneScaffold. It is supposed to have the lowest priority during layout adaptation and usually contains the additional info which will only be shown under user interaction.
Public functions
valueOf
fun valueOf(value: String): ThreePaneScaffoldRole
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<ThreePaneScaffoldRole>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Public properties
entries
val entries: EnumEntries<ThreePaneScaffoldRole>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.