ModalComponentContainer

class ModalComponentContainer(metadata: ComponentMetadata, mainContainer: InternalComponentContainer) : InternalComponentContainer

This InternalComponentContainer implements the logic of using Modal containers. This means that it maintains a stack of modals on top of a mainContainer, each blocking all other containers below it. There can be only one container active at a given time. If no modals are open, the mainContainer is active.

Constructors

ModalComponentContainer
Link copied to clipboard
common
fun ModalComponentContainer(metadata: ComponentMetadata, mainContainer: InternalComponentContainer = buildContainer( metadata = metadata ))

Types

Companion
Link copied to clipboard
common
object Companion

Functions

activate
Link copied to clipboard
common
open override fun activate()
addComponent
Link copied to clipboard
common
open fun addComponent(builder: Builder<Component>): AttachedComponent
Builds a Component using the given component Builder and adds it to this ComponentContainer.
open override fun addComponent(component: Component): AttachedComponent
Adds a child Component to this ComponentContainer.
addComponents
Link copied to clipboard
common
open fun addComponents(vararg components: Builder<Component>): List<AttachedComponent>
Adds the given Components to this ComponentContainer.
open fun addComponents(vararg components: Component): List<AttachedComponent>
Adds the given Components to this ComponentContainer.
addFragment
Link copied to clipboard
common
open fun addFragment(fragment: Fragment): AttachedComponent
Adds the Fragment.root of the given Fragment to this ComponentContainer.
addFragments
Link copied to clipboard
common
open fun addFragments(vararg fragments: Fragment): List<AttachedComponent>
Adds the Fragment.root of the given Fragment to this ComponentContainer.
addModal
Link copied to clipboard
common
fun addModal(modal: Modal<out ModalResult>)
deactivate
Link copied to clipboard
common
open override fun deactivate()
Deactivates this InternalComponentContainer.
dispatch
Link copied to clipboard
common
open override fun dispatch(event: UIEvent): UIEventResponse
Dispatches the given UIEvent and propagates it throughout the UI controls this UIEventDispatcher has.
equals
Link copied to clipboard
common
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open fun hashCode(): Int
isMainContainerActive
Link copied to clipboard
common
fun isMainContainerActive(): Boolean
toString
Link copied to clipboard
common
open fun toString(): String

Properties

flattenedTree
Link copied to clipboard
common
open override val flattenedTree: Iterable<InternalComponent>
Holds the component tree rooted at this RootContainer flattened into an ObservableList.
isActive
Link copied to clipboard
common
open override val isActive: Property<Boolean>
renderables
Link copied to clipboard
common
open override val renderables: List<Renderable>
Contains the Renderable objects ordered from bottom to top.
theme
Link copied to clipboard
common
open override var theme: ColorTheme
The (mutable) ColorTheme.
themeProperty
Link copied to clipboard
common
open override val themeProperty: Property<ColorTheme>
A Property that wraps the theme and offers data binding and observability features.

Sources

(source)
Link copied to clipboard