Documentation

UIViewRenderer

class UIViewRenderer

extends Component implements UIRenderable

Renderable component that wraps around a referenced view (view component or activity), which is not a child component of the component itself. The view may be selected from a bound list and/or map, using a (bound or assigned) index.

Note: Because the rendered view is not a child component, events (including UI events such as ‘Clicked’) never propagate up to the containing component(s).

Constructor

(): UIViewRenderer

.managedList

ManagedList<UIRenderable>

List of indexed views and/or view activities, not child components.

.managedMap

ManagedMap<UIRenderable>

Map of named views and/or view activities, not child components.

.index

string | number

Index of the view to be rendered from managedList (if number) or managedMap (if string), defaults to 0.

.view

UIRenderable

The current view (or view activity) to be rendered, can be bound, or automatically selected using managedList or managedMap and index properties; not a child component.

.render()

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

Trigger asynchronous rendering for this component, and all contained components (if any).

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


UIViewRenderer.Presets

UIViewRenderer presets type, for use with Component.with.

.view

Binding

Rendered view, if bound directly (not to be used together with managedList or managedMap properties).

.managedList

Binding

List of renderable views (must be bound to either a ManagedList or AppActivityList), one of which can be selected for rendering using the index property.

.managedMap

Binding

Map of renderable views (must be bound to a ManagedMap), one of which can be selected for rendering using the index property.

.index

string | number

Index of the view to be rendered from the managedList or managedMap properties, defaults to 0.