Interface: WT21UiControlProps

Properties on the WT21UiControl component.

Hierarchy

• UiControlPropEventHandlers<GuiUiControlEvents>

• HardwareUiControlProps

  ↳ WT21UiControlProps

  ↳↳ CyclicRadioListProps

  ↳↳ GuiDialogProps

Properties

children

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from

HardwareUiControlProps.children

Defined in

sdk/components/FSComponent.ts:122

---

cssClasses

• Optional cssClasses: Subject<string>

Custom CSS classes for this element

Defined in

workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:18

---

disabled

• Optional disabled: boolean

If this control should be disabled

Defined in

workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:15

---

getFocusPositionOnScroll

• Optional getFocusPositionOnScroll: (direction: ScrollDirection) => FocusPosition

A function which returns how the control should focus its children when it is focused from a scroll.

Type declaration

▸ (direction): FocusPosition

A function which returns how the control should focus its children when it is focused from a scroll.

Parameters

Name	Type
direction	ScrollDirection

Returns

FocusPosition

Inherited from

HardwareUiControlProps.getFocusPositionOnScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:56

---

innerKnobScroll

• Optional innerKnobScroll: boolean

Whether or not the inner FMS knob scrolls also by default.

Inherited from

HardwareUiControlProps.innerKnobScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:32

---

isolateScroll

• Optional isolateScroll: boolean

When enabled, scroll commands will not propagate from this control to its parent while the control is focused.

Inherited from

HardwareUiControlProps.isolateScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:38

---

onAfterScroll

• Optional onAfterScroll: (control: HardwareUiControl<Record<string, any>, HardwareUiControlProps>, index: number) => void

An event called when the scroll operation has completed.

Type declaration

▸ (control, index): void

An event called when the scroll operation has completed.

Parameters

Name	Type
control	HardwareUiControl<Record<string, any>, HardwareUiControlProps>
index	number

Returns

void

Inherited from

HardwareUiControlProps.onAfterScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:62

---

onBlurred

• Optional onBlurred: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control loses focus.

Type declaration

▸ (source): void

An event called when the control loses focus.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

HardwareUiControlProps.onBlurred

Defined in

sdk/components/controls/HardwareUiControl.tsx:47

---

onDestroyed

• Optional onDestroyed: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is destroyed.

Type declaration

▸ (source): void

An event called when the control is destroyed.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

HardwareUiControlProps.onDestroyed

Defined in

sdk/components/controls/HardwareUiControl.tsx:71

---

onDisabled

• Optional onDisabled: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is disabled.

Type declaration

▸ (source): void

An event called when the control is disabled.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

HardwareUiControlProps.onDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:50

---

onEnabled

• Optional onEnabled: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is enabled.

Type declaration

▸ (source): void

An event called when the control is enabled.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

HardwareUiControlProps.onEnabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:53

---

onFocused

• Optional onFocused: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is focused.

Type declaration

▸ (source): void

An event called when the control is focused.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

HardwareUiControlProps.onFocused

Defined in

sdk/components/controls/HardwareUiControl.tsx:44

---

onLowerKnobDec

• onLowerKnobDec: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onLowerKnobDec

---

onLowerKnobInc

• onLowerKnobInc: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onLowerKnobInc

---

onLowerMenuPush

• onLowerMenuPush: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onLowerMenuPush

---

onMfdEsc

• onMfdEsc: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onMfdEsc

---

onPfdEsc

• onPfdEsc: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onPfdEsc

---

onPfdMenuPush

• onPfdMenuPush: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onPfdMenuPush

---

onRefsMenuPush

• onRefsMenuPush: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onRefsMenuPush

---

onRegistered

• Optional onRegistered: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when a control is registered with this control.

Type declaration

▸ (source): void

An event called when a control is registered with this control.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

HardwareUiControlProps.onRegistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:65

---

onScroll

• Optional onScroll: (direction: ScrollDirection) => boolean

An event called when the control is scrolled.

Type declaration

▸ (direction): boolean

An event called when the control is scrolled.

Parameters

Name	Type
direction	ScrollDirection

Returns

boolean

Inherited from

HardwareUiControlProps.onScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:59

---

onSoftkey1L

• onSoftkey1L: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSoftkey1L

---

onSoftkey1R

• onSoftkey1R: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSoftkey1R

---

onSoftkey2L

• onSoftkey2L: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSoftkey2L

---

onSoftkey2R

• onSoftkey2R: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSoftkey2R

---

onSoftkey3L

• onSoftkey3L: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSoftkey3L

---

onSoftkey3R

• onSoftkey3R: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSoftkey3R

---

onSoftkey4L

• onSoftkey4L: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSoftkey4L

---

onSoftkey4R

• onSoftkey4R: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSoftkey4R

---

onUnregistered

• Optional onUnregistered: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when a control is unregistered with this control.

Type declaration

▸ (source): void

An event called when a control is unregistered with this control.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

HardwareUiControlProps.onUnregistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:68

---

onUpperKnobDec

• onUpperKnobDec: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobDec

---

onUpperKnobInc

• onUpperKnobInc: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobInc

---

onUpperKnobPush

• onUpperKnobPush: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobPush

---

onUpperMenuPush

• onUpperMenuPush: undefined | UiControlEventHandler<WT21UiControl<WT21UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperMenuPush

---

reconcileChildBlur

• Optional reconcileChildBlur: (index: number, child: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => number | BlurReconciliation

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.

Param

The index of the child control that was blurred.

Param

The child control that was blurred.

Type declaration

▸ (index, child): number | BlurReconciliation

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

Name	Type	Description
index	number	The index of the child control that was blurred.
child	HardwareUiControl<Record<string, any>, HardwareUiControlProps>	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

Defined in

sdk/components/controls/HardwareUiControl.tsx:80

---

ref

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

HardwareUiControlProps.ref

Defined in

sdk/components/FSComponent.ts:125

---

requireChildFocus

• Optional requireChildFocus: boolean

Whether the control requires one of its child controls to be focused for itself to be focused.

Inherited from

HardwareUiControlProps.requireChildFocus

Defined in

sdk/components/controls/HardwareUiControl.tsx:41