Skip to main content

Class: InputComponent

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:26

Input Component Class

Extends

Constructors

Constructor

new InputComponent(props): InputComponent

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

Parameters

ParameterType
propsInputComponentProps

Returns

InputComponent

Inherit Doc

Inherited from

UiControl.constructor

Properties

containerRef

protected containerRef: NodeReference<HTMLElement>

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

Inherited from

UiControl.containerRef


context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

UiControl.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

UiControl.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

Inherited from

UiControl.focusSubject


isActivated

protected isActivated: boolean = false

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

Inherited from

UiControl.isActivated


isEnabledSubject

protected isEnabledSubject: Subject<boolean>

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

Inherited from

UiControl.isEnabledSubject


isVisibleSubject

protected isVisibleSubject: Subject<boolean>

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

Inherited from

UiControl.isVisibleSubject


props

props: InputComponentProps & ComponentProps

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

The properties of the component.

Inherited from

UiControl.props


registerSelf

protected registerSelf: boolean = true

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

Inherited from

UiControl.registerSelf


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

Inherited from

UiControl.ACTIVE_CLASS


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

Inherited from

UiControl.FOCUS_CLASS


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

Inherited from

UiControl.HIDE_CLASS

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

Inherited from

UiControl.activate


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

Inherited from

UiControl.blur


clear()

clear(emitEvent): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:114

Clears the input.

Parameters

ParameterTypeDefault valueDescription
emitEventbooleantrueA boolean indicating if an event should be emitted after clearing the input value.

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

Inherited from

UiControl.deactivate


destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

UiControl.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

Inherited from

UiControl.focus


getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe 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

UiControl.getContext


getHighlightElement()

getHighlightElement(): null | Element

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:383

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.

Overrides

UiControl.getHighlightElement


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.

Inherited from

UiControl.getIsActivated


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.

Inherited from

UiControl.getIsEnabled


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.

Inherited from

UiControl.getIsFocusable


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

Inherited from

UiControl.getIsFocused


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.

Inherited from

UiControl.getIsVisible


getRawText()

getRawText(): string

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:106

Gets the raw input without blank fills.

Returns

string

the data entry text without blank fills


getText()

getText(): string

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:98

Gets the current input.

Returns

string

the data entry text


onActivated()

onActivated(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:419

Method to override what to do when control is activated

Returns

void

Overrides

UiControl.onActivated


onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:388

Returns

void

Inherit Doc

Overrides

UiControl.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

Inherited from

UiControl.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

Inherited from

UiControl.onBlurred


onClr()

onClr(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:372

Method to override that specifies what to do on Clr

Returns

boolean

A boolean indicating if the control handled the event.

Overrides

UiControl.onClr


onDeactivated()

onDeactivated(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:428

Method to override what to do when control is deactivated

Returns

void

Overrides

UiControl.onDeactivated


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.

Inherited from

UiControl.onDirectTo


onEnter()

onEnter(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:355

Method to override that specifies what to do on Enter

Returns

boolean

A boolean indicating if the control handled the event.

Overrides

UiControl.onEnter


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

Inherited from

UiControl.onFocused


onInteractionEvent()

onInteractionEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:50

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

Parameters

ParameterTypeDescription
evtFmsHEventThe event.

Returns

boolean

Whether the event was handled.

Overrides

UiControl.onInteractionEvent


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

Inherited from

UiControl.onLowerKnob


onLowerKnobDec()

onLowerKnobDec(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:342

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

Returns

void

Overrides

UiControl.onLowerKnobDec


onLowerKnobInc()

onLowerKnobInc(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:331

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

Returns

void

Overrides

UiControl.onLowerKnobInc


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

Inherited from

UiControl.onRegister


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

Inherited from

UiControl.onUpperKnob


onUpperKnobDec()

onUpperKnobDec(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:318

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

Returns

void

Overrides

UiControl.onUpperKnobDec


onUpperKnobInc()

onUpperKnobInc(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:305

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

Returns

void

Overrides

UiControl.onUpperKnobInc


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.

Inherited from

UiControl.render


renderControl()

renderControl(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:450

Returns

VNode

Inherit Doc

Overrides

UiControl.renderControl


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

ParameterTypeDescription
enablebooleanA {boolean} indicating if this control should be enabled.

Returns

void

Inherited from

UiControl.setIsEnabled


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

ParameterTypeDescription
visiblebooleanA {boolean} indicating if this control should be visible.

Returns

void

Inherited from

UiControl.setIsVisible


setText()

setText(value, highlightIndex?, emitEvent?): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/InputComponent.tsx:87

Method to set the initial text value when the component is made active.

Parameters

ParameterTypeDefault valueDescription
valuestringundefinedis a string containing the start text value
highlightIndex?numberundefinedThe new index of the highlighted character. The index will remain unchanged if this argument is undefined.
emitEvent?booleantrueWhether a text changed event should be emitted.

Returns

void