Class: SelectedHeadingDialog
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:31
A dialog that allows the user to enter a selected heading value.
Extends
Constructors
Constructor
new SelectedHeadingDialog(
props):SelectedHeadingDialog
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:27
Parameters
| Parameter | Type |
|---|---|
props | SelectedHeadingDialogProps |
Returns
SelectedHeadingDialog
Inherit Doc
Inherited from
AbstractSimpleUiNumberDialog.constructor
Properties
_knobLabelState
protectedreadonly_knobLabelState:FilteredMapSubject<UiKnobId,string>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:13
Inherited from
AbstractSimpleUiNumberDialog._knobLabelState
activeInputDef?
protectedoptionalactiveInputDef:UiNumberDialogInputDefinition
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:80
Inherited from
AbstractSimpleUiNumberDialog.activeInputDef
backButtonImgSrc
protectedreadonlybackButtonImgSrc:Subject<string>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:76
Inherited from
AbstractSimpleUiNumberDialog.backButtonImgSrc
backButtonLabel
protectedreadonlybackButtonLabel:Subject<string>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:75
Inherited from
AbstractSimpleUiNumberDialog.backButtonLabel
backRef
protectedreadonlybackRef:NodeReference<ImgTouchButton>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:69
Inherited from
AbstractSimpleUiNumberDialog.backRef
backspaceRef
protectedreadonlybackspaceRef:NodeReference<ImgTouchButton>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:68
Inherited from
AbstractSimpleUiNumberDialog.backspaceRef
context?
optionalcontext: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
AbstractSimpleUiNumberDialog.context
contextType?
readonlyoptionalcontextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
AbstractSimpleUiNumberDialog.contextType
enterRef
protectedreadonlyenterRef:NodeReference<ImgTouchButton>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:70
Inherited from
AbstractSimpleUiNumberDialog.enterRef
focusController
protectedreadonlyfocusController:UiFocusController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:17
Inherited from
AbstractSimpleUiNumberDialog.focusController
inputContainerRef
protectedreadonlyinputContainerRef:NodeReference<HTMLDivElement>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:66
Inherited from
AbstractSimpleUiNumberDialog.inputContainerRef
inputDefinitions
protectedreadonlyinputDefinitions:Map<string,UiNumberDialogInputDefinition>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:78
Inherited from
AbstractSimpleUiNumberDialog.inputDefinitions
inputRef
protectedreadonlyinputRef:NodeReference<NumberInput>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:21
Inherited from
AbstractSimpleUiNumberDialog.inputRef
isAlive
protectedisAlive:boolean=true
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:87
Inherited from
AbstractSimpleUiNumberDialog.isAlive
isEnterButtonEnabled
protectedreadonlyisEnterButtonEnabled:Subject<boolean>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:96
Whether the enter button is enabled.
Inherited from
AbstractSimpleUiNumberDialog.isEnterButtonEnabled
knobLabelState
readonlyknobLabelState:SubscribableMap<UiKnobId,string> &Subscribable<UiKnobRequestedLabelState>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:15
The bezel rotary knob label state requested by this view.
Inherited from
AbstractSimpleUiNumberDialog.knobLabelState
numpadRef
protectedreadonlynumpadRef:NodeReference<NumberPad>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:67
Inherited from
AbstractSimpleUiNumberDialog.numpadRef
props
props:
SelectedHeadingDialogProps&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
AbstractSimpleUiNumberDialog.props
resolveFunction()?
protectedoptionalresolveFunction: (value) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:82
Parameters
| Parameter | Type |
|---|---|
value | any |
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.resolveFunction
resultObject
protectedresultObject:UiDialogResult<number>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:83
Inherited from
AbstractSimpleUiNumberDialog.resultObject
rootCssClass
protectedreadonlyrootCssClass:SetSubject<string>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:71
Inherited from
AbstractSimpleUiNumberDialog.rootCssClass
showDecimalButton
protectedreadonlyshowDecimalButton:Subject<boolean>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:93
Whether the decimal button is shown. Defaults to false.
Inherited from
AbstractSimpleUiNumberDialog.showDecimalButton
showSignButton
protectedreadonlyshowSignButton:Subject<boolean>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:90
Whether the sign button is shown. Defaults to false.
Inherited from
AbstractSimpleUiNumberDialog.showSignButton
title
protectedreadonlytitle:Subject<string>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:73
Inherited from
AbstractSimpleUiNumberDialog.title
value
protectedreadonlyvalue:Subject<number>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:24
This dialog's current selected value.
Inherited from
AbstractSimpleUiNumberDialog.value
Methods
cleanupRequest()
protectedcleanupRequest():void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:326
Clears this dialog's pending request and fulfills the pending request Promise if one exists.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.cleanupRequest
createFocusController()
protectedcreateFocusController():UiFocusController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:23
Creates a new focus controller for this view.
Returns
A new focus controller.
Inherited from
AbstractSimpleUiNumberDialog.createFocusController
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:178
Destroys this component.
Returns
void
Overrides
AbstractSimpleUiNumberDialog.destroy
getContext()
protectedgetContext(context):never
Defined in: src/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
AbstractSimpleUiNumberDialog.getContext
getInvalidValueMessage()
protectedgetInvalidValueMessage():string|VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:102
Gets the message to display when attempting to return an invalid value.
Returns
string | VNode
The message to display when attempting to return an invalid value.
Overrides
AbstractSimpleUiNumberDialog.getInvalidValueMessage
getInvalidValueMessageDialogLayerAndKey()
protectedgetInvalidValueMessageDialogLayerAndKey(): [UiViewStackLayer,string]
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:319
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
AbstractSimpleUiNumberDialog.getInvalidValueMessageDialogLayerAndKey
getPayload()
protectedgetPayload(value):number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:107
Gets the payload for a completed request.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | number | The numeric value to return with the request. |
Returns
number
The payload for a completed request.
Overrides
AbstractSimpleUiNumberDialog.getPayload
getRootCssClassName()
protectedgetRootCssClassName():string
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:112
Gets the CSS class name (singular) for this dialog's root element.
Returns
string
The CSS class name (singular) for this dialog's root element.
Overrides
AbstractSimpleUiNumberDialog.getRootCssClassName
isValueValid()
protectedisValueValid(value):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:97
Checks if a value is valid to be returned for a request.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | number | The value to check. |
Returns
boolean
Whether the specified value is valid to be returned for a request.
Overrides
AbstractSimpleUiNumberDialog.isValueValid
onAfterRender()
onAfterRender():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:43
A callback that is called after the component is rendered.
Returns
void
Overrides
AbstractSimpleUiNumberDialog.onAfterRender
onBackPressed()
protectedonBackPressed():void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:376
Responds to when this dialog's back/cancel button is pressed.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onBackPressed
onBackspacePressed()
protectedonBackspacePressed():void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:369
Responds to when this dialog's backspace button is pressed.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onBackspacePressed
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onBeforeRender
onCleanupRequest()
protectedonCleanupRequest():void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:340
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
AbstractSimpleUiNumberDialog.onCleanupRequest
onClose()
onClose():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:78
Responds to when this view is closed.
Returns
void
Overrides
AbstractSimpleUiNumberDialog.onClose
onDecimalPressed()
protectedonDecimalPressed():void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:362
Called when this dialog's decimal button is pressed.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onDecimalPressed
onEditingActiveChanged()
protectedonEditingActiveChanged(isEditingActive,activeInputDef):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:140
Responds to when the editing state of this dialog's active number input changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
isEditingActive | boolean | Whether editing is active. |
activeInputDef | UiNumberDialogInputDefinition | The active input definition. |
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onEditingActiveChanged
onEnterPressed()
protectedonEnterPressed():void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:383
Responds to when this dialog's enter button is pressed.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onEnterPressed
onNumberPressed()
protectedonNumberPressed(value):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:348
Responds to when one of this dialog's number pad buttons is pressed.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | number | The value of the button that was pressed. |
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onNumberPressed
onOcclusionChange()
onOcclusionChange(
occlusionType):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:56
Responds to when the occlusion type applied to this view changes while this view is open.
Parameters
| Parameter | Type | Description |
|---|---|---|
occlusionType | UiViewOcclusionType | The new occlusion type applied to this view. |
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onOcclusionChange
onOpen()
onOpen(
sizeMode,dimensions):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:69
Responds to when this view is opened.
Parameters
| Parameter | Type | Description |
|---|---|---|
sizeMode | UiViewSizeMode | The new size mode of this view's container. |
dimensions | ReadonlyFloat64Array | The new dimensions of this view's container, as [width, height] in pixels. |
Returns
void
Overrides
AbstractSimpleUiNumberDialog.onOpen
onPause()
onPause():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:44
Responds to when this view is paused.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onPause
onRequest()
protectedonRequest(input):number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:87
A callback method which is called when this dialog receives a request.
Parameters
| Parameter | Type | Description |
|---|---|---|
input | UiNumberDialogInput | The input for the request. |
Returns
number
The initial numeric value to load into this dialog's number input.
Overrides
AbstractSimpleUiNumberDialog.onRequest
onResize()
onResize(
sizeMode,dimensions):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:50
Responds when this view's container is resized while it is open.
Parameters
| Parameter | Type | Description |
|---|---|---|
sizeMode | UiViewSizeMode | The new size mode of this view's container. |
dimensions | ReadonlyFloat64Array | The new dimensions of this view's container, as [width, height] in pixels. |
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onResize
onResume()
onResume():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:225
Responds to when this view is resumed.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onResume
onSignPressed()
protectedonSignPressed():void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:355
Called when this dialog's sign button is pressed.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onSignPressed
onUiInteractionEvent()
onUiInteractionEvent(
event):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:230
Handles a UiInteractionEvent.
Parameters
| Parameter | Type | Description |
|---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Inherited from
AbstractSimpleUiNumberDialog.onUiInteractionEvent
onUpdate()
onUpdate(
time):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:62
Called every update cycle.
Parameters
| Parameter | Type | Description |
|---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.onUpdate
registerInputDefinition()
protectedregisterInputDefinition(key,def):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:105
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
| Parameter | 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
AbstractSimpleUiNumberDialog.registerInputDefinition
render()
render():
VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:388
Renders the component.
Returns
A JSX element to be rendered.
Inherited from
AbstractSimpleUiNumberDialog.render
renderBackButton()
protectedrenderBackButton(ref,rootCssClassName):null|VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:477
Renders this dialog's back/cancel button.
Parameters
| Parameter | 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
AbstractSimpleUiNumberDialog.renderBackButton
renderBackspaceButton()
protectedrenderBackspaceButton(ref,rootCssClassName):null|VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:459
Renders this dialog's backspace button.
Parameters
| Parameter | 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
AbstractSimpleUiNumberDialog.renderBackspaceButton
renderEnterButton()
protectedrenderEnterButton(ref,rootCssClassName):null|VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:496
Renders this dialog's enter button.
Parameters
| Parameter | 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
AbstractSimpleUiNumberDialog.renderEnterButton
renderInput()
protectedrenderInput(ref,value):VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:139
Renders this dialog's number input.
Parameters
| Parameter | Type | Description |
|---|---|---|
ref | NodeReference<NumberInput> | The reference to which to assign the rendered input. |
value | MutableSubscribable<number> | The value to bind to the input. |
Returns
This dialog's number input, as a VNode.
Overrides
AbstractSimpleUiNumberDialog.renderInput
renderInputToContainer()
protectedrenderInputToContainer(def):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:209
Renders one of this dialog's registered inputs to the input container.
Parameters
| Parameter | Type | Description |
|---|---|---|
def | UiNumberDialogInputDefinition | The definition for the input to render. |
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.renderInputToContainer
renderNumberPad()
protectedrenderNumberPad(ref,rootCssClassName):VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:428
Renders this dialog's number pad.
Parameters
| Parameter | 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
This dialog's number pad, as a VNode.
Inherited from
AbstractSimpleUiNumberDialog.renderNumberPad
renderOtherContents()
protectedrenderOtherContents():null|VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedHeadingDialog/SelectedHeadingDialog.tsx:126
Renders additional contents in this dialog's root container.
Returns
null | VNode
Additional contents in this dialog's root container, as a VNode, or null if there are no additional
contents.
Overrides
AbstractSimpleUiNumberDialog.renderOtherContents
renderOtherNumberPadContents()
protectedrenderOtherNumberPadContents(rootCssClassName):null|VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:449
Renders additional contents in this dialog's number pad container.
Parameters
| Parameter | 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
AbstractSimpleUiNumberDialog.renderOtherNumberPadContents
request()
request(
input):Promise<UiDialogResult<number>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:39
Requests a value from this dialog.
Parameters
| Parameter | Type | Description |
|---|---|---|
input | UiNumberDialogInput | Input parameters defining the request. |
Returns
Promise<UiDialogResult<number>>
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.
Inherited from
AbstractSimpleUiNumberDialog.request
resetActiveInput()
protectedresetActiveInput(key?,initialValue?,resetEditing?):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:178
Resets the active input.
Parameters
| Parameter | 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
AbstractSimpleUiNumberDialog.resetActiveInput
setBackButtonStyle()
protectedsetBackButtonStyle(style):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:124
Sets the style of this dialog's back/cancel button.
Parameters
| Parameter | Type | Description |
|---|---|---|
style | "cancel" | "back" | The style to set. |
Returns
void
Inherited from
AbstractSimpleUiNumberDialog.setBackButtonStyle
validateValueAndClose()
protectedvalidateValueAndClose():Promise<void>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:261
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>