Documentation

UISeparator

class UISeparator

extends UIControl

Control that shows a horizontal or vertical separator.

Constructor

(): UISeparator

.style

UIStyle

Combined style set; when this is set to an instance of UIStyle, the individual style object properties (e.g. UIComponent.dimensions) are set to read-only objects taken from the UIStyle instance. To override individual properties, set these properties after setting style, or use Component.with to create a new constructor.

.thickness

string | number

Separator line thickness (in dp, or string with unit).

.margin

string | number

Margin in the direction perpendicular to the separator (in dp, or string with unit), defaults to 0.

.color

string

Separator line color (see UITheme.replaceColor), defaults to @separator.

.vertical

boolean

True if separator should be vertical instead of horizontal.

.applyStyle() protected

(style: UIStyle): void

Inherited from UIControl.applyStyle.

.applyControlStyle() protected

(controlStyle: Partial<ControlStyle>): void

Inherited from UIControl.applyControlStyle.

.applyTextStyle() protected

(textStyle: Partial<TextStyle>): void

Inherited from UIControl.applyTextStyle.

.textStyle

TextStyle

Inherited from UIControl.textStyle.

.controlStyle

ControlStyle

Inherited from UIControl.controlStyle.

.disabled

boolean

Inherited from UIControl.disabled.

.shrinkwrap

boolean

Inherited from UIControl.shrinkwrap.

.propagateComponentEvent()

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

Inherited from UIComponent.propagateComponentEvent.

.render()

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

Inherited from UIComponent.render.

.isFocusable()

(): boolean

Inherited from UIComponent.isFocusable.

.isKeyboardFocusable()

(): boolean

Inherited from UIComponent.isKeyboardFocusable.

.requestFocus()

(): void

Inherited from UIComponent.requestFocus.

.requestFocusNext()

(): void

Inherited from UIComponent.requestFocusNext.

.requestFocusPrevious()

(): void

Inherited from UIComponent.requestFocusPrevious.

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


UISeparator.Presets

extends UIControl.Presets

UIDivider presets type, for use with Component.with.

.thickness

string | number

Separator line thickness (in dp, or string with unit).

.margin

string | number

Margin in the direction perpendicular to the separator (in dp, or string with unit), defaults to 0.

.color

string

Separator line color (see UITheme.replaceColor), defaults to @separator.

.vertical

boolean

True if separator should be vertical instead of horizontal.

.textStyle

Partial<{}> | Partial<TextStyle>

Inherited from UIControl.Presets.textStyle.

.controlStyle

Partial<{}> | Partial<ControlStyle>

Inherited from UIControl.Presets.controlStyle.

.disabled

boolean

Inherited from UIControl.Presets.disabled.

.shrinkwrap

boolean

Inherited from UIControl.Presets.shrinkwrap.

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