Class: UiTouchButtonFocusModule

A module which handles UI focus for a touchscreen button.

The module syncs whether it can be focused with whether its parent button is enabled. When registered with a focus controller, the module will attempt to set focus on itself. Finally, the module handles adding the ui-button-focused CSS class to the button's class list when focused.

Implements

• UiFocusableComponent

Constructors

constructor

• new UiTouchButtonFocusModule(button, isButtonVisible, isButtonEnabled, buttonCanBeFocused, cssClass?, options?): UiTouchButtonFocusModule

Creates a new instance of UiTouchButtonFocusModule.

Parameters

Name	Type	Description
button	FocusableTouchButton	This module's parent button.
isButtonVisible	undefined | boolean | Subscribable<boolean>	Whether this module's parent button is visible.
isButtonEnabled	undefined | boolean | Subscribable<boolean>	Whether this module's parent button is enabled.
buttonCanBeFocused	undefined | boolean | Subscribable<boolean>	Whethe this module's parent button can be focused.
cssClass?	string | ToggleableClassNameRecord | SubscribableSet<string>	CSS class(es) to apply to this module's parent button.
options?	Readonly<UiTouchButtonFocusModuleOptions>	Options with which to configure this module.

Returns

UiTouchButtonFocusModule

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:72

Properties

canBeFocused

• Readonly canBeFocused: Subscribable<boolean>

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/UiTouchButtonFocusModule.ts:49

---

cssClass

• Readonly cssClass: SubscribableSet<string>

The set of CSS classes to apply to this module's parent button, including any that are applied by this module.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:59

---

isEnabled

• Readonly isEnabled: Subscribable<boolean>

Whether this module's parent button is enabled.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:52

---

isUiFocusableComponent

• Readonly isUiFocusableComponent: true

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/UiTouchButtonFocusModule.ts:43

---

isVisible

• Readonly isVisible: Subscribable<boolean>

Whether this module's parent button is visible.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:55

Methods

destroy

▸ destroy(): void

Destroys this module.

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:167

---

focusButton

▸ focusButton(): void

Attempts to set focus on this module's parent button.

Returns

void

Defined in

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

---

onButtonTouched

▸ onButtonTouched(): void

Responds to when this module's parent button is touched.

Returns

void

Defined in

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

---

onDeregistered

▸ onDeregistered(): void

Responds to when this component is deregistered with a controller.

Returns

void

Implementation of

UiFocusableComponent.onDeregistered

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:129

---

onFocusGained

▸ onFocusGained(): void

Responds to when this component gains focus.

Returns

void

Implementation of

UiFocusableComponent.onFocusGained

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:134

---

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/UiTouchButtonFocusModule.ts:139

---

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/UiTouchButtonFocusModule.ts:124

---

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/UiTouchButtonFocusModule.ts:144