TaskPanel

Variably sized panel.

A panel meant for user flows which equate to a task that the user may perform and which would typically require different amounts of screen real estate. A task is typically something that the user performs away from the map, going back to the map when that task is complete. For example, looking through contacts to make a call or searching for a destination to navigate to.

May overlap the HomePanel.

Parameters

frontendContext

An entry point for this Panel to communicate with the rest of the system.

Constructors

Link copied to clipboard
fun TaskPanel(frontendContext: FrontendContext)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@IviExperimental(reasons = [])
open val allowTaskProcessPanel: Boolean = true

Whether a TaskProcessPanel may be shown alongside this TaskPanel.

Link copied to clipboard

Consumers of device's back button press.

Inherited properties

Link copied to clipboard

Represents the panel. The descriptor can for example be used by other panels to show breadcrumbs when this panel is part of a stack of panels.

Link copied to clipboard
Link copied to clipboard
val id: Long

Unique identifier of a GenericPanel. Each ID is an increment of the previously created panel's ID, allowing this value to be used for sorting purposes.

Link copied to clipboard

true if the panel is currently attached.

Link copied to clipboard

true when the panel is being dismissed from the system UI, either through user interaction or other events. At this point the panel may still be visible due to the panel's exit animation.

Link copied to clipboard

The PanelContext given when the panel is attached to the system UI.

Link copied to clipboard
val tag: String

The tag to recognise this panel with. Useful in combination with fragment tags to detect which fragment belongs to which panel.

Link copied to clipboard

A destination that the information contained by this panel transitions to when this panel closes. By default it is null, indicating the information does not transition anywhere.

Link copied to clipboard

The source of the information contained by this panel when the information transitions from another panel to this one. By default it is null, indicating the information does not transition from any other particular panel.

Functions

Link copied to clipboard
open override fun onBackPressed(): Boolean

Called as a result from pressing a hardware back button. This should only be called as a result of user interaction with a back button, and not to trigger behaviour that is assumed to result from a back press. For example, in order to go back in a task panel back stack, do not call this but close the panel directly using TaskPanel.dismiss instead.

Inherited functions

Link copied to clipboard

The fragment used when initially showing the panel. The fragment may be recreated by the system UI upon configuration changes.

Link copied to clipboard
fun dismiss()

Dismisses the panel, triggering the end of its life. It will be removed from the frontend, causing onRemovedFromFrontend to be called and preventing it from being shown again. May not be called if the panel has not been added to a frontend.

Link copied to clipboard
operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun getLifecycle(): Lifecycle
Link copied to clipboard
Link copied to clipboard
override fun hashCode(): Int
Link copied to clipboard

Called when this panel is added to Frontend.panels, allowing it to be shown in the system UI.

Link copied to clipboard

Called when the panel is attached to the system UI.

Link copied to clipboard

Called when the panel has been detached from the system UI.

Link copied to clipboard

Called when the panel has been dismissed from the system UI, either through user interaction or other events. This triggers the end of the life of a panel; it will be removed from the frontend, causing onRemovedFromFrontend to be called and preventing it from being shown again in the system UI.

Link copied to clipboard

Called when the panel is being dismissed from the system UI, either through user interaction or other events. At this point the panel may still be visible due to the panel's exit animation.

Link copied to clipboard

Called when this panel is removed from Frontend.panels, preventing it from being shown in the system UI.

Link copied to clipboard
open override fun toString(): String