Class: UiListSelectTouchButton<S>
A touchscreen button which displays the value of a bound state and when pressed, opens a selection list dialog to optionally set the value of the bound state.
The button uses a UiValueTouchButton for rendering and touch functionality. All children are rendered as
children of the UiValueTouchButton
.
Type parameters
Name | Type |
---|---|
S | extends MutableSubscribable <any > |
Hierarchy
DisplayComponent
<UiListSelectTouchButtonProps
<S
>>↳
UiListSelectTouchButton
Constructors
constructor
• new UiListSelectTouchButton<S
>(props
): UiListSelectTouchButton
<S
>
Creates an instance of a DisplayComponent.
Type parameters
Name | Type |
---|---|
S | extends MutableSubscribable <any , any > |
Parameters
Name | Type | Description |
---|---|---|
props | UiListSelectTouchButtonProps <S > | The propertis of the component. |
Returns
Inherited from
DisplayComponent<UiListSelectTouchButtonProps<S>>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
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
focusableComponentRef
• Readonly
focusableComponentRef: NodeReference
<UiFocusableComponent
& DisplayComponent
<any
, []>>
A reference to this button's focusable component.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:120
props
• props: UiListSelectTouchButtonProps
<S
> & 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/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:264
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
getRootElement
▸ getRootElement(): HTMLElement
Gets this button's root HTML element.
Returns
HTMLElement
This button's root HTML element.
Throws
Error if this button has not yet been rendered.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:129
onAfterRender
▸ onAfterRender(node
): void
A callback that is called after the component is rendered.
Parameters
Name | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
DisplayComponent.onAfterRender
Defined in
src/sdk/components/FSComponent.ts:87
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
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:197
simulatePressed
▸ simulatePressed(ignoreDisabled?
): void
Simulates this button being pressed. This will execute the onPressed()
callback if one is defined.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
ignoreDisabled | boolean | false | Whether to simulate the button being pressed regardless of whether the button is disabled. Defaults to false . |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:138