PaneMotion

sealed interface PaneMotion

Interface to specify a custom pane enter/exit motion when a pane's visibility changes.

Properties

type

val type: Type

The type of the motion, like exiting, entering, etc. See Type.

Members

Type

class Type private constructor(val value: Int)

Indicates the current type of pane motion, like if the pane is entering or exiting, or is kept showing or hidden.

Functions

toString

override fun toString(): String

Members

Companion

companion object

Properties

Hidden

val Hidden = Type(0)

Indicates the pane is kept hidden during the current motion.

Exiting

val Exiting = Type(1)

Indicates the pane is exiting or hiding during the current motion.

Entering

val Entering = Type(2)

Indicates the pane is entering or showing during the current motion.

Shown

val Shown = Type(3)

Indicates the pane is keeping being shown during the current motion.

ExitingModal

val ExitingModal = Type(5)

Indicates the pane is exiting or hiding as a modal, i.e., a levitated pane, during the current motion.

EnteringModal

val EnteringModal = Type(6)

Indicates the pane is entering or showing as a modal, i.e., a levitated pane, during the current motion.

Companion

companion object

Properties

NoMotion

val NoMotion: PaneMotion = DefaultImpl("NoMotion", Type.Hidden)

The default pane motion that no animation will be performed.

AnimateBounds

val AnimateBounds: PaneMotion = DefaultImpl("AnimateBounds", Type.Shown)

The default pane motion that will animate panes bounds with the given animation specs during motion. Note that this should only be used when the associated pane is keeping showing during the motion.

EnterFromLeft

val EnterFromLeft: PaneMotion = DefaultImpl("EnterFromLeft", Type.Entering)

The default pane motion that will slide panes in from left. Note that this should only be used when the associated pane is entering - i.e. becoming visible from a hidden state.

EnterFromRight

val EnterFromRight: PaneMotion = DefaultImpl("EnterFromRight", Type.Entering)

The default pane motion that will slide panes in from right. Note that this should only be used when the associated pane is entering - i.e. becoming visible from a hidden state.

EnterFromLeftDelayed

val EnterFromLeftDelayed: PaneMotion = DefaultImpl("EnterFromLeftDelayed", Type.Entering)

The default pane motion that will slide panes in from left with a delay, usually to avoid the interference of other exiting panes. Note that this should only be used when the associated pane is entering - i.e. becoming visible from a hidden state.

EnterFromRightDelayed

val EnterFromRightDelayed: PaneMotion = DefaultImpl("EnterFromRightDelayed", Type.Entering)

The default pane motion that will slide panes in from right with a delay, usually to avoid the interference of other exiting panes. Note that this should only be used when the associated pane is entering - i.e. becoming visible from a hidden state.

ExitToLeft

val ExitToLeft: PaneMotion = DefaultImpl("ExitToLeft", Type.Exiting)

The default pane motion that will slide panes out to left. Note that this should only be used when the associated pane is exiting - i.e. becoming hidden from a visible state.

ExitToRight

val ExitToRight: PaneMotion = DefaultImpl("ExitToRight", Type.Exiting)

The default pane motion that will slide panes out to right. Note that this should only be used when the associated pane is exiting - i.e. becoming hidden from a visible state.

EnterWithExpand

val EnterWithExpand: PaneMotion = DefaultImpl("EnterWithExpand", Type.Entering)

The default pane motion that will expand panes from a zero size. Note that this should only be used when the associated pane is entering - i.e. becoming visible from a hidden state.

ExitWithShrink

val ExitWithShrink: PaneMotion = DefaultImpl("ExitWithShrink", Type.Exiting)

The default pane motion that will shrink panes until it's gone. Note that this should only be used when the associated pane is exiting - i.e. becoming hidden from a visible state.

EnterAsModal

val EnterAsModal: PaneMotion = DefaultImpl("EnterAsModal", Type.EnteringModal)

The default pane motion that will show the pane as a modal. Note that this should only be used when the associated pane is entering into a levitated state from a hidden state.

ExitAsModal

val ExitAsModal: PaneMotion = DefaultImpl("ExitAsModal", Type.ExitingModal)

The default pane motion that will hide the pane as a modal. Note that this should only be used when the associated pane is exiting from a leviated state to a hidden state.