UIColumn

This container component displays child view components in a vertical arrangement.

class UIColumn

extends UIContainer

Represents a UI component that contains other components, in a vertical arrangement.

Constructor

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

.hasComponentSpacing()

(): boolean

Returns true if spacing between components should be non-zero (used by renderer).

.spacing

string | number

Space between components along vertical axis (in dp or string with unit, defaults to value from UITheme).

.width

string | number

Column width (in dp or string with unit).

.applyStyle() protected

(style?: UIStyle): void

Inherited from UIContainer.applyStyle.

.isFocusable()

(): boolean

Inherited from UIContainer.isFocusable.

.isKeyboardFocusable()

(): boolean

Inherited from UIContainer.isKeyboardFocusable.

.allowFocus

boolean

Inherited from UIContainer.allowFocus.

.allowKeyboardFocus

boolean

Inherited from UIContainer.allowKeyboardFocus.

.layout

Readonly<ContainerLayout>

Inherited from UIContainer.layout.

.asyncContentRendering

boolean

Inherited from UIContainer.asyncContentRendering.

.animatedContentRenderingDuration

number

Inherited from UIContainer.animatedContentRenderingDuration.

.animatedContentRenderingVelocity

number

Inherited from UIContainer.animatedContentRenderingVelocity.

.content

ManagedList<UIRenderable>

Inherited from UIContainer.content.

.propagateComponentEvent() deprecated

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

Inherited from UIComponent.propagateComponentEvent.

.delegateEvent() protected

(e: ManagedEvent, propertyName: string): true

Inherited from UIComponent.delegateEvent.

.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

Readonly<Dimensions>

Inherited from UIComponent.dimensions.

.position

Readonly<Position>

Inherited from UIComponent.position.

.accessibleRole

string

Inherited from UIComponent.accessibleRole.

.accessibleLabel

string

Inherited from UIComponent.accessibleLabel.

.lastRenderOutput

Output<this, any>

Inherited from UIComponent.lastRenderOutput.

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

.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

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


UIColumn.Presets

extends UIContainer.Presets

UIColumn presets type, for use with Component.with.

.spacing

string | number

Space between components along vertical axis (in dp or string with unit, defaults to value from UITheme).

.width

string | number

Column width (in dp or string with unit).

.content

Iterable<UIRenderable>

Inherited from UIContainer.Presets.content.

.layout

Partial<{} | ContainerLayout>

Inherited from UIContainer.Presets.layout.

.allowFocus

boolean

Inherited from UIContainer.Presets.allowFocus.

.allowKeyboardFocus

boolean

Inherited from UIContainer.Presets.allowKeyboardFocus.

.asyncContentRendering

boolean

Inherited from UIContainer.Presets.asyncContentRendering.

.animatedContentRenderingDuration

number

Inherited from UIContainer.Presets.animatedContentRenderingDuration.

.animatedContentRenderingVelocity

number

Inherited from UIContainer.Presets.animatedContentRenderingVelocity.

.style

string | UIStyle

Inherited from UIComponent.Presets.style.

.hidden

boolean

Inherited from UIComponent.Presets.hidden.

.dimensions

Partial<{} | Dimensions>

Inherited from UIComponent.Presets.dimensions.

.position

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.