Class: CombinedTouchButton

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.

Hierarchy

• DisplayComponent<CombinedTouchButtonProps>

  ↳ CombinedTouchButton

Implements

• UiFocusableComponent

Constructors

constructor

• new CombinedTouchButton(props): CombinedTouchButton

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	CombinedTouchButtonProps	The propertis of the component.

Returns

CombinedTouchButton

Inherited from

DisplayComponent<CombinedTouchButtonProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

canBeFocused

• Readonly canBeFocused: Subscribable<boolean> | Subscribable<false> | Subscribable<true>

Whether this component can be focused.

Implementation of

UiFocusableComponent.canBeFocused

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:91

---

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

DisplayComponent.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

isUiFocusableComponent

• Readonly isUiFocusableComponent: any

Flags this component as a UiFocusableComponent.

Implementation of

UiFocusableComponent.isUiFocusableComponent

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:88

---

props

• props: CombinedTouchButtonProps & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:245

---

focusSelf

▸ focusSelf(): void

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

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:110

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	Type	Description
context	never	The 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

Defined in

src/sdk/components/FSComponent.ts:106

---

onAfterRender

▸ onAfterRender(thisNode): void

Parameters

Name	Type
thisNode	VNode

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:98

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

onDeregistered

▸ onDeregistered(controller): void

Responds to when this component is deregistered with a controller.

Parameters

Name	Type	Description
controller	UiFocusController	The controller with which this component was deregistered.

Returns

void

Implementation of

UiFocusableComponent.onDeregistered

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:126

---

onFocusGained

▸ onFocusGained(direction): void

Responds to when this component gains focus.

Parameters

Name	Type	Description
direction	UiFocusDirection	The direction from which focus was gained.

Returns

void

Implementation of

UiFocusableComponent.onFocusGained

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:133

---

onFocusLost

▸ onFocusLost(): void

Responds to when this component loses focus.

Returns

void

Implementation of

UiFocusableComponent.onFocusLost

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:140

---

onRegistered

▸ onRegistered(controller): void

Responds to when this component is registered with a controller.

Parameters

Name	Type	Description
controller	UiFocusController	The controller with which this component was registered.

Returns

void

Implementation of

UiFocusableComponent.onRegistered

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:119

---

onUiInteractionEvent

▸ onUiInteractionEvent(event): boolean

Handles a UiInteractionEvent.

Parameters

Name	Type	Description
event	UiInteractionEvent	The event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

UiFocusableComponent.onUiInteractionEvent

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:147

---

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/CombinedTouchButton.tsx:166