Unique identifier of a GenericPanel. Each ID is an increment of the previously created panel's ID, allowing this value to be used for sorting purposes.

isAttached

var isAttached: Boolean

true if the panel is currently attached.

isDismissible

val isDismissible: Boolean

lifecycle

open override val lifecycle: Lifecycle

requestsRemoval

open override val requestsRemoval: LiveData<Boolean>

Whether a panel wants to be removed from its frontend.

tag

val tag: String

The tag to recognise this panel with. Useful in combination with fragment tags to detect which fragment belongs to which panel.

transitionDestination

var transitionDestination: PanelTransitionDestination?

A destination that the information contained by this panel transitions to when this panel closes. By default it is null, indicating the information does not transition anywhere.

transitionSource

var transitionSource: PanelTransitionSource?

The source of the information contained by this panel when the information transitions from another panel to this one. By default it is null, indicating the information does not transition from any other particular panel.

Inherited functions

createInitialFragment

fun createInitialFragment(): IviFragment<*, *>

The fragment used when initially showing the panel. The fragment may be recreated by the system UI upon configuration changes.

dismiss

override fun dismiss()

Dismisses the panel. After this requestsRemoval will be set to true, causing the panel to be removed from its frontend through onRemovedFromFrontend. This destroys the lifecycle and prevents the panel from being shown again.

equals

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

getPanelContext

@CallSuper

open override fun getPanelContext(iviFragmentId: IviFragmentId): CommonPanelContext

The PanelContext of an IviFragment identified by iviFragmentId.

hashCode

override fun hashCode(): Int

onAddedToFrontend

@CallSuper

open fun onAddedToFrontend()

Called when this panel is added to Frontend.panels, allowing it to be shown in the system UI.

onAttached

@MainThread

fun onAttached(panelAttachment: PanelAttachment<CommonPanelContext>)

Called when the panel is attached to the system UI.

onDetached

@MainThread

fun onDetached(panelAttachment: PanelAttachment<CommonPanelContext>)

Called when the panel has been detached from the system UI.

onDismissalCompleted

fun onDismissalCompleted()

Called when the panel has been dismissed from the system UI, either through user interaction or other events. This causes requestsRemoval to be set to true. The panel will be removed from its frontend, causing onRemovedFromFrontend to be called. This destroys the lifecycle and prevents the panel from being shown again.

onDismissalStarted

fun onDismissalStarted()

Called when the panel is being dismissed from the system UI, either through user interaction or other events. At this point the panel may still be visible due to the panel's exit animation.

onRemovedFromFrontend

@CallSuper

open fun onRemovedFromFrontend()

Called when this panel is removed from Frontend.panels, preventing it from being shown in the system UI.

toString

open override fun toString(): String