ModalPanel
A ModalPanel is used to display information that:
Needs attention from users in order to give instructions or critical information.
Requires information in order to continue with a service or workflow.
ModalPanels interrupt a user's workflow by design. When active, a user is blocked from the TaskPanel or HomePanel content and cannot return to their previous workflow until the modal task is completed or the modal is dismissed. ModalPanels are used for short and non-frequent tasks, such as logging into an account, Bluetooth device pairing, editing something or management tasks. If a user needs to repeatably perform a task, consider making the task do-able from the main Panel.
Parameters
An entry point for this Panel to communicate with the rest of the system.
Constructors
Properties
Inherited properties
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.
The PanelContext given when the panel is attached to the system UI.
Functions
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
The fragment used when initially showing the panel. The fragment may be recreated by the system UI upon configuration changes.
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.
The PanelContext of an IviFragment identified by iviFragmentId.
Returns true
if the panel is currently attached.
Called when this panel is added to Frontend.panels, allowing it to be shown in the system UI.
Called when the panel is attached to the system UI.
Called when the panel has been detached from the system UI.
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.
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.
Called when this panel is removed from Frontend.panels, preventing it from being shown in the system UI.