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

ToggleTaskPanelsOnMenuItemClickFrontendCoordinationRule

@IviExperimental(reasons = [])

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:

If the menu item's Frontend has a HomePanel, all Frontends' TaskPanels will be closed in order to show the HomePanel.
If the menu item's Frontend has one or more TaskPanels active, all of that Frontend's TaskPanels will be closed in order to effectively close the Frontend.
If the menu item's Frontend did not yet have a TaskPanel active, Frontend.openTaskPanels will be called in order to open one (or more).

Note that this rule does not close other Frontends' TaskPanels after calling Frontend.openTaskPanels. Enforcing only a single active TaskPanel stack can be independently configured, for example through SingleTaskPanelStackFrontendCoordinationRule.

Parameters

getOrCreateFrontend

A function that allows the rule to get a Frontend (creating it if it wasn't yet) based on the clicked MenuItem.Id. May return null when no Frontend belonging to the MenuItem.Id was present in this system UI's Frontend registry.

Constructors

ToggleTaskPanelsOnMenuItemClickFrontendCoordinationRule

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

Functions

activate

open override fun activate(lifecycleOwner: LifecycleOwner, iviServiceProvider: IviInstanceBoundIviServiceProvider, frontends: LiveData<out Collection<Frontend>>)

Actives the rule within the scope of the given lifecycleOwner.