Class: GtcToggleTouchButton<S>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcToggleTouchButton.tsx:41
A GTC version of ToggleTouchButton. Enables focus on drag by default, and provides convenience props for handling drag behavior while in a scrollable list.
Extends
DisplayComponent
<GtcToggleTouchButtonProps
<S
>>
Type Parameters
Type Parameter |
---|
S extends Subscribable <boolean > | MutableSubscribable <boolean > |
Constructors
Constructor
new GtcToggleTouchButton<
S
>(props
):GtcToggleTouchButton
<S
>
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | GtcToggleTouchButtonProps | The propertis of the component. |
Returns
GtcToggleTouchButton
<S
>
Inherited from
DisplayComponent<GtcToggleTouchButtonProps<S>>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
props
props:
GtcToggleTouchButtonProps
<S
> &ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcToggleTouchButton.tsx:82
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: 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: 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: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
render()
render():
VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcToggleTouchButton.tsx:54
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
simulatePressed()
simulatePressed(
ignoreDisabled
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcToggleTouchButton.tsx:49
Simulates this button being pressed. This will execute the onPressed()
callback if one is defined.
Parameters
Parameter | 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