UIToggle

class UIToggle

extends UIControl

Represents a toggle component with an optional text label.

Constructor

(): UIToggle

.withName() static

(name: string, label?: Stringable): typeof UIToggle

Creates a preset toggle class with given name and label, if any.

.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 return value must be constant for each instance.

.isKeyboardFocusable()

(): boolean

Returns true if this component can be focused using the keyboard as well as using other methods (rather than direct manipulation only). This method may be overridden by derived component classes, but the return value must be constant for each instance.

.label

Stringable

Label text, if any.

.highlightColor

string | UIColor

Highlight (background) color, if any.

.state

boolean

Current toggle state, true for ‘on’ state, false for ‘off’.

.name

string

Form context property name.

.formContext

UIFormContext<any>

Bound form context, if any.

.applyStyle() protected

(style?: UIStyle): void

Inherited from UIControl.applyStyle.

.textStyle

Readonly<TextStyle>

Inherited from UIControl.textStyle.

.decoration

Readonly<Decoration>

Inherited from UIControl.decoration.

.disabled

boolean

Inherited from UIControl.disabled.

.shrinkwrap

boolean

Inherited from UIControl.shrinkwrap.

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