Interface: CyclicRadioListProps
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioList.tsx:11
The properties for the CyclicRadioList component.
Extends
Properties
children?
optionalchildren:DisplayChildren[]
Defined in: sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
class?
optionalclass:string|ToggleableClassNameRecord|SubscribableSet<string>
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioList.tsx:22
Classname to append to the element
cssClasses?
optionalcssClasses:Subject<string>
Defined in: workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:19
Custom CSS classes for this element
Inherited from
dataRef
dataRef:
Subject<number>
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioList.tsx:25
The data ref subject for the selected index.
disabled?
optionaldisabled:boolean|Subscribable<boolean>
Defined in: workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:16
If this control should be disabled
Inherited from
getFocusPositionOnScroll()?
optionalgetFocusPositionOnScroll: (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
Inherited from
WT21UiControlProps.getFocusPositionOnScroll
inline?
optionalinline:boolean
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioList.tsx:16
A boolean determining wether the radio list is inline
innerKnobScroll?
optionalinnerKnobScroll:boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:32
Whether or not the inner FMS knob scrolls also by default.
Inherited from
WT21UiControlProps.innerKnobScroll
isolateScroll?
optionalisolateScroll: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
WT21UiControlProps.isolateScroll
label?
optionallabel:string
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioList.tsx:19
The text label of the radio list
onAfterScroll()?
optionalonAfterScroll: (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
WT21UiControlProps.onAfterScroll
onBlurred()?
optionalonBlurred: (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
onDestroyed()?
optionalonDestroyed: (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
WT21UiControlProps.onDestroyed
onDisabled()?
optionalonDisabled: (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
onEnabled()?
optionalonEnabled: (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
onFocused()?
optionalonFocused: (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
onLowerKnobDec?
optionalonLowerKnobDec:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onLowerKnobDec
onLowerKnobInc?
optionalonLowerKnobInc:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onLowerKnobInc
onLowerMenuPush?
optionalonLowerMenuPush:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onLowerMenuPush
onMfdEsc?
optionalonMfdEsc:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
onPfdEsc?
optionalonPfdEsc:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
onPfdMenuPush?
optionalonPfdMenuPush:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onPfdMenuPush
onRefsMenuPush?
optionalonRefsMenuPush:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onRefsMenuPush
onRegistered()?
optionalonRegistered: (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
WT21UiControlProps.onRegistered
onScroll()?
optionalonScroll: (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
onSoftkey1L?
optionalonSoftkey1L:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onSoftkey1L
onSoftkey1R?
optionalonSoftkey1R:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onSoftkey1R
onSoftkey2L?
optionalonSoftkey2L:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onSoftkey2L
onSoftkey2R?
optionalonSoftkey2R:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onSoftkey2R
onSoftkey3L?
optionalonSoftkey3L:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onSoftkey3L
onSoftkey3R?
optionalonSoftkey3R:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onSoftkey3R
onSoftkey4L?
optionalonSoftkey4L:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onSoftkey4L
onSoftkey4R?
optionalonSoftkey4R:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onSoftkey4R
onUnregistered()?
optionalonUnregistered: (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
WT21UiControlProps.onUnregistered
onUpperKnobDec?
optionalonUpperKnobDec:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onUpperKnobDec
onUpperKnobInc?
optionalonUpperKnobInc:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onUpperKnobInc
onUpperKnobPush?
optionalonUpperKnobPush:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onUpperKnobPush
onUpperMenuPush?
optionalonUpperMenuPush:UiControlEventHandler<WT21UiControl<WT21UiControlProps>>
Inherited from
WT21UiControlProps.onUpperMenuPush
orientation
orientation:
"left"|"right"
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioList.tsx:13
The orinetation of the list
reconcileChildBlur()?
optionalreconcileChildBlur: (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
WT21UiControlProps.reconcileChildBlur
ref?
optionalref:NodeReference<any>
Defined in: sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
requireChildFocus?
optionalrequireChildFocus: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.