platform_frontend_api_common_frontend/com.tomtom.ivi.platform.frontend.api.common.frontend.panels/GenericDismissiblePanel

GenericDismissiblePanel

sealed class GenericDismissiblePanel<C : PanelContext> : GenericPanel<C>

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

Always

Optional

Types

Always

abstract class Always<C : PanelContext>(frontendContext: FrontendContext) : GenericDismissiblePanel<C>

A panel that always allows to be dismissed.

Optional

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

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

Properties

dismissalState

val dismissalState: LiveData<DismissalState>

The dismissal state of this panel.

requestsRemoval

open override val requestsRemoval: LiveData<Boolean>

Whether a panel wants to be removed from its frontend.

Inherited properties

frontendContext

val frontendContext: FrontendContext

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.

isAttached

var isAttached: Boolean

true if the panel is currently attached.

lifecycle

open override val lifecycle: Lifecycle

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.

Functions

dismiss

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.

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.