platform_systemui_api_common_systemuihost/com.tomtom.ivi.platform.systemui.api.common.systemuihost.containercontrollers.singlepanel/SinglePanelSubContainerController

SinglePanelSubContainerController

@IviExperimental(reasons = [])
class SinglePanelSubContainerController<VM : SinglePanelSubContainerViewModel<P>, P : GenericPanel<C>, C : CommonPanelContext>(@LayoutRes subContainerLayoutId: Int? = null, providePanelContextFactory: PanelContextFactoryProvider.(P) -> PanelContextFactory<C>) : StateDrivenSubContainerController<P?, VM, P>

A panel sub-container controller for visualizing a single panel in a panel container.

For each panel sub-container a layout based on subContainerLayoutId is inflated. If subContainerLayoutId is null then a default FragmentContainerView is used.

Use the invoke operator for constructing this class with a panel type P with a CommonPanelContext.

Parameters

providePanelContextFactory

Provides the panel context factory for creating a panel context of type C. Use the receiver to create a PanelContextFactory. A panel context is created when a panel is attached to a panel sub-container. The panel is provided as argument to the factory.

VM

The panel sub-container view model type.

P

The panel type.

C

The panel context type.

Constructors

Link copied to clipboard
constructor(@LayoutRes subContainerLayoutId: Int? = null, providePanelContextFactory: PanelContextFactoryProvider.(P) -> PanelContextFactory<C>)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun createSubContainer(panelContainer: ViewGroup, subContainerViewModel: VM, panelContainerViewModel: PanelContainerViewModel<P?, VM, P>): SubContainerCreation<VM, P>

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

Link copied to clipboard
open override fun getNewSubContainerData(panelContainerViewModel: PanelContainerViewModel<P?, VM, P>): Collection<P>

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

Link copied to clipboard
open override fun getSubContainerDataUpdates(panelContainerViewModel: PanelContainerViewModel<P?, VM, P>): Collection<StateDrivenSubContainerController.SubContainerDataUpdate<VM, P>>

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

Link copied to clipboard
open override fun isSubContainerExitAllowed(subContainerViewModel: VM): Boolean

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