Documentation

UIRenderContext

class UIRenderContext abstract

extends ManagedObject

Base application render context, to be extended with platform specific render implementation.

Constructor

(): UIRenderContext

.emitRenderChange()

(): void

Emit a change event for this context, e.g. when the viewport orientation or current locale changes. This will trigger all views to re-render if needed.

.getAppComponents()

(): ManagedObject[]

Returns a list of all application components (activities, view components) that are associated with this render context.

.clear() abstract

(): void

Remove all rendered output from the screen.

.getRenderCallback() abstract

(): RenderCallback<Output<never, never>>

Returns a callback that can be used to render an output element to the screen asynchronously.

.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.


UIRenderContext.RenderCallback

Callback function that accepts rendered output and returns a next callback.


UIRenderContext.Output

Encapsulates a rendered output element, to be placed on screen by a platform specific UIRenderContext instance.

Constructor

<TComponent extends UIRenderable = UIRenderable, TElement = any>(source: TComponent, element: TElement, placement?: UIRenderPlacement, reference?: UIComponent): Output<TComponent, TElement>

.source

TComponent

The rendered component.

.element

TElement

The rendered element, as a platform-dependent object or handle.

.placement

UIRenderPlacement

Placement mode, used by UIRenderContext for root output elements.

.placementRef

UIComponent

Placement reference for dropdowns and popovers.

.modalShadeOpacity

number

Modal shade opacity behind content (0-1).

.modalShadeClickToClose

boolean

True if clicking on the modal shade area should emit CloseModal on the modal view component.

.detach

() => void

Handler function, added by a previous parent renderer (if any), to detach the visible element from the previous parent’s tree structure; any other renderer should call this method before adding the element to a new parent.