Abstract Class: UiControl<T>

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

The UiControl component.

Extends

• DisplayComponent<T>

Extended by

• PopoutMenuItem
• ActionButton
• ArrowToggle
• GenericControl
• InputComponent
• NumberInput
• SelectControl
• WptDupListItem
• ProcSequenceItem
• ADFFreqInput
• TimerInput

Type Parameters

Type Parameter	Default type
T extends UiControlProps	UiControlProps

Constructors

Constructor

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

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

Parameters

Parameter	Type
props	T

Returns

UiControl<T>

Inherit Doc

Overrides

DisplayComponent<T>.constructor

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

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

---

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

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

DisplayComponent.props

---

registerSelf

protected registerSelf: boolean = true

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

---

ACTIVE_CLASS

readonly static ACTIVE_CLASS: "highlight-active" = 'highlight-active'

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

---

FOCUS_CLASS

readonly static FOCUS_CLASS: "highlight-select" = 'highlight-select'

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

---

HIDE_CLASS

readonly static HIDE_CLASS: "hide-element" = 'hide-element'

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

Methods

activate()

activate(): void

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

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

Returns

void

---

blur()

blur(): void

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

Method to unfocus this control

Returns

void

---

deactivate()

deactivate(): void

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

Deactivate the control.

Returns

void

---

destroy()

destroy(): void

Defined in: sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

focus()

focus(): void

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

Method to focus this control

Returns

void

---

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

---

getHighlightElement()

protected getHighlightElement(): null | Element

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

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.

---

getIsActivated()

getIsActivated(): boolean

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

Gets a boolean indicating if this control is currently activated.

Returns

boolean

A boolean.

---

getIsEnabled()

getIsEnabled(): boolean

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

Gets a boolean indicating if this control is enabled.

Returns

boolean

A boolean.

---

getIsFocusable()

getIsFocusable(): boolean

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

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

Returns

boolean

A boolean.

---

getIsFocused()

getIsFocused(): boolean

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

Method to check if this UiControl is in focus

Returns

boolean

a boolean whether this is in focus

---

getIsVisible()

getIsVisible(): boolean

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

Gets a boolean indicating if this control is visible.

Returns

boolean

A boolean.

---

onActivated()

onActivated(): void

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

Method to override what to do when control is activated

Returns

void

---

onAfterRender()

onAfterRender(): void

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

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

Returns

void

Inherit Doc

Overrides

DisplayComponent.onBeforeRender

---

onBlurred()

protected onBlurred(): void

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

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

Returns

void

---

onClr()

onClr(): boolean

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

Method to override that specifies what to do on Clr

Returns

boolean

A boolean indicating if the control handled the event.

---

onDeactivated()

onDeactivated(): void

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

Method to override what to do when control is deactivated

Returns

void

---

onDirectTo()

onDirectTo(): boolean

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

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

Returns

boolean

A boolean indicating if the control handleded the event.

---

onEnter()

onEnter(): boolean

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

Method to override that specifies what to do on Enter

Returns

boolean

A boolean indicating if the control handled the event.

---

onFocused()

protected onFocused(): void

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

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

Returns

void

---

onInteractionEvent()

onInteractionEvent(evt): boolean

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

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

Parameters

Parameter	Type	Description
evt	FmsHEvent	The event.

Returns

boolean

Whether the event was handled.

---

onLowerKnob()

onLowerKnob(): void

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

Method to override that specifies what to do on lower knob

Returns

void

---

onLowerKnobDec()

onLowerKnobDec(): void

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

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

Returns

void

---

onLowerKnobInc()

onLowerKnobInc(): void

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

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

Returns

void

---

onRegister()

onRegister(): void

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

Method to register this Ui Control

Returns

void

---

onUpperKnob()

onUpperKnob(): void

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

Method to override that specifies what to do on upper knob

Returns

void

---

onUpperKnobDec()

onUpperKnobDec(): void

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

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

Returns

void

---

onUpperKnobInc()

onUpperKnobInc(): void

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

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

Returns

void

---

render()

render(): VNode

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

Renders the component.

Returns

VNode

The component VNode.

Overrides

DisplayComponent.render

---

renderControl()

abstract protected renderControl(): VNode

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

Returns

VNode

---

setIsEnabled()

setIsEnabled(enable): void

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

Sets the enabled state of this control.

Parameters

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

Returns

void

---

setIsVisible()

setIsVisible(visible): void

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

Sets the visibility of this control.

Parameters

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

Returns

void