Interface: FocusableTouchButton
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:13
A touch button that can be focused.
Extends
DisplayComponent
<any
>.UiFocusableComponent
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.
Inherited from
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:true
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiFocusTypes.ts:21
Flags this component as a UiFocusableComponent.
Inherited from
UiFocusableComponent
.isUiFocusableComponent
props
props:
any
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: src/sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | 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
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
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/UiSystem/UiFocusTypes.ts:36
Responds to when this component is deregistered with a controller.
Parameters
Parameter | Type | Description |
---|---|---|
controller | UiFocusController | The controller with which this component was deregistered. |
Returns
void
Inherited from
UiFocusableComponent
.onDeregistered
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
Parameter | Type | Description |
---|---|---|
direction | UiFocusDirection | The direction from which focus was gained. |
Returns
void
Inherited from
UiFocusableComponent
.onFocusGained
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
Inherited from
UiFocusableComponent
.onFocusLost
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
Parameter | Type | Description |
---|---|---|
controller | UiFocusController | The controller with which this component was registered. |
Returns
void
Inherited from
UiFocusableComponent
.onRegistered
onUiInteractionEvent()
onUiInteractionEvent(
event
):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiInteraction.ts:90
Handles a UiInteractionEvent.
Parameters
Parameter | Type | Description |
---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Inherited from
UiFocusableComponent
.onUiInteractionEvent
render()
abstract
render():null
|VNode
Defined in: src/sdk/components/FSComponent.ts:93
Renders the component.
Returns
null
| VNode
A JSX element to be rendered.
Inherited from
DisplayComponent.render
simulatePressed()
simulatePressed(
ignoreDisabled?
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButtonFocusModule.ts:19
Simulates this button being pressed.
Parameters
Parameter | Type | Description |
---|---|---|
ignoreDisabled? | boolean | Whether to simulate the button being pressed regardless of whether the button is disabled. Defaults to false . |
Returns
void