Skip to main content

Class: AbstractGtcNumberDialog<Input, Output, InputDef, P>

An abstract implementation of a GTC dialog view which allows the user to select an arbitrary numeric value. The dialog includes a 0-9 number pad and backspace button by default. Subclasses can register an arbitrary number of NumberInput components. The different inputs may be used to allow the user to input numbers with different formatting, number of digits, etc. However, only one input is active and visible at a time. Subclasses may also choose to render additional dialog content by overriding the renderOtherNumberPadContents() and renderOtherContents() methods.

Type parameters

NameType
Inputextends GtcNumberDialogInput = GtcNumberDialogInput
Outputnumber
InputDefextends GtcNumberDialogInputDefinition = GtcNumberDialogInputDefinition
Pextends GtcViewProps = GtcViewProps

Hierarchy

Implements

Constructors

constructor

new AbstractGtcNumberDialog<Input, Output, InputDef, P>(props): AbstractGtcNumberDialog<Input, Output, InputDef, P>

Creates an instance of a DisplayComponent.

Type parameters

NameType
Inputextends GtcNumberDialogInput = GtcNumberDialogInput
Outputnumber
InputDefextends GtcNumberDialogInputDefinition = GtcNumberDialogInputDefinition
Pextends GtcViewProps = GtcViewProps

Parameters

NameTypeDescription
propsPThe propertis of the component.

Returns

AbstractGtcNumberDialog<Input, Output, InputDef, P>

Inherited from

GtcView.constructor

Defined in

sdk/components/FSComponent.ts:73

Properties

_activeComponent

Protected Readonly _activeComponent: Subject<null | GtcInteractionHandler>

Inherited from

GtcView._activeComponent

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:26


_sidebarState

Protected Readonly _sidebarState: GtcSidebarState

Inherited from

GtcView._sidebarState

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:28


_title

Protected Readonly _title: Subject<undefined | string>

Inherited from

GtcView._title

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:32


activeInputDef

Protected Optional activeInputDef: InputDef

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:70


backspaceRef

Protected Readonly backspaceRef: NodeReference<ImgTouchButton>

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:64


bus

Protected Readonly bus: EventBus

Inherited from

GtcView.bus

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:23


context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

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

GtcView.contextType

Defined in

sdk/components/FSComponent.ts:67


gtcService

Protected Readonly gtcService: GtcService

Inherited from

GtcView.gtcService

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:24


inputDefinitions

Protected Readonly inputDefinitions: Map<string, InputDef>

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:68


isAlive

Protected isAlive: boolean = true

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:77


numpadRef

Protected Readonly numpadRef: NodeReference<NumberPad>

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:63


props

props: P & ComponentProps

The properties of the component.

Inherited from

GtcView.props

Defined in

sdk/components/FSComponent.ts:61


resolveFunction

Protected Optional resolveFunction: (value: any) => void

Type declaration

▸ (value): void

Parameters
NameType
valueany
Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:72


resultObject

Protected resultObject: GtcDialogResult<Output>

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:73


rootCssClass

Protected Readonly rootCssClass: SetSubject<string>

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:66


showDecimalButton

Protected Readonly showDecimalButton: Subject<boolean>

Whether the decimal button is shown. Defaults to false.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:83


showSignButton

Protected Readonly showSignButton: Subject<boolean>

Whether the sign button is shown. Defaults to false.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:80


sidebarState

Readonly sidebarState: SidebarStateReadonly

The GTC sidebar state (labels and buttons) requested by this view.

Inherited from

GtcView.sidebarState

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:30


title

Readonly title: Subscribable<undefined | string>

This view's title.

Inherited from

GtcView.title

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:34

Methods

cleanupRequest

cleanupRequest(): void

Clears this dialog's pending request and fulfills the pending request Promise if one exists.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:291


destroy

destroy(): void

Destroys this component.

Returns

void

Overrides

GtcView.destroy

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:427


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
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

GtcView.getContext

Defined in

sdk/components/FSComponent.ts:106


getDualConcentricKnobLabel

getDualConcentricKnobLabel(): string

Gets the label key or label string for the dual concentric knob while this dialog is active.

Returns

string

The label key or label string for the dual concentric knob while this dialog is active.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:114


getInvalidValueMessage

getInvalidValueMessage(value, activeInputDef): string | VNode

Gets the message to display when attempting to return an invalid value.

Parameters

NameTypeDescription
valuenumberThe invalid value.
activeInputDefInputDefThe input definition used to generate the invalid value.

Returns

string | VNode

The message to display when attempting to return an invalid value.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:270


getInvalidValueMessageDialogKey

getInvalidValueMessageDialogKey(): string

Gets the key of the message dialog to open to display the invalid value message.

Returns

string

The key of the message dialog to open to display the invalid value message.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:284


getPayload

getPayload(value, activeInputDef): Output

Gets the payload for a completed request.

Parameters

NameTypeDescription
valuenumberThe numeric value to return with the request.
activeInputDefInputDefThe active input definition at the time the request was completed.

Returns

Output

The payload for a completed request.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:278


getRootCssClassName

getRootCssClassName(): undefined | string

Gets the CSS class name (singular) for this dialog's root element.

Returns

undefined | string

The CSS class name (singular) for this dialog's root element.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:363


isValueValid

isValueValid(value, activeInputDef): boolean

Checks if a value is valid to be returned for a request.

Parameters

NameTypeDescription
valuenumberThe value to check.
activeInputDefInputDefThe input definition used to generate the value to check.

Returns

boolean

Whether the specified value is valid to be returned for a request.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:262


onAfterRender

onAfterRender(): void

A callback that is called after the component is rendered.

Returns

void

Overrides

GtcView.onAfterRender

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:97


onBackspacePressed

onBackspacePressed(): void

Responds to when this dialog's backspace button is pressed.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:334


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

GtcView.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80


onCleanupRequest

onCleanupRequest(): void

A callback method which is called when this dialog cleans up a request. This method is called before the pending request Promise is fulfilled, if one exists.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:305


onClose

onClose(): void

The Close lifecycle method

Returns

void

Overrides

GtcView.onClose

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:185


onDecimalPressed

onDecimalPressed(): void

Called when this dialog's decimal button is pressed.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:327


onEditingActiveChanged

onEditingActiveChanged(isEditingActive, activeInputDef): void

Responds to when the editing state of this dialog's active number input changes.

Parameters

NameTypeDescription
isEditingActivebooleanWhether editing is active.
activeInputDefInputDefThe active input definition.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:124


onGtcInteractionEvent

onGtcInteractionEvent(event): boolean

Called when there is an interaction event when this is the active view.

Parameters

NameTypeDescription
eventGtcInteractionEventThe event.

Returns

boolean

Whether the event was handled or not.

Overrides

GtcView.onGtcInteractionEvent

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:195


onNumberPressed

onNumberPressed(value): void

Responds to when one of this dialog's number pad buttons is pressed.

Parameters

NameTypeDescription
valuenumberThe value of the button that was pressed.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:313


onOpen

onOpen(wasPreviouslyOpened): void

The Open lifecycle method

Parameters

NameTypeDescription
wasPreviouslyOpenedbooleanTrue when this view was open in a previous view stack (like if the go back button was used to reach this page).

Returns

void

Inherited from

GtcView.onOpen

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:42


onPause

onPause(): void

The Pause lifecycle method

Returns

void

Inherited from

GtcView.onPause

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:52


onRequest

onRequest(input): void

A callback method which is called when this dialog receives a request.

Parameters

NameTypeDescription
inputInputThe input for the request.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:152


onResume

onResume(): void

The Resume lifecycle method

Returns

void

Overrides

GtcView.onResume

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:190


onSignPressed

onSignPressed(): void

Called when this dialog's sign button is pressed.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:320


registerInputDefinition

registerInputDefinition(key, def): void

Registers an input definition with this dialog. Definitions must be registered before this dialog is rendered in order to function properly.

Parameters

NameTypeDescription
keystringThe key to register the definition under. If an existing definition is already registered under the same key, it will be replaced.
defInputDefThe definition to register.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:92


render

render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

GtcView.render

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:339


renderBackspaceButton

renderBackspaceButton(ref, rootCssClassName): null | VNode

Renders this dialog's backspace button.

Parameters

NameTypeDescription
refNodeReference<DisplayComponent<any, []>>The reference to which to assign the rendered button.
rootCssClassNameundefined | stringThe CSS class name for this dialog's root element.

Returns

null | VNode

This dialog's backspace button, as a VNode, or null if this dialog does not have a backspace button.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:403


renderNumberPad

renderNumberPad(ref, rootCssClassName): VNode

Renders this dialog's number pad.

Parameters

NameTypeDescription
refNodeReference<NumberPad>The reference to which to assign the rendered number pad.
rootCssClassNameundefined | stringThe CSS class name for this dialog's root element.

Returns

VNode

This dialog's number pad, as a VNode.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:371


renderOtherContents

renderOtherContents(rootCssClassName): null | VNode

Renders additional contents in this dialog's root container.

Parameters

NameTypeDescription
rootCssClassNameundefined | stringThe CSS class name for this dialog's root element.

Returns

null | VNode

Additional contents in this dialog's root container, as a VNode, or null if there are no additional contents.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:422


renderOtherNumberPadContents

renderOtherNumberPadContents(rootCssClassName): null | VNode

Renders additional contents in this dialog's number pad container.

Parameters

NameTypeDescription
rootCssClassNameundefined | stringThe CSS class name for this dialog's root element.

Returns

null | VNode

Additional contents in this dialog's number pad container, as a VNode, or null if there are no additional contents.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:393


request

request(input): Promise<GtcDialogResult<Output>>

Requests a value from this dialog.

Parameters

NameTypeDescription
inputInputInput parameters defining the request.

Returns

Promise<GtcDialogResult<Output>>

A Promise which is fulfilled with the result of the request. The result will indicate whether the request was cancelled, and if the request was not cancelled, it will also contain the requested value.

Implementation of

GtcDialogView.request

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:131


resetActiveInput

resetActiveInput(key?, initialValue?, resetEditing?): void

Resets the active input. This will

Parameters

NameTypeDefault valueDescription
key?stringundefinedThe key of the input to set as the active input. Defaults to the key of the current active input.
initialValue?numberundefinedThe initial value to set on the new active input. If not defined, the new active input will retain its current value.
resetEditingbooleanfalseWhether to reset the editing state of this dialog, in effect resetting the Back/Cancel button on the button bar to Back. Defaults to false.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:162


validateValueAndClose

validateValueAndClose(): Promise<void>

Validates the currently selected value, and if valid sets the value to be returned for the currently pending request and closes this dialog.

Returns

Promise<void>

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/AbstractGtcNumberDialog.tsx:227