Class: AbstractSimpleUiNumberDialog<Input, Output, P>
An abstract implementation of a UI dialog view that allows the user to select an arbitrary numeric value. The dialog includes a 0-9 number pad and backspace button by default. It is up to subclasses to render the number input component. Subclasses may also choose to render additional dialog content.
Type parameters
Name | Type |
---|---|
Input | extends UiNumberDialogInput = UiNumberDialogInput |
Output | number |
P | extends UiViewProps = UiViewProps |
Hierarchy
AbstractUiNumberDialog
<Input
,Output
,UiNumberDialogInputDefinition
,P
>↳
AbstractSimpleUiNumberDialog
↳↳
CourseDialog
Constructors
constructor
• new AbstractSimpleUiNumberDialog<Input
, Output
, P
>(props
): AbstractSimpleUiNumberDialog
<Input
, Output
, P
>
Type parameters
Name | Type |
---|---|
Input | extends UiNumberDialogInput = UiNumberDialogInput |
Output | number |
P | extends UiViewProps = UiViewProps |
Parameters
Name | Type |
---|---|
props | P |
Returns
AbstractSimpleUiNumberDialog
<Input
, Output
, P
>
Inherit Doc
Overrides
AbstractUiNumberDialog.constructor
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:27
Properties
_knobLabelState
• Protected
Readonly
_knobLabelState: FilteredMapSubject
<UiKnobId
, string
>
Inherited from
AbstractUiNumberDialog._knobLabelState
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:13
activeInputDef
• Protected
Optional
activeInputDef: UiNumberDialogInputDefinition
Inherited from
AbstractUiNumberDialog.activeInputDef
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:80
backButtonImgSrc
• Protected
Readonly
backButtonImgSrc: Subject
<string
>
Inherited from
AbstractUiNumberDialog.backButtonImgSrc
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:76
backButtonLabel
• Protected
Readonly
backButtonLabel: Subject
<string
>
Inherited from
AbstractUiNumberDialog.backButtonLabel
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:75
backRef
• Protected
Readonly
backRef: NodeReference
<ImgTouchButton
>
Inherited from
AbstractUiNumberDialog.backRef
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:69
backspaceRef
• Protected
Readonly
backspaceRef: NodeReference
<ImgTouchButton
>
Inherited from
AbstractUiNumberDialog.backspaceRef
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:68
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
AbstractUiNumberDialog.context
Defined in
src/sdk/components/FSComponent.ts:64
contextType
• Optional
Readonly
contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
AbstractUiNumberDialog.contextType
Defined in
src/sdk/components/FSComponent.ts:67
enterRef
• Protected
Readonly
enterRef: NodeReference
<ImgTouchButton
>
Inherited from
AbstractUiNumberDialog.enterRef
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:70
focusController
• Protected
Readonly
focusController: UiFocusController
Inherited from
AbstractUiNumberDialog.focusController
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:17
inputContainerRef
• Protected
Readonly
inputContainerRef: NodeReference
<HTMLDivElement
>
Inherited from
AbstractUiNumberDialog.inputContainerRef
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:66
inputDefinitions
• Protected
Readonly
inputDefinitions: Map
<string
, UiNumberDialogInputDefinition
>
Inherited from
AbstractUiNumberDialog.inputDefinitions
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:78
inputRef
• Protected
Readonly
inputRef: NodeReference
<NumberInput
>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:21
isAlive
• Protected
isAlive: boolean
= true
Inherited from
AbstractUiNumberDialog.isAlive
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:87
isEnterButtonEnabled
• Protected
Readonly
isEnterButtonEnabled: Subject
<boolean
>
Whether the enter button is enabled.
Inherited from
AbstractUiNumberDialog.isEnterButtonEnabled
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:96
knobLabelState
• Readonly
knobLabelState: SubscribableMap
<UiKnobId
, string
> & Subscribable
<UiKnobRequestedLabelState
>
The bezel rotary knob label state requested by this view.
Inherited from
AbstractUiNumberDialog.knobLabelState
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:15
numpadRef
• Protected
Readonly
numpadRef: NodeReference
<NumberPad
>
Inherited from
AbstractUiNumberDialog.numpadRef
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:67
props
• props: P
& ComponentProps
The properties of the component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:61
resolveFunction
• Protected
Optional
resolveFunction: (value
: any
) => void
Type declaration
▸ (value
): void
Parameters
Name | Type |
---|---|
value | any |
Returns
void
Inherited from
AbstractUiNumberDialog.resolveFunction
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:82
resultObject
• Protected
resultObject: UiDialogResult
<Output
>
Inherited from
AbstractUiNumberDialog.resultObject
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:83
rootCssClass
• Protected
Readonly
rootCssClass: SetSubject
<string
>
Inherited from
AbstractUiNumberDialog.rootCssClass
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:71
showDecimalButton
• Protected
Readonly
showDecimalButton: Subject
<boolean
>
Whether the decimal button is shown. Defaults to false.
Inherited from
AbstractUiNumberDialog.showDecimalButton
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:93
showSignButton
• Protected
Readonly
showSignButton: Subject
<boolean
>
Whether the sign button is shown. Defaults to false.
Inherited from
AbstractUiNumberDialog.showSignButton
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:90
title
• Protected
Readonly
title: Subject
<string
>
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:73
value
• Protected
Readonly
value: Subject
<number
>
This dialog's current selected value.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:24
Methods
cleanupRequest
▸ cleanupRequest(): void
Clears this dialog's pending request and fulfills the pending request Promise if one exists.
Returns
void
Inherited from
AbstractUiNumberDialog.cleanupRequest
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:326
createFocusController
▸ createFocusController(): UiFocusController
Creates a new focus controller for this view.
Returns
A new focus controller.
Inherited from
AbstractUiNumberDialog.createFocusController
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:23
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
AbstractUiNumberDialog.destroy
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:522
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
AbstractUiNumberDialog.getContext
Defined in
src/sdk/components/FSComponent.ts:106
getInvalidValueMessage
▸ getInvalidValueMessage(value
, activeInputDef
): string
| VNode
Gets the message to display when attempting to return an invalid value.
Parameters
Name | Type | Description |
---|---|---|
value | number | The invalid value. |
activeInputDef | UiNumberDialogInputDefinition | The input definition used to generate the invalid value. |
Returns
string
| VNode
The message to display when attempting to return an invalid value.
Inherited from
AbstractUiNumberDialog.getInvalidValueMessage
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:304
getInvalidValueMessageDialogLayerAndKey
▸ getInvalidValueMessageDialogLayerAndKey(): [UiViewStackLayer
, string
]
Gets the view stack layer and key of the message dialog to open to display the invalid value message.
Returns
[UiViewStackLayer
, string
]
The view stack layer and key of the message dialog to open to display the invalid value message, as
[layer, key]
.
Inherited from
AbstractUiNumberDialog.getInvalidValueMessageDialogLayerAndKey
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:319
getPayload
▸ getPayload(value
, activeInputDef
): Output
Gets the payload for a completed request.
Parameters
Name | Type | Description |
---|---|---|
value | number | The numeric value to return with the request. |
activeInputDef | UiNumberDialogInputDefinition | The active input definition at the time the request was completed. |
Returns
Output
The payload for a completed request.
Inherited from
AbstractUiNumberDialog.getPayload
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:312
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.
Inherited from
AbstractUiNumberDialog.getRootCssClassName
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:420
isValueValid
▸ isValueValid(value
, activeInputDef
): boolean
Checks if a value is valid to be returned for a request.
Parameters
Name | Type | Description |
---|---|---|
value | number | The value to check. |
activeInputDef | UiNumberDialogInputDefinition | The input definition used to generate the value to check. |
Returns
boolean
Whether the specified value is valid to be returned for a request.
Inherited from
AbstractUiNumberDialog.isValueValid
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:296
onAfterRender
▸ onAfterRender(): void
A callback that is called after the component is rendered.
Returns
void
Inherited from
AbstractUiNumberDialog.onAfterRender
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:116
onBackPressed
▸ onBackPressed(): void
Responds to when this dialog's back/cancel button is pressed.
Returns
void
Inherited from
AbstractUiNumberDialog.onBackPressed
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:376
onBackspacePressed
▸ onBackspacePressed(): void
Responds to when this dialog's backspace button is pressed.
Returns
void
Inherited from
AbstractUiNumberDialog.onBackspacePressed
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:369
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
AbstractUiNumberDialog.onBeforeRender
Defined in
src/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
Inherited from
AbstractUiNumberDialog.onCleanupRequest
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:340
onClose
▸ onClose(): void
Responds to when this view is closed.
Returns
void
Inherited from
AbstractUiNumberDialog.onClose
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:220
onDecimalPressed
▸ onDecimalPressed(): void
Called when this dialog's decimal button is pressed.
Returns
void
Inherited from
AbstractUiNumberDialog.onDecimalPressed
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:362
onEditingActiveChanged
▸ onEditingActiveChanged(isEditingActive
, activeInputDef
): void
Responds to when the editing state of this dialog's active number input changes.
Parameters
Name | Type | Description |
---|---|---|
isEditingActive | boolean | Whether editing is active. |
activeInputDef | UiNumberDialogInputDefinition | The active input definition. |
Returns
void
Inherited from
AbstractUiNumberDialog.onEditingActiveChanged
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:140
onEnterPressed
▸ onEnterPressed(): void
Responds to when this dialog's enter button is pressed.
Returns
void
Inherited from
AbstractUiNumberDialog.onEnterPressed
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:383
onNumberPressed
▸ onNumberPressed(value
): void
Responds to when one of this dialog's number pad buttons is pressed.
Parameters
Name | Type | Description |
---|---|---|
value | number | The value of the button that was pressed. |
Returns
void
Inherited from
AbstractUiNumberDialog.onNumberPressed
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:348
onOcclusionChange
▸ onOcclusionChange(occlusionType
): void
Responds to when the occlusion type applied to this view changes while this view is open.
Parameters
Name | Type | Description |
---|---|---|
occlusionType | UiViewOcclusionType | The new occlusion type applied to this view. |
Returns
void
Inherited from
AbstractUiNumberDialog.onOcclusionChange
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:56
onOpen
▸ onOpen(sizeMode
, dimensions
): void
Responds to when this view is opened.
Parameters
Name | Type | Description |
---|---|---|
sizeMode | UiViewSizeMode | The new size mode of this view's container. |
dimensions | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | The new dimensions of this view's container, as [width, height] in pixels. |
Returns
void
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:29
onPause
▸ onPause(): void
Responds to when this view is paused.
Returns
void
Inherited from
AbstractUiNumberDialog.onPause
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:44
onRequest
▸ onRequest(input
): number
A callback method which is called when this dialog receives a request.
Parameters
Name | Type | Description |
---|---|---|
input | Input | The input for the request. |
Returns
number
The initial numeric value to load into this dialog's number input.
Overrides
AbstractUiNumberDialog.onRequest
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:63
onResize
▸ onResize(sizeMode
, dimensions
): void
Responds when this view's container is resized while it is open.
Parameters
Name | Type | Description |
---|---|---|
sizeMode | UiViewSizeMode | The new size mode of this view's container. |
dimensions | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | The new dimensions of this view's container, as [width, height] in pixels. |
Returns
void
Inherited from
AbstractUiNumberDialog.onResize
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:50
onResume
▸ onResume(): void
Responds to when this view is resumed.
Returns
void
Inherited from
AbstractUiNumberDialog.onResume
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:225
onSignPressed
▸ onSignPressed(): void
Called when this dialog's sign button is pressed.
Returns
void
Inherited from
AbstractUiNumberDialog.onSignPressed
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:355
onUiInteractionEvent
▸ onUiInteractionEvent(event
): boolean
Handles a UiInteractionEvent.
Parameters
Name | Type | Description |
---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Inherited from
AbstractUiNumberDialog.onUiInteractionEvent
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:230
onUpdate
▸ onUpdate(time
): void
Called every update cycle.
Parameters
Name | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Inherited from
AbstractUiNumberDialog.onUpdate
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:62
registerInputDefinition
▸ registerInputDefinition(key
, def
): void
Registers an input definition with this dialog. Definitions must be registered before they are requested as the active input in order to function properly.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key to register the definition under. If an existing definition is already registered under the same key, it will be replaced. |
def | UiNumberDialogInputDefinition | The definition to register. |
Returns
void
Inherited from
AbstractUiNumberDialog.registerInputDefinition
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:105
render
▸ render(): VNode
Renders the component.
Returns
VNode
A JSX element to be rendered.
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:388
renderBackButton
▸ renderBackButton(ref
, rootCssClassName
): null
| VNode
Renders this dialog's back/cancel button.
Parameters
Name | Type | Description |
---|---|---|
ref | NodeReference <DisplayComponent <any , []>> | The reference to which to assign the rendered button. |
rootCssClassName | undefined | string | The CSS class name for this dialog's root element. |
Returns
null
| VNode
This dialog's back/cancel button, as a VNode, or null
if this dialog does not have a backspace button.
Inherited from
AbstractUiNumberDialog.renderBackButton
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:477
renderBackspaceButton
▸ renderBackspaceButton(ref
, rootCssClassName
): null
| VNode
Renders this dialog's backspace button.
Parameters
Name | Type | Description |
---|---|---|
ref | NodeReference <DisplayComponent <any , []>> | The reference to which to assign the rendered button. |
rootCssClassName | undefined | string | The 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.
Inherited from
AbstractUiNumberDialog.renderBackspaceButton
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:459
renderEnterButton
▸ renderEnterButton(ref
, rootCssClassName
): null
| VNode
Renders this dialog's enter button.
Parameters
Name | Type | Description |
---|---|---|
ref | NodeReference <DisplayComponent <any , []>> | The reference to which to assign the rendered button. |
rootCssClassName | undefined | string | The CSS class name for this dialog's root element. |
Returns
null
| VNode
This dialog's enter button, as a VNode, or null
if this dialog does not have a backspace button.
Inherited from
AbstractUiNumberDialog.renderEnterButton
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:496
renderInput
▸ renderInput(ref
, valueToBind
, rootCssClassName
): VNode
Renders this dialog's number input.
Parameters
Name | Type | Description |
---|---|---|
ref | NodeReference <NumberInput > | The reference to which to assign the rendered input. |
valueToBind | MutableSubscribable <number , number > | The value to bind to the input. |
rootCssClassName | undefined | string | The CSS class name for this dialog's root element. |
Returns
VNode
This dialog's number input, as a VNode.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:74
renderInputToContainer
▸ renderInputToContainer(def
): void
Renders one of this dialog's registered inputs to the input container.
Parameters
Name | Type | Description |
---|---|---|
def | UiNumberDialogInputDefinition | The definition for the input to render. |
Returns
void
Inherited from
AbstractUiNumberDialog.renderInputToContainer
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:209
renderNumberPad
▸ renderNumberPad(ref
, rootCssClassName
): VNode
Renders this dialog's number pad.
Parameters
Name | Type | Description |
---|---|---|
ref | NodeReference <NumberPad > | The reference to which to assign the rendered number pad. |
rootCssClassName | undefined | string | The CSS class name for this dialog's root element. |
Returns
VNode
This dialog's number pad, as a VNode.
Inherited from
AbstractUiNumberDialog.renderNumberPad
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:428
renderOtherContents
▸ renderOtherContents(rootCssClassName
): null
| VNode
Renders additional contents in this dialog's root container.
Parameters
Name | Type | Description |
---|---|---|
rootCssClassName | undefined | string | The 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.
Inherited from
AbstractUiNumberDialog.renderOtherContents
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:517
renderOtherNumberPadContents
▸ renderOtherNumberPadContents(rootCssClassName
): null
| VNode
Renders additional contents in this dialog's number pad container.
Parameters
Name | Type | Description |
---|---|---|
rootCssClassName | undefined | string | The 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.
Inherited from
AbstractUiNumberDialog.renderOtherNumberPadContents
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:449
request
▸ request(input
): Promise
<UiDialogResult
<Output
>>
Requests a value from this dialog.
Parameters
Name | Type | Description |
---|---|---|
input | Input | Input parameters defining the request. |
Returns
Promise
<UiDialogResult
<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.
Overrides
AbstractUiNumberDialog.request
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:39
resetActiveInput
▸ resetActiveInput(key?
, initialValue?
, resetEditing?
): void
Resets the active input.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
key? | string | undefined | The key of the input to set as the active input. Defaults to the key of the current active input. |
initialValue? | number | undefined | The initial value to set on the new active input. If not defined, the new active input will retain its current value. |
resetEditing | boolean | false | Whether 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
Inherited from
AbstractUiNumberDialog.resetActiveInput
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:178
setBackButtonStyle
▸ setBackButtonStyle(style
): void
Sets the style of this dialog's back/cancel button.
Parameters
Name | Type | Description |
---|---|---|
style | "cancel" | "back" | The style to set. |
Returns
void
Inherited from
AbstractUiNumberDialog.setBackButtonStyle
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:124
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
>
Inherited from
AbstractUiNumberDialog.validateValueAndClose
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/AbstractUiNumberDialog.tsx:261