platform_systemui_api_common_systemuihost/com.tomtom.ivi.platform.systemui.api.common.systemuihost.containercontrollers.taskpanel/TaskPanelStackSubContainerController

TaskPanelStackSubContainerController

@IviExperimental(reasons = [])

class TaskPanelStackSubContainerController(@LayoutRes subContainerLayoutId: Int? = null, configureTaskPanelContext: MutableNavigablePanelStackContext.(TaskPanel) -> Unit = {}, configureTaskProcessPanelContext: MutableCommonPanelContext.(TaskProcessPanel) -> Unit = {}) : NavigablePanelStackSubContainerController<TaskPanelStackData, TaskPanelStackSubContainerViewModel, TaskPanel, NavigablePanelStackContext>

The task panel sub-container controller.

This panel container attaches a TaskPanelStackData.stackedPanels and optionally a TaskPanelStackData.taskProcessPanel to a panel sub-container.

For each panel sub-container a layout based on subContainerLayoutId is inflated. If subContainerLayoutId is null then a default FragmentContainerView is used. In this case only TaskPanelStackData.stackedPanels are attached and TaskPanelStackData.taskProcessPanel is ignored and not attached.

If subContainerLayoutId is not null, the TaskPanelStackData.stackedPanels are attached to a panel fragment container with Android view ID ttivi_systemui_taskpanel_subcontainer_taskpanels_stub_id.

The TaskPanelStackData.taskProcessPanel, if any, is attached to a panel fragment container with Android view ID ttivi_systemui_taskpanel_subcontainer_taskprocesspanel_stub_id. If it is not found or if ttivi_systemui_taskpanel_subcontainer_taskpanels_stub_id is not found the TaskPanelStackData.taskProcessPanel is ignored and not attached.

Parameters

configureTaskProcessPanelContext

The CommonPanelContext configurator for TaskProcessPanels. The receiver can be used to configure the CommonPanelContext created for TaskProcessPanels. The configurator is invoked each time a panel context is created for a TaskProcessPanel. A panel context is created when a panel is attached to a panel sub-container. The panel is provided as argument to the configurator.

Constructors

TaskPanelStackSubContainerController

constructor(@LayoutRes subContainerLayoutId: Int? = null, configureTaskPanelContext: MutableNavigablePanelStackContext.(TaskPanel) -> Unit = {}, configureTaskProcessPanelContext: MutableCommonPanelContext.(TaskProcessPanel) -> Unit = {})

Inherited functions

createSubContainer

override fun createSubContainer(panelContainer: ViewGroup, subContainerViewModel: TaskPanelStackSubContainerViewModel, panelContainerViewModel: PanelContainerViewModel<TaskPanelStackData?, TaskPanelStackSubContainerViewModel, TaskPanelStackData>): SubContainerCreation<TaskPanelStackSubContainerViewModel, TaskPanelStackData>

Creates a new panel sub-container. If getNewSubContainerData returned a non-empty collection, this method is called for each item in the collection.

getNewSubContainerData

override fun getNewSubContainerData(panelContainerViewModel: PanelContainerViewModel<TaskPanelStackData?, TaskPanelStackSubContainerViewModel, TaskPanelStackData>): Collection<TaskPanelStackData>

Determines if new panel sub-containers should be created, based on panelContainerViewModel.

getSubContainerDataUpdates

override fun getSubContainerDataUpdates(panelContainerViewModel: PanelContainerViewModel<TaskPanelStackData?, TaskPanelStackSubContainerViewModel, TaskPanelStackData>): Collection<StateDrivenSubContainerController.SubContainerDataUpdate<TaskPanelStackSubContainerViewModel, TaskPanelStackData>>

Updates the panel sub-container data associated to the existing panel sub-container view models.

isSubContainerExitAllowed

open override fun isSubContainerExitAllowed(subContainerViewModel: TaskPanelStackSubContainerViewModel): Boolean

Whether the panel sub-container exit of the given subContainerViewModel is allowed.