Documentation

DialogViewActivity

class DialogViewActivity

extends ViewActivity

Represents an application activity with a view that is rendered as a modal dialog (when active).

Use UIComponent.position (UIStyle.Position, specifically the gravity property) to determine the position of the dialog UI.

Example

class MyModalDialogActivity
  extends DialogViewActivity.with(view) {
  // Make sure to position the root ^ 'view' component

  // Don't remove the view when clicked/tapped outside:
  modalShadeClickToClose = false;

  // ... other properties and event handlers
}

Constructor

(name?: string, path?: string): DialogViewActivity

.placement

UIRenderPlacement

View placement mode, determines if and how view is rendered when activated.

Note: This property is set to DIALOG to display the view as a dialog.

.modalShadeOpacity

number

Modal shade backdrop opacity behind content (0-1), if supported by placement mode.

.view

UIRenderable

Inherited from ViewActivity.view.

.modalShadeClickToClose

boolean

Inherited from ViewActivity.modalShadeClickToClose.

.render()

(callback?: RenderCallback<Output<UIRenderable, any>>): void

Inherited from ViewActivity.render.

.removeViewAsync()

(): Promise<void>

Inherited from ViewActivity.removeViewAsync.

.restoreFocus()

(firstFocused?: boolean): void

Inherited from ViewActivity.restoreFocus.

.firstFocused

UIComponent

Inherited from ViewActivity.firstFocused.

.lastFocused

UIComponent

Inherited from ViewActivity.lastFocused.

.showDialogAsync()

(View: UIRenderableConstructor, modalShadeClickToClose?: boolean, eventHandler?: (this: DialogViewActivity, e: ManagedEvent) => void): Promise<ViewActivity>

Inherited from ViewActivity.showDialogAsync.

.showConfirmationDialogAsync()

(message: string | string[], title?: string, confirmButtonLabel?: string, cancelButtonLabel?: string): Promise<boolean>

Inherited from ViewActivity.showConfirmationDialogAsync.

.name

string

Inherited from AppActivity.name.

.path

string

Inherited from AppActivity.path.

.match

Readonly<MatchedPath>

Inherited from AppActivity.match.

.getParentActivity()

(): AppActivity

Inherited from AppActivity.getParentActivity.

.getApplication()

(): Application

Inherited from AppActivity.getApplication.

.activateAsync()

(match?: MatchedPath): Promise<void>

Inherited from AppActivity.activateAsync.

.deactivateAsync()

(): Promise<void>

Inherited from AppActivity.deactivateAsync.

.destroyAsync()

(): Promise<void>

Inherited from AppActivity.destroyAsync.

.isActive()

(): boolean

Inherited from AppActivity.isActive.

.deactivated

number

Inherited from AppActivity.deactivated.

.renderContext

UIRenderContext

Inherited from AppComponent.renderContext.

.activationContext

AppActivationContext

Inherited from AppComponent.activationContext.

.isPresetComponent() protected

(): boolean

Inherited from Component.isPresetComponent.

.getParentComponent()

[1]. (): Component
[2]. <TParent extends Component>(ParentClass: ComponentConstructor<TParent>): TParent

Inherited from Component.getParentComponent.

.getCompositeParent()

<TParent extends Component>(ParentClass?: ComponentConstructor<TParent>): TParent

Inherited from Component.getCompositeParent.

.propagateComponentEvent()

(name: string, inner?: ManagedEvent): void

Inherited from Component.propagateComponentEvent.

.managedId

number

Inherited from ManagedObject.managedId.

.managedState

ManagedState

Inherited from ManagedObject.managedState.

.getReferenceCount() protected

(): number

Inherited from ManagedObject.getReferenceCount.

.getManagedReferrers() protected

(): ManagedObject[]

Inherited from ManagedObject.getManagedReferrers.

.getManagedParent() protected

[1]. (): ManagedObject
[2]. <TParent extends 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.

.propagateChildEvents() protected

[1]. (f?: (this: this, e: ManagedEvent, propertyName: string) => void | ManagedEvent | ManagedEvent[]): this
[2]. (...types: (ManagedEvent | (new (...args: any[]) => ManagedEvent))[]): 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.