GenericDismissiblePanel

A panel that can be dismissed, either through user interaction or other events. Dismissing a panel will set requestsRemoval to true. This causes it to be removed from the frontend, preventing it from being shown again.

Parameters

frontendContext

An entry point for this GenericPanel to communicate with the rest of the system.

Inheritors

Types

Link copied to clipboard
abstract class Always<C : PanelContext>(frontendContext: FrontendContext) : GenericDismissiblePanel<C>

A panel that always allows to be dismissed.

Link copied to clipboard
abstract class Optional<C : PanelContext>(frontendContext: FrontendContext, val isDismissible: Boolean) : GenericDismissiblePanel<C>

A panel that checks that isDismissible is true before executing dismiss.

Properties

Link copied to clipboard

The dismissal state of this panel.

Link copied to clipboard
open override val requestsRemoval: LiveData<Boolean>

Whether a panel wants to be removed from its frontend.

Inherited properties

Link copied to clipboard
Link copied to clipboard
val id: Long

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.

Link copied to clipboard

true if the panel is currently attached.

Link copied to clipboard
open override val lifecycle: Lifecycle
Link copied to clipboard
val tag: String

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Functions

Link copied to clipboard
open 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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Inherited functions

Link copied to clipboard

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

Link copied to clipboard
operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun getPanelContext(iviFragmentId: IviFragmentId): C

The PanelContext of an IviFragment identified by iviFragmentId.

Link copied to clipboard
override fun hashCode(): Int
Link copied to clipboard

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

Link copied to clipboard
fun onAttached(panelAttachment: PanelAttachment<C>)

Called when the panel is attached to the system UI.

Link copied to clipboard
fun onDetached(panelAttachment: PanelAttachment<C>)

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

Link copied to clipboard

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

Link copied to clipboard
open override fun toString(): String