Skip to main content

Interface: UiFocusableComponent

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiFocusTypes.ts:19

A UI component that can be focused.

Extends​

Extended by​

Properties​

canBeFocused​

readonly canBeFocused: Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiFocusTypes.ts:24

Whether this component can be focused.


isUiFocusableComponent​

readonly isUiFocusableComponent: true

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiFocusTypes.ts:21

Flags this component as a UiFocusableComponent.

Methods​

onDeregistered()​

onDeregistered(controller): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiFocusTypes.ts:36

Responds to when this component is deregistered with a controller.

Parameters​

ParameterTypeDescription
controllerUiFocusControllerThe controller with which this component was deregistered.

Returns​

void


onFocusGained()​

onFocusGained(direction): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiFocusTypes.ts:42

Responds to when this component gains focus.

Parameters​

ParameterTypeDescription
directionUiFocusDirectionThe direction from which focus was gained.

Returns​

void


onFocusLost()​

onFocusLost(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiFocusTypes.ts:47

Responds to when this component loses focus.

Returns​

void


onRegistered()​

onRegistered(controller): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiFocusTypes.ts:30

Responds to when this component is registered with a controller.

Parameters​

ParameterTypeDescription
controllerUiFocusControllerThe controller with which this component was registered.

Returns​

void


onUiInteractionEvent()​

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiInteraction.ts:90

Handles a UiInteractionEvent.

Parameters​

ParameterTypeDescription
eventUiInteractionEventThe event to handle.

Returns​

boolean

Whether the event was handled.

Inherited from​

UiInteractionHandler.onUiInteractionEvent