Documentation

UIContainer

UI Containers display child components in either a horizontal or vertical arrangement.

class UIContainer abstract

extends UIComponent

Represents a UI component that contains other components (abstract).

Note: This class should not be instantiated on its own. Instead, use one of the predefined container components such as UICell, UIRow, or UIColumn.

Constructor

(...content: UIRenderable[]): UIContainer

.applyStyle() protected

(style: UIStyle): void

Applies given style set to individual style objects (e.g. UIComponent.dimensions), overridden in derived classes to copy applicable styles.

.applyLayout() protected

(layout: Partial<ContainerLayout>): void

Apply properties from given object on top of the default containerLayout properties from the current style set.

.isFocusable()

(): boolean

Returns true if this component can be focused directly using mouse or touch, or manually using UIComponent.requestFocus. This method may be overridden by derived component classes, but the value returned must always be the same.

.isKeyboardFocusable()

(): boolean

Returns true if this component can be focused using the keyboard or other methods; a true return value implies the same for UIComponent.isFocusable. This method may be overridden by derived component classes, but the value returned must always be the same.

.allowFocus

boolean

True if this container may receive direct input focus using the mouse, touch, or using UIComponent.requestFocus (cannot be changed after rendering this component), defaults to false.

.allowKeyboardFocus

boolean

True if this list may receive input focus using the keyboard and all other methods (cannot be changed after rendering this component), defaults to false.

.layout

ContainerLayout

Options for layout of child components within this container.

.separator

SeparatorOptions

Child separator options.

.asyncContentRendering

boolean

Set to true to render all child components asynchronously (results in smoother updates with slightly longer lead times).

.animatedContentRenderingDuration

number

Effect duration for animated transitions (milliseconds), if any.

.animatedContentRenderingVelocity

number

Effect velocity for animated transitions (screen distance per second), if any.

.content

ManagedList<UIRenderable>

Content components list.

.propagateComponentEvent()

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

Inherited from UIComponent.propagateComponentEvent.

.render()

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

Inherited from UIComponent.render.

.requestFocus()

(): void

Inherited from UIComponent.requestFocus.

.requestFocusNext()

(): void

Inherited from UIComponent.requestFocusNext.

.requestFocusPrevious()

(): void

Inherited from UIComponent.requestFocusPrevious.

.style

UIStyle

Inherited from UIComponent.style.

.hidden

boolean

Inherited from UIComponent.hidden.

.dimensions

Dimensions

Inherited from UIComponent.dimensions.

.position

Position

Inherited from UIComponent.position.

.accessibleRole

string

Inherited from UIComponent.accessibleRole.

.accessibleLabel

string

Inherited from UIComponent.accessibleLabel.

.revealTransition

UITransitionType

Inherited from UIComponent.revealTransition.

.exitTransition

UITransitionType

Inherited from UIComponent.exitTransition.

.lastRenderOutput

Output<this, any>

Inherited from UIComponent.lastRenderOutput.

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

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


UIContainer.Presets

extends UIComponent.Presets

UIContainer presets type, for use with Component.with.

.content

Iterable<UIRenderable>

List of container content.

.layout

Partial<{}> | Partial<ContainerLayout>

Options for layout of child components within this container (overrides).

.separator

SeparatorOptions

Child separator options (plain object).

.allowFocus

boolean

Set to true if this container may receive direct input focus using the mouse, touch, or using UIComponent.requestFocus, defaults to false.

.allowKeyboardFocus

boolean

Set to true if this container may receive input focus using the keyboard and all other methods, defaults to false.

.asyncContentRendering

boolean

Set to true to render all child components asynchronously (results in smoother updates with slightly longer lead times).

.animatedContentRenderingDuration

number

Effect duration for animated transitions (milliseconds), if any.

.animatedContentRenderingVelocity

number

Effect velocity for animated transitions (screen distance per second), if any.

.style

string | UIStyle

Inherited from UIComponent.Presets.style.

.hidden

boolean

Inherited from UIComponent.Presets.hidden.

.dimensions

Partial<{}> | Partial<Dimensions>

Inherited from UIComponent.Presets.dimensions.

.position

Partial<{}> | Partial<Position>

Inherited from UIComponent.Presets.position.

.accessibleRole

string

Inherited from UIComponent.Presets.accessibleRole.

.accessibleLabel

string

Inherited from UIComponent.Presets.accessibleLabel.

.requestFocus

boolean

Inherited from UIComponent.Presets.requestFocus.

.revealTransition

UITransitionType

Inherited from UIComponent.Presets.revealTransition.

.exitTransition

UITransitionType

Inherited from UIComponent.Presets.exitTransition.