Skip to main content

Class: CombinedTouchButton

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:75

A wrapper component which renders child touchscreen buttons in a single row or column surrounded by a single contiguous border and separated by border-like dividers.

Extends

Implements

Constructors

Constructor

new CombinedTouchButton(props): CombinedTouchButton

Defined in: src/sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsCombinedTouchButtonPropsThe propertis of the component.

Returns

CombinedTouchButton

Inherited from

DisplayComponent<CombinedTouchButtonProps>.constructor

Properties

canBeFocused

readonly canBeFocused: Subscribable<boolean> | Subscribable<false> | Subscribable<true>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:91

Whether this component can be focused.

Implementation of

UiFocusableComponent.canBeFocused


context?

optional context: [] = undefined

Defined in: src/sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType


isUiFocusableComponent

readonly isUiFocusableComponent: any

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:88

Flags this component as a UiFocusableComponent.

Implementation of

UiFocusableComponent.isUiFocusableComponent


props

props: CombinedTouchButtonProps & ComponentProps

Defined in: src/sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:245

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy


focusSelf()

focusSelf(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:110

Attempts to set focus on this combined button. If this button was not rendered as a focusable component, then this method does nothing.

Returns

void


getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

DisplayComponent.getContext


onAfterRender()

onAfterRender(thisNode): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:98

Parameters

ParameterType
thisNodeVNode

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender


onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender


onDeregistered()

onDeregistered(controller): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:126

Responds to when this component is deregistered with a controller.

Parameters

ParameterTypeDescription
controllerUiFocusControllerThe controller with which this component was deregistered.

Returns

void

Implementation of

UiFocusableComponent.onDeregistered


onFocusGained()

onFocusGained(direction): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:133

Responds to when this component gains focus.

Parameters

ParameterTypeDescription
directionUiFocusDirectionThe direction from which focus was gained.

Returns

void

Implementation of

UiFocusableComponent.onFocusGained


onFocusLost()

onFocusLost(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:140

Responds to when this component loses focus.

Returns

void

Implementation of

UiFocusableComponent.onFocusLost


onRegistered()

onRegistered(controller): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:119

Responds to when this component is registered with a controller.

Parameters

ParameterTypeDescription
controllerUiFocusControllerThe controller with which this component was registered.

Returns

void

Implementation of

UiFocusableComponent.onRegistered


onUiInteractionEvent()

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:147

Handles a UiInteractionEvent.

Parameters

ParameterTypeDescription
eventUiInteractionEventThe event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

UiFocusableComponent.onUiInteractionEvent


render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/CombinedTouchButton.tsx:166

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render