workflow-ui-core-android/com.squareup.workflow1.ui.navigation/OverlayDialogHolder

OverlayDialogHolder

interface OverlayDialogHolder<in OverlayT : Overlay>

Associates a dialog with a function (runner) that can update it to display instances of OverlayT. Also holds a reference to the ViewEnvironment that was most recently used to update the dialog.

Types

Companion

object Companion

Properties

dialog

abstract val dialog: Dialog

The Dialog managed by this holder, and updated via runner

environment

abstract val environment: ViewEnvironment

The ViewEnvironment that was provided the last time dialog was updated by runner.

onUpdateBounds

abstract val onUpdateBounds: (Rect) -> Unit?

Optional function called to report the bounds of the managing container view, as reported by OverlayArea. Well behaved Overlay dialogs are expected to be restricted to those bounds, to the extent practical -- you probably want to ignore this for AlertDialog, e.g.

runner

abstract val runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit

The function that is run by show to update dialog with a new Overlay rendering and ViewEnvironment.

showing

@WorkflowUiExperimentalApi

val OverlayDialogHolder<*>.showing: Overlay

Returns the Overlay most recently used to update the receiver's dialog via a call to show.

Functions

canShow

@WorkflowUiExperimentalApi

fun OverlayDialogHolder<*>.canShow(overlay: Overlay): Boolean

Returns true if overlay is compatible with the Overlay instance that was last shown by the dialog managed by the receiver.

show

@WorkflowUiExperimentalApi

fun <OverlayT : Overlay> OverlayDialogHolder<OverlayT>.show(overlay: OverlayT, environment: ViewEnvironment)

Updates the dialog managed by the receiver to display overlay, and updates the receiver's environment as well.