UIModalController
The UIModalController component listens for events on one child view component to hide or show another child view component.
class UIModalController
extends UIRenderableController
Renderable wrapper for a single component that can be used to display another component as a modal view. The modal component is created immediately after the ShowModal event is emitted, and removed when the CloseModal event is emitted.
Constructor
(content?: UIRenderable): UIModalController
.onShowModal()
(): boolean
Handle ‘ShowModal’ events delegated from content components, by creating the modal component.
.onCloseModal()
(): boolean
Handle ‘CloseModal’ events delegated from content or modal components, by removing the modal component.
.showModal()
(): void
Show the (preset) modal component.
.closeModal()
(): void
Remove the currently showing modal component, if any.
.modal
The current modal component to be displayed, as a managed child reference, or undefined if the modal component is currently not displayed.
.placement
Modal view placement, defaults to Dialog.
.modalShadeOpacity
number
Modal backdrop opacity (0-1).
.renderContext
Inherited from UIRenderableController.renderContext.
.content
TContent
Inherited from UIRenderableController.content.
.delegateEvent() protected
(e: ManagedEvent, propertyName: string): true
Inherited from UIRenderableController.delegateEvent.
.render()
(callback?: RenderCallback<Output<UIRenderable, any>>): void
Inherited from UIRenderableController.render.
.isPresetComponent() protected
(): boolean
Inherited from Component.isPresetComponent.
.getParentComponent()
<TParent extends Component = Component>(ParentClass?: ComponentConstructor<TParent>): TParent
Inherited from Component.getParentComponent.
.getBoundParentComponent()
<TParent extends Component>(ParentClass?: ComponentConstructor<TParent>): TParent
Inherited from Component.getBoundParentComponent.
.emitAction()
(name: string, inner?: ManagedEvent, context?: ManagedObject): void
Inherited from Component.emitAction.
.propagateComponentEvent() deprecated
(name: string, inner?: ManagedEvent): void
Inherited from Component.propagateComponentEvent.
.managedId
number
Inherited from ManagedObject.managedId.
.managedState
Inherited from ManagedObject.managedState.
.getReferenceCount() protected
(): number
Inherited from ManagedObject.getReferenceCount.
.getManagedReferrers() protected
(): ManagedObject[]
Inherited from ManagedObject.getManagedReferrers.
.getManagedParent() protected
<TParent extends ManagedObject = ManagedObject>(ParentClass?: ManagedObjectConstructor<TParent>): TParent
Inherited from ManagedObject.getManagedParent.
.emit()
<TEvent extends ManagedEvent = ManagedEvent, TConstructorArgs extends any[] = any[]>(e: string | TEvent | (new (...args: TConstructorArgs) => TEvent), ...constructorArgs: TConstructorArgs): this
Inherited from ManagedObject.emit.
.emitChange()
(name?: string): void
Inherited from ManagedObject.emitChange.
.propagateChildEvents() protected deprecated
(...types: ((new (...args: any[]) => ManagedEvent) | ((e: ManagedEvent) => any))[]): this
Inherited from ManagedObject.propagateChildEvents.
.activateManagedAsync() protected
(): Promise<any>
Inherited from ManagedObject.activateManagedAsync.
.deactivateManagedAsync() protected
(): Promise<void>
Inherited from ManagedObject.deactivateManagedAsync.
.destroyManagedAsync() protected
(): Promise<void>
Inherited from ManagedObject.destroyManagedAsync.
.onManagedStateActivatingAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateActivatingAsync.
.onManagedStateActiveAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateActiveAsync.
.onManagedStateDeactivatingAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateDeactivatingAsync.
.onManagedStateInactiveAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateInactiveAsync.
.onManagedStateDestroyingAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateDestroyingAsync.
UIModalController.Presets
UIModalController presets type, for use with Component.with.
.modal
Modal component constructor (can also be passed as an additional argument to Component.with).
.placement
Modal view placement, defaults to Dialog.
.modalShadeOpacity
number
Modal backdrop opacity (0-1), defaults to 0.