Interface: WT21UiControlProps
Defined in: workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:13
Properties on the WT21UiControl component.
Extends
UiControlPropEventHandlers
<GuiUiControlEvents
>.HardwareUiControlProps
Extended by
Properties
children?
optional
children:DisplayChildren
[]
Defined in: sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
HardwareUiControlProps.children
cssClasses?
optional
cssClasses:Subject
<string
>
Defined in: workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:18
Custom CSS classes for this element
disabled?
optional
disabled:boolean
Defined in: workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:15
If this control should be disabled
getFocusPositionOnScroll()?
optional
getFocusPositionOnScroll: (direction
) =>FocusPosition
Defined in: sdk/components/controls/HardwareUiControl.tsx:56
A function which returns how the control should focus its children when it is focused from a scroll.
Parameters
Parameter | Type |
---|---|
direction | ScrollDirection |
Returns
FocusPosition
Inherited from
HardwareUiControlProps.getFocusPositionOnScroll
innerKnobScroll?
optional
innerKnobScroll:boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:32
Whether or not the inner FMS knob scrolls also by default.
Inherited from
HardwareUiControlProps.innerKnobScroll
isolateScroll?
optional
isolateScroll:boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:38
When enabled, scroll commands will not propagate from this control to its parent while the control is focused.
Inherited from
HardwareUiControlProps.isolateScroll
onAfterScroll()?
optional
onAfterScroll: (control
,index
) =>void
Defined in: sdk/components/controls/HardwareUiControl.tsx:62
An event called when the scroll operation has completed.
Parameters
Parameter | Type |
---|---|
control | HardwareUiControl |
index | number |
Returns
void
Inherited from
HardwareUiControlProps.onAfterScroll
onBlurred()?
optional
onBlurred: (source
) =>void
Defined in: sdk/components/controls/HardwareUiControl.tsx:47
An event called when the control loses focus.
Parameters
Parameter | Type |
---|---|
source | HardwareUiControl |
Returns
void
Inherited from
HardwareUiControlProps.onBlurred
onDestroyed()?
optional
onDestroyed: (source
) =>void
Defined in: sdk/components/controls/HardwareUiControl.tsx:71
An event called when the control is destroyed.
Parameters
Parameter | Type |
---|---|
source | HardwareUiControl |
Returns
void
Inherited from
HardwareUiControlProps.onDestroyed
onDisabled()?
optional
onDisabled: (source
) =>void
Defined in: sdk/components/controls/HardwareUiControl.tsx:50
An event called when the control is disabled.
Parameters
Parameter | Type |
---|---|
source | HardwareUiControl |
Returns
void
Inherited from
HardwareUiControlProps.onDisabled
onEnabled()?
optional
onEnabled: (source
) =>void
Defined in: sdk/components/controls/HardwareUiControl.tsx:53
An event called when the control is enabled.
Parameters
Parameter | Type |
---|---|
source | HardwareUiControl |
Returns
void
Inherited from
HardwareUiControlProps.onEnabled
onFocused()?
optional
onFocused: (source
) =>void
Defined in: sdk/components/controls/HardwareUiControl.tsx:44
An event called when the control is focused.
Parameters
Parameter | Type |
---|---|
source | HardwareUiControl |
Returns
void
Inherited from
HardwareUiControlProps.onFocused
onLowerKnobDec?
optional
onLowerKnobDec:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onLowerKnobDec
onLowerKnobInc?
optional
onLowerKnobInc:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onLowerKnobInc
onLowerMenuPush?
optional
onLowerMenuPush:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onLowerMenuPush
onMfdEsc?
optional
onMfdEsc:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onMfdEsc
onPfdEsc?
optional
onPfdEsc:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onPfdEsc
onPfdMenuPush?
optional
onPfdMenuPush:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onPfdMenuPush
onRefsMenuPush?
optional
onRefsMenuPush:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onRefsMenuPush
onRegistered()?
optional
onRegistered: (source
) =>void
Defined in: sdk/components/controls/HardwareUiControl.tsx:65
An event called when a control is registered with this control.
Parameters
Parameter | Type |
---|---|
source | HardwareUiControl |
Returns
void
Inherited from
HardwareUiControlProps.onRegistered
onScroll()?
optional
onScroll: (direction
) =>boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:59
An event called when the control is scrolled.
Parameters
Parameter | Type |
---|---|
direction | ScrollDirection |
Returns
boolean
Inherited from
HardwareUiControlProps.onScroll
onSoftkey1L?
optional
onSoftkey1L:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onSoftkey1L
onSoftkey1R?
optional
onSoftkey1R:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onSoftkey1R
onSoftkey2L?
optional
onSoftkey2L:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onSoftkey2L
onSoftkey2R?
optional
onSoftkey2R:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onSoftkey2R
onSoftkey3L?
optional
onSoftkey3L:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onSoftkey3L
onSoftkey3R?
optional
onSoftkey3R:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onSoftkey3R
onSoftkey4L?
optional
onSoftkey4L:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onSoftkey4L
onSoftkey4R?
optional
onSoftkey4R:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onSoftkey4R
onUnregistered()?
optional
onUnregistered: (source
) =>void
Defined in: sdk/components/controls/HardwareUiControl.tsx:68
An event called when a control is unregistered with this control.
Parameters
Parameter | Type |
---|---|
source | HardwareUiControl |
Returns
void
Inherited from
HardwareUiControlProps.onUnregistered
onUpperKnobDec?
optional
onUpperKnobDec:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onUpperKnobDec
onUpperKnobInc?
optional
onUpperKnobInc:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onUpperKnobInc
onUpperKnobPush?
optional
onUpperKnobPush:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onUpperKnobPush
onUpperMenuPush?
optional
onUpperMenuPush:UiControlEventHandler
<WT21UiControl
<WT21UiControlProps
>>
Inherited from
UiControlPropEventHandlers.onUpperMenuPush
reconcileChildBlur()?
optional
reconcileChildBlur: (index
,child
) =>number
|BlurReconciliation
Defined in: sdk/components/controls/HardwareUiControl.tsx:80
A function which reconciles the focus state of the control's children when the control is focused with no focused children after a child has been blurred.
Parameters
Parameter | Type | Description |
---|---|---|
index | number | The index of the child control that was blurred. |
child | HardwareUiControl | The child control that was blurred. |
Returns
number
| BlurReconciliation
The index of the child to focus, or a blur reconciliation strategy.
Inherited from
HardwareUiControlProps.reconcileChildBlur
ref?
optional
ref:NodeReference
<any
>
Defined in: sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
HardwareUiControlProps.ref
requireChildFocus?
optional
requireChildFocus:boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:41
Whether the control requires one of its child controls to be focused for itself to be focused.
Inherited from
HardwareUiControlProps.requireChildFocus