Package-level declarations
Types
Convenience type-alias for GenericDismissablePanel<*>. This type alias allows any panel type to be referenced regardless of the PanelContext type. As a result, GenericPanel.getPanelContext only returns PanelContext, not a more specific one.
Do not use this type in unit tests when you want to invoke GenericPanel.onAttached.
Convenience type-alias for GenericPanel<*>. This type alias allows any panel type to be referenced regardless of the PanelContext type. As a result, GenericPanel.getPanelContext only returns PanelContext, not a more specific one.
Do not use this type in unit tests when you want to invoke GenericPanel.onAttached.
The context that is common to all Panel types. It is provided by the panel container when the panel is attached to the system UI.
A panel for an isolated area of the system UI that provides persistent indicators and controls that are accessible to the user at all times.
A panel used only for development and testing purposes for reaching underlying parts of the system that the end-user cannot reach. Not a customer-facing part of the UI.
A convenience type-alias for GenericDismissablePanel<CommonPanelContext>.
The default implementation of PanelArrayList.
A collection of DismissablePanels.
A list of DismissablePanels.
A panel context for Panels in a dismissable panel stack.
An expanded version of a MainProcessPanel or TaskProcessPanel, exposing additional information and functionality related to an ongoing process.
A panel that can be dismissed, either through user interaction or other events. Dismissing a panel triggers the end of its life; it will be removed from the frontend, preventing it from being shown again.
A panel to visually represent a Frontend. Panels are intended to be presented to the user by the system UI, which does this by attaching the IviFragment returned by createInitialFragment to its layout. The created fragment will internally instantiate a ViewModel (FrontendViewModel) with a reference to this panel.
A panel displaying guidance information for an active trip.
The main panel seen by the user in the system UI's 'home' state, i.e., where the user will be after pressing a home button. Will typically contain a map view, but might have different contents depending on the vehicle's configuration.
An implementation for CommonPanelContext.
A panel that provides a persistent way of accessing the other system frontends.
A panel which visualizes processes in the UI. For example, an ongoing audio streaming process.
A ModalPanel is used to display information that:
A context for panels which are navigable. These panels are part are part of a view stack. Navigable panels allow users to navigate between the panels in the view stack.
Describes a panel in descriptor, while navigateToPanel is the function that should be invoked when the described panel should be navigated to. Navigating to the panel can for example happen when a user presses the breadcrumb.
Provides Panel data within a certain scope.
A panel to inform the user of a recent event.
A panel which overlays the system UI's main content area to show a temporary visual effect. This can be used, for example, to visualize the state of a currently active VPA or provide large and noticeable navigation instructions.
A convenience type-alias for GenericPanel<CommonPanelContext>`.
A collection of Panels.
A context for panels that's provided when the Panel is attached by the system UI.
An interface to get a PanelContext.
Describes a Panel. This data is typically used so that panels can get information about each other. This data can be used to provide users a way to navigate between panels.
An interface to get a PanelDescriptor.
The destination of an information transition between panels.
The source of an information transition between panels.
The safe area specifies where information, that is important to the user, should be displayed. It's defined through margins from each side which should not be used for displaying important information, as it may not be visible to the user. The panel is still expected to draw in these margins, though.
A panel that offers the end-user quick access to search functionality. This panel is meant to provide a visual context for location based search, such as searching for a driving destination, parking spots or charging stations. It is not meant for searching content within a TaskPanel, like songs within a media frontend.
A panel displaying settings options for active display.
An interface for interacting with the default Android soft input method, such as showing and hiding the standard on-screen Android keyboard.
Variably sized panel.
A panel to be shown alongside a TaskPanel in the system UI.
Properties
Functions
Returns whether a panel collection contains any panels that have not been dismissed yet.
Creates a DismissablePanelStackContext based on a commonPanelContext.
Returns a DismissablePanelList containing the given elements.
Dismisses all panels in the collection.
Returns an empty DismissablePanelList.
Returns a list of DismissablePanels that is filtered to only contain Panels of type P.
Returns a LiveData with the list of DismissablePanels of type P that are not being dismissed.
Returns a list of DismissablePanels of type P that are not being dismissed.
Whether the transition comes from a Source panel.
Whether the transition goes to a Destination panel.
Creates a set containing panelTypess. This is used to communicate to Frontends and system UIs which Panel types are available or supported. As such the set may not contain the very base types of Panels such as GenericPanel or GenericDismissablePanel.
Transforms the PanelList into a LiveData. This is useful when using createDismissablePanelStackContext to create a NavigablePanelContext.
Converts this
to a DismissablePanelList with the same contents.
Converts this
to a PanelList with the same contents.