platform_systemui_api_common_frontendcoordinator/com.tomtom.ivi.platform.systemui.api.common.frontendcoordinator.frontendcoordination

Package com.tomtom.ivi.platform.systemui.api.common.frontendcoordinator.frontendcoordination

Types

CloseExpandedProcessPanelsOnMenuItemClickFrontendCoordinationRule

class CloseExpandedProcessPanelsOnMenuItemClickFrontendCoordinationRule : ClosePanelsOnMenuItemClickFrontendCoordinationRule<ExpandedProcessPanel>

A rule that ensures ExpandedProcessPanels are closed when a system UI menu item is clicked.

CloseExpandedProcessPanelsOnTaskPanelChangeFrontendCoordinationRule

class CloseExpandedProcessPanelsOnTaskPanelChangeFrontendCoordinationRule(activeTaskPanelStackData: LiveData<TaskPanelStackData>) : ClosePanelsOnTaskPanelChangeFrontendCoordinationRule<ExpandedProcessPanel>

A rule that ensures ExpandedProcessPanels are closed when the active TaskPanels change.

CloseModalPanelsOnMenuItemClickFrontendCoordinationRule

class CloseModalPanelsOnMenuItemClickFrontendCoordinationRule : ClosePanelsOnMenuItemClickFrontendCoordinationRule<ModalPanel>

A rule that ensures ModalPanels are closed when a system UI menu item is clicked.

CloseModalPanelsOnTaskPanelChangeFrontendCoordinationRule

class CloseModalPanelsOnTaskPanelChangeFrontendCoordinationRule(activeTaskPanelStackData: LiveData<TaskPanelStackData>) : ClosePanelsOnTaskPanelChangeFrontendCoordinationRule<ModalPanel>

A rule that ensures ModalPanels are closed when the active TaskPanels change.

ClosePanelsOnMenuItemClickFrontendCoordinationRule

open class ClosePanelsOnMenuItemClickFrontendCoordinationRule(panelClass: KClass) : FrontendCoordinationRule

A rule that ensures Panels of type P are closed when a system UI menu item is clicked.

ClosePanelsOnTaskPanelChangeFrontendCoordinationRule

open class ClosePanelsOnTaskPanelChangeFrontendCoordinationRule(panelClass: KClass, activeTaskPanelStackData: LiveData<TaskPanelStackData>) : FrontendCoordinationRule

A rule that ensures Panels of type P are closed when the active TaskPanels change.

DefaultFrontendCoordinationRules

object DefaultFrontendCoordinationRules

Provides the default FrontendCoordinationRules used by TomTom Digital Cockpit's system UI. These include menu item management, syncing notification information with the system, and closing TaskPanels and ModalPanels when needed.

FocusMenuItemOnTaskPanelChangeFrontendCoordinationRule

class FocusMenuItemOnTaskPanelChangeFrontendCoordinationRule( getMenuItemId: (FrontendContext) -> MenuItem.Id?, activeHomePanel: LiveData<HomePanel?>, activeTaskPanelStackData: LiveData<TaskPanelStackData>) : FrontendCoordinationRule

A rule that informs the MenuService of the focused menu item based on which Panels are active. When there is an activeTaskPanelStackData, the corresponding Frontend's menu item is focused. Otherwise, the menu item of the Frontend that owns the activeHomePanel is focused.

FrontendCoordinationRule

interface FrontendCoordinationRule

An interface for business logic that coordinates the Frontends within a system UI. Such rules commonly trigger Panels within a Frontend to open or close or update services with information derived from Frontends and their Panels.

NotificationDisplayServiceFrontendCoordinationRule

class NotificationDisplayServiceFrontendCoordinationRule(notificationPanelData: LiveData<NotificationPanelData>) : FrontendCoordinationRule

A rule that keeps the information in NotificationDisplayService up-to-date with notificationPanelData.

RegisterMenuItemsFrontendCoordinationRule

class RegisterMenuItemsFrontendCoordinationRule(frontendMetadata: Collection<FrontendMetadata>) : FrontendCoordinationRule

A rule that informs the SystemUiMenuItemsService of the MenuItems in the given frontendMetadata.

SingleExpandedProcessPanelFrontendCoordinationRule

class SingleExpandedProcessPanelFrontendCoordinationRule(activePanel: LiveData<ExpandedProcessPanel?>) : FrontendCoordinationRule

A rule that ensures there is only a single Frontend that shows ExpandedProcessPanels at any time. It does this by closing the ExpandedProcessPanels of other Frontends when a Frontend opens a new ExpandedProcessPanel.

SingleModalPanelStackFrontendCoordinationRule

class SingleModalPanelStackFrontendCoordinationRule(activeModelPanelStackData: LiveData<ModalPanelStackData>) : SinglePanelStackFrontendCoordinationRule<ModalPanel, ModalPanelStackData>

A rule that ensures there is only a single Frontend that shows ModalPanels at any time. It does this by closing the ModalPanels of other Frontends when a Frontend opens a new ModalPanel.

SinglePanelStackFrontendCoordinationRule

open class SinglePanelStackFrontendCoordinationRule>(panelClass: KClass, activeStack: LiveData<S>) : FrontendCoordinationRule

A rule that ensures there is only a single Frontend that shows Panels of type Ps at any time. It does this by closing the Panels of type Ps belonging to other Frontends when a Frontend opens a new one, causing activeStack to change.

SingleTaskPanelStackFrontendCoordinationRule

class SingleTaskPanelStackFrontendCoordinationRule(activeTaskPanelStackData: LiveData<TaskPanelStackData>) : SinglePanelStackFrontendCoordinationRule<TaskPanel, TaskPanelStackData>

A rule that ensures there is only a single Frontend that shows TaskPanels at any time. It does this by closing the TaskPanels of other Frontends when a Frontend opens a new TaskPanel.

ToggleTaskPanelsOnMenuItemClickFrontendCoordinationRule

class ToggleTaskPanelsOnMenuItemClickFrontendCoordinationRule(getOrCreateFrontend: (MenuItem.Id) -> Frontend?) : FrontendCoordinationRule

A rule that responds to system UI menu items being clicked by opening or closing TaskPanels. Depending on the state and behaviour of available Frontends, this rule behaves in the following manner: