Class: UiControl<T>

The UiControl component.

Type parameters

Name	Type
T	extends UiControlProps = UiControlProps

Hierarchy

• DisplayComponent<T>

  ↳ UiControl

  ↳↳ PopoutMenuItem

  ↳↳ ActionButton

  ↳↳ ArrowToggle

  ↳↳ GenericControl

  ↳↳ InputComponent

  ↳↳ NumberInput

  ↳↳ SelectControl

  ↳↳ WptDupListItem

  ↳↳ ProcSequenceItem

  ↳↳ ADFFreqInput

  ↳↳ TimerInput

Constructors

constructor

• new UiControl<T>(props): UiControl<T>

Type parameters

Name	Type
T	extends UiControlProps = UiControlProps

Parameters

Name	Type
props	T

Returns

UiControl<T>

Inherit Doc

Overrides

DisplayComponent\<T\>.constructor

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:48

Properties

containerRef

• Protected containerRef: NodeReference<HTMLElement>

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:45

---

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

DisplayComponent.context

Defined in

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

sdk/components/FSComponent.ts:67

---

focusSubject

• Protected focusSubject: ComputedSubject<boolean, "" | "highlight-select">

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:37

---

isActivated

• Protected isActivated: boolean = false

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:43

---

isEnabledSubject

• Protected isEnabledSubject: Subject<boolean>

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:41

---

isVisibleSubject

• Protected isVisibleSubject: Subject<boolean>

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:42

---

props

• props: T & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

sdk/components/FSComponent.ts:61

---

registerSelf

• Protected registerSelf: boolean = true

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:44

---

ACTIVE_CLASS

▪ Static Readonly ACTIVE_CLASS: "highlight-active"

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:34

---

FOCUS_CLASS

▪ Static Readonly FOCUS_CLASS: "highlight-select"

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:33

---

HIDE_CLASS

▪ Static Readonly HIDE_CLASS: "hide-element"

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:35

Methods

activate

▸ activate(): void

Activates the control. Usually after being focused and some action happens.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:74

---

blur

▸ blur(): void

Method to unfocus this control

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:68

---

deactivate

▸ deactivate(): void

Deactivate the control.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:83

---

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

Defined in

sdk/components/FSComponent.ts:98

---

focus

▸ focus(): void

Method to focus this control

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:63

---

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

sdk/components/FSComponent.ts:106

---

getHighlightElement

▸ getHighlightElement(): null | Element

Gets the element to highlight on focus. Should be overriden by inheriting controls when the highlight is not the topmost container.

Returns

null | Element

The {Element} to highlight.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:183

---

getIsActivated

▸ getIsActivated(): boolean

Gets a boolean indicating if this control is currently activated.

Returns

boolean

A boolean.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:145

---

getIsEnabled

▸ getIsEnabled(): boolean

Gets a boolean indicating if this control is enabled.

Returns

boolean

A boolean.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:102

---

getIsFocusable

▸ getIsFocusable(): boolean

Gets a boolean indicating if this control is able to be focused.

Returns

boolean

A boolean.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:137

---

getIsFocused

▸ getIsFocused(): boolean

Method to check if this UiControl is in focus

Returns

boolean

a boolean whether this is in focus

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:94

---

getIsVisible

▸ getIsVisible(): boolean

Gets a boolean indicating if this control is visible.

Returns

boolean

A boolean.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:129

---

onActivated

▸ onActivated(): void

Method to override what to do when control is activated

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:213

---

onAfterRender

▸ onAfterRender(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:155

---

onBeforeRender

▸ onBeforeRender(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.onBeforeRender

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:150

---

onBlurred

▸ onBlurred(): void

A callback which is called when this control group is blurred.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:208

---

onClr

▸ onClr(): boolean

Method to override that specifies what to do on Clr

Returns

boolean

A boolean indicating if the control handled the event.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:269

---

onDeactivated

▸ onDeactivated(): void

Method to override what to do when control is deactivated

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:219

---

onDirectTo

▸ onDirectTo(): boolean

Method to overwirte that specifies what to do on a direct to.

Returns

boolean

A boolean indicating if the control handleded the event.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:280

---

onEnter

▸ onEnter(): boolean

Method to override that specifies what to do on Enter

Returns

boolean

A boolean indicating if the control handled the event.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:259

---

onFocused

▸ onFocused(): void

A callback which is called when this control group is focused.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:201

---

onInteractionEvent

▸ onInteractionEvent(evt): boolean

A method which is called when this control receives an interaction event.

Parameters

Name	Type	Description
evt	FmsHEvent	The event.

Returns

boolean

Whether the event was handled.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:231

---

onLowerKnob

▸ onLowerKnob(): void

Method to override that specifies what to do on lower knob

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:313

---

onLowerKnobDec

▸ onLowerKnobDec(): void

Method to override that specifies what to do on lower knob dec

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:329

---

onLowerKnobInc

▸ onLowerKnobInc(): void

Method to override that specifies what to do on lower knob inc

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:320

---

onRegister

▸ onRegister(): void

Method to register this Ui Control

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:188

---

onUpperKnob

▸ onUpperKnob(): void

Method to override that specifies what to do on upper knob

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:288

---

onUpperKnobDec

▸ onUpperKnobDec(): void

Method to override that specifies what to do on upper knob dec

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:304

---

onUpperKnobInc

▸ onUpperKnobInc(): void

Method to override that specifies what to do on upper knob inc

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:295

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

The component VNode.

Overrides

DisplayComponent.render

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:343

---

renderControl

▸ renderControl(): VNode

Returns

VNode

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:337

---

setIsEnabled

▸ setIsEnabled(enable): void

Sets the enabled state of this control.

Parameters

Name	Type	Description
enable	boolean	A {boolean} indicating if this control should be enabled.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:110

---

setIsVisible

▸ setIsVisible(visible): void

Sets the visibility of this control.

Parameters

Name	Type	Description
visible	boolean	A {boolean} indicating if this control should be visible.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControl.tsx:121