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

ControlCenterPanel

abstract class ControlCenterPanel(frontendContext: FrontendContext, val type: ControlCenterPanel.Type) : GenericPanel<PanelContext>

A panel for an isolated area of the system UI that provides persistent indicators and controls that are accessible to the user at all times.

Parameters

frontendContext

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

type

Indicates what type of contents this control center panel instance is responsible for. This can be used by the system UI to determine where to show the panel.

Constructors

ControlCenterPanel

fun ControlCenterPanel(frontendContext: FrontendContext, type: ControlCenterPanel.Type)

Types

Type

enum Type : Enum<ControlCenterPanel.Type>

Indicates what type of contents a control center panel is responsible for.

Properties

type

val type: ControlCenterPanel.Type

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.

isOccluded

val isOccluded: LiveData<Boolean?>

Whether the panel is partially or fully occluded:

panelContext

override val panelContext: LiveData<PanelContext?>

The PanelContext given when the panel is attached to the system UI.

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(): Fragment

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

equals

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

getLifecycle

open override fun getLifecycle(): Lifecycle

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

@CallSuper

open fun onAttached(panelContext: PanelContext)

Called when the panel is attached to the system UI. The panel may be detached and attached multiple times, for example on configuration changes. However, a panel will never be attached multiple times at once.

onDetached

@CallSuper

open fun onDetached()

Called when the panel has been detached from the system UI. The panel may be attached again later, for example when the configuration changes.

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