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

Package-level declarations

Types

AnyPanelContainerController

typealias AnyPanelContainerController = PanelContainerController<*, *>

Convenience type-alias for PanelContainerController<*, *>.

ExtendablePanelContainerElementList

@IviExperimental(reasons = [])

interface ExtendablePanelContainerElementList<SD, BD> : List<PanelContainerElement<SD>>

Allows extending a PanelContainerElement list with PanelContainerElement.BasicElement elements with BD as basic element data type.

PanelContainerController

abstract class PanelContainerController<D, VM>(panelContainerId: PanelContainerId, panelData: LiveData<out D?>)

A base class for managing the contents of a container of panels.

PanelContainerElement

@IviExperimental(reasons = [])

sealed class PanelContainerElement<SD>

Element of a panel container.

PanelContainerElementHolder

@IviExperimental(reasons = [])

sealed class PanelContainerElementHolder<VM : PanelSubContainerViewModel<SD>, SD>

Holds a PanelContainerElement and its view.

PanelContainerElementTypeId

data class PanelContainerElementTypeId

Denotes the PanelContainerElement type.

PanelContainerViewModel

@IviExperimental(reasons = [])

open class PanelContainerViewModel<CD, VM : PanelSubContainerViewModel<SD>, SD>(val panelContainerData: CD?, val subContainerViewModels: List<VM>)

The view model of a panel container.

PanelFragmentContainerHolder

@IviExperimental(reasons = [])

class PanelFragmentContainerHolder

Holds a reference to a panel fragment container.

PanelFragmentContainerId

@IviExperimental(reasons = [])

class PanelFragmentContainerId

A panel fragment container ID.

Functions

createPanelContainerController

@IviExperimental(reasons = [])

fun <V : ViewGroup, PanelContainer<*, *>, CD, VM : PanelSubContainerViewModel<SD>, SD> V.createPanelContainerController(panelContainerData: LiveData<CD?>, panelContainerControllerAdapter: PanelContainerControllerAdapter<V, CD?, VM, SD>, basePanelContext: CommonPanelContext): PanelContainerController<CD?, VM>

Allows any ViewGroup implementation that implements the PanelContainer interface to create a PanelContainerController to visualize the panelContainerData in this ViewGroup container.

findOptionalPanelFragmentContainerAndSetId

@IviExperimental(reasons = [])

fun <VM : PanelSubContainerViewModel<SD>, SD> PanelContainerElementHolder.SubContainerHolder<VM, SD>.findOptionalPanelFragmentContainerAndSetId(panelFragmentContainerId: PanelFragmentContainerId, @IdRes stubId: Int): PanelFragmentContainerHolder?

Returns a PanelFragmentContainerHolder referencing the first matching FragmentContainerView in this panel sub-container. A FragmentContainerView is considered a match if its view ID matches the stubId.

findPanelFragmentContainerAndSetId

@IviExperimental(reasons = [])

fun <VM : PanelSubContainerViewModel<SD>, SD> PanelContainerElementHolder.SubContainerHolder<VM, SD>.findPanelFragmentContainerAndSetId(panelFragmentContainerId: PanelFragmentContainerId, @IdRes stubId: Int? = null): PanelFragmentContainerHolder

Returns a PanelFragmentContainerHolder referencing the first matching FragmentContainerView in this panel sub-container. A FragmentContainerView is considered a match if its view ID matches the stubId. If stubId is null any FragmentContainerView matches.

inflateSubContainerAndBindViewModel

@IviExperimental(reasons = [])

fun <VM : PanelSubContainerViewModel<SD>, SD> inflateSubContainerAndBindViewModel(panelContainer: ViewGroup, @LayoutRes subContainerLayoutId: Int?, subContainerViewModel: VM): PanelContainerElementHolder.SubContainerHolder<VM, SD>

Inflates a panel sub-container with a single panel fragment container for panelContainer from a layout based on subContainerLayoutId. If subContainerLayoutId is null then a default FragmentContainerView is returned.