Skip to content

//workflow/com.squareup.workflow1.ui.modal

Package com.squareup.workflow1.ui.modal

Types

Name Summary
AlertContainer [androidJvm]
Content
@WorkflowUiExperimentalApi()

class AlertContainer@JvmOverloads()constructor(context: Context, attributeSet: AttributeSet?, defStyle: Int, defStyleRes: Int, @StyleRes()dialogThemeResId: Int) : ModalContainer
More info
Renders the AlertScreens of an AlertContainerScreen as AlertDialogs.


AlertContainerScreen [jvm]
Content
@WorkflowUiExperimentalApi()

data class AlertContainerScreen<B : Any>(beneathModals: B, modals: List<AlertScreen>) : HasModals<B, AlertScreen>
More info
May show a stack of AlertScreen over a beneathModals.


AlertScreen [jvm]
Content
@WorkflowUiExperimentalApi()

data class AlertScreen(buttons: Map<AlertScreen.Button, String>, message: String, title: String, cancelable: Boolean, onEvent: (AlertScreen.Event) -> Unit)
More info
Models a typical “You sure about that?” alert box.


HasModals [jvm]
Content
@WorkflowUiExperimentalApi()

interface HasModalsB : Any, out M : Any>
More info
Interface implemented by screen classes that represent a stack of zero or more modal screens above a base screen.


ModalContainer [androidJvm]
Content
@WorkflowUiExperimentalApi()

abstract class ModalContainer<ModalRenderingT : Any>@JvmOverloads()constructor(context: Context, attributeSet: AttributeSet?, defStyle: Int, defStyleRes: Int) : FrameLayout
More info
Base class for containers that show HasModals.modals in Dialog windows.


ModalViewContainer [androidJvm]
Content
@WorkflowUiExperimentalApi()

open class ModalViewContainer@JvmOverloads()constructor(context: Context, attributeSet: AttributeSet?, defStyle: Int, defStyleRes: Int) : ModalContainer<Any>
More info
Container that shows HasModals.modals as arbitrary views in a Dialog window.