PaneExpansionState
This class manages the pane expansion state for pane scaffolds. By providing and modifying an instance of this class, you can specify the expanded panes' expansion width or proportion when pane scaffold is displaying a dual-pane layout.
This class also serves as the DraggableState of pane expansion handle. When a handle implementation is provided to the associated pane scaffold, the scaffold will use PaneExpansionState to store and manage dragging and anchoring of the handle, and thus the pane expansion state.
Summary
Constants |
||
|---|---|---|
const Int |
The constant value used to denote the pane expansion is not specified. |
Cmn
|
Public functions |
||
|---|---|---|
Unit |
clear()Clears any previously set |
Cmn
|
Boolean |
Returns |
Cmn
|
Unit |
setFirstPaneProportion(Set the proportion of the first expanded pane in the layout. |
Cmn
|
Unit |
setFirstPaneWidth(firstPaneWidth: Int)Set the width of the first expanded pane in the layout. |
Cmn
|
Constants
Unspecified
const val Unspecified: Int
The constant value used to denote the pane expansion is not specified.
Public functions
clear
fun clear(): Unit
Clears any previously set firstPaneWidth or firstPaneProportion, as well as the user dragging result.
isUnspecified
fun isUnspecified(): Boolean
Returns true if none of firstPaneWidth or firstPaneProportion has been set.
setFirstPaneProportion
fun setFirstPaneProportion(
firstPaneProportion: @FloatRange(from = 0.0, to = 1.0) Float
): Unit
Set the proportion of the first expanded pane in the layout. The set value needs to be within the range of [0f, 1f], otherwise the setter throws.
Note that setting this value will reset the first pane width previously set via setFirstPaneWidth or the current dragging result if there's any. Also if user drags the pane after setting the first pane proportion, the user dragging result will take the priority over this set value when rendering panes, but the set value will be saved.
setFirstPaneWidth
fun setFirstPaneWidth(firstPaneWidth: Int): Unit
Set the width of the first expanded pane in the layout. When the set value gets applied, it will be coerced within the range of [0, the full displayable width of the layout].
Note that setting this value will reset the first pane proportion previously set via setFirstPaneProportion or the current dragging result if there's any. Also if user drags the pane after setting the first pane width, the user dragging result will take the priority over this set value when rendering panes, but the set value will be saved.