platform_systemui_api_common_frontendcoordinator/com.tomtom.ivi.platform.systemui.api.common.frontendcoordinator/IviPanelRegistry/Builder

Builder

class Builder(panels: LiveData<Collection<AnyPanel>>, lifecycleOwner: LifecycleOwner, iviServiceProvider: IviInstanceBoundIviServiceProvider)

A builder that creates a IviPanelRegistry from panels using the default logic to determine which panels to show.

The logic for determining the value of each individual IviPanelRegistry field can be replaced by proving a different LiveData for a certain panel. If left null, the default logic will be used. In order to not use any panel for a certain property, EmptyLiveData can be set.

The default logic for some panel types makes use of data from services. To allow the builder to make service connections, lifecycleOwner and iviServiceProvider must be provided.

Parameters

panels

The panels used by the default logic that determines which Panels to show. To easily extract panels from a FrontendRegistry or collection of Frontends, see extractPanels.

lifecycleOwner

The LifecycleOwner used for service connections, necessary for the default logic of deciding which panels to show.

iviServiceProvider

The service provider used for service connections, necessary for the default logic of deciding which panels to show.

Constructors

Builder

fun Builder(panels: LiveData<Collection<AnyPanel>>, lifecycleOwner: LifecycleOwner, iviServiceProvider: IviInstanceBoundIviServiceProvider)

Properties

controlCenterPanels

var controlCenterPanels: LiveData<PanelList<ControlCenterPanel>>? = null

The active ControlCenterPanels to pass to the IviPanelRegistry. If left null, all ControlCenterPanel instances from the given Panel collection are considered active.

debugPanel

var debugPanel: LiveData<DebugPanel?>? = null

The active DebugPanel to pass to the IviPanelRegistry. If left null, a single DebugPanel instance is picked from the given Panel collection, assuming only a single Frontend will offer a DebugPanel.

expandedProcessPanel

var expandedProcessPanel: LiveData<ExpandedProcessPanel?>? = null

The active ExpandedProcessPanel to pass to the IviPanelRegistry. If left null, a single ExpandedProcessPanel instance is picked from the given Panel collection. If multiple Frontends offer an ExpandedProcessPanel, the most recent one is selected.

guidancePanel

var guidancePanel: LiveData<GuidancePanel?>? = null

The active GuidancePanel to pass to the IviPanelRegistry. If left null, a single GuidancePanel instance is picked from the given Panel collection, assuming only a single Frontend will offer a GuidancePanel.

homePanel

var homePanel: LiveData<HomePanel?>? = null

The active HomePanel to pass to the IviPanelRegistry. If left null, a single HomePanel instance is picked from the given Panel collection, assuming only a single Frontend will offer a HomePanel.

mainMenuPanel

var mainMenuPanel: LiveData<MainMenuPanel?>? = null

The active MainMenuPanel to pass to the IviPanelRegistry. If left null, a single MainMenuPanel instance is picked from the given Panel collection, assuming only a single Frontend will offer a MainMenuPanel.

mainProcessPanel

var mainProcessPanel: LiveData<MainProcessPanel?>? = null

The active MainProcessPanel to pass to the IviPanelRegistry. If left null, a single MainProcessPanel instance is picked from the given Panel collection. If multiple Frontends offer a MainProcessPanel, the most recent one with the highest MainProcessPanel.Priority is selected.

modalPanelStackData

var modalPanelStackData: LiveData<ModalPanelStackData>? = null

The active ModalPanelStackData to pass to the IviPanelRegistry. If left null, the ModalPanels from the Frontend that contains the most recently opened ModalPanel within the given Panel collection will be used to form the stack.

notificationPanelData

var notificationPanelData: LiveData<NotificationPanelData>? = null

The active NotificationPanelDatas to pass to the IviPanelRegistry. If left null, NotificationPanel instances from the given Panel collection are filtered using the state of the NotificationDisplayService to determined which NotificationPanels are active.

overlayPanels

var overlayPanels: LiveData<PanelList<OverlayPanel>>? = null

The active OverlayPanels to pass to the IviPanelRegistry. If left null, all OverlayPanel instances from the given Panel collection are considered active.

searchPanel

var searchPanel: LiveData<SearchPanel?>? = null

The active SearchPanel to pass to the IviPanelRegistry. If left null, a single SearchPanel instance is picked from the given Panel collection, assuming only a single Frontend will offer a SearchPanel.

settingsPanel

var settingsPanel: LiveData<SettingsPanel?>? = null

The active SettingsPanel to pass to the IviPanelRegistry. If left null, a single SettingsPanel instance is picked from the given Panel collection, assuming only a single Frontend will offer a SettingsPanel.

taskPanelStackData

var taskPanelStackData: LiveData<TaskPanelStackData>? = null

The active TaskPanelStackData to pass to the IviPanelRegistry. If left null, the TaskPanels from the Frontend that contains the most recently opened TaskPanel within the given Panel collection will be used to form the stack.

Functions

build

fun build(): IviPanelRegistry

Builds the IviPanelRegistry using the provided information. Panel fields left to null will be set using the default logic.