Class: SelectedCourseDialog
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:29
A dialog that allows the user to enter a selected course value.
Extends
Constructors
Constructor
new SelectedCourseDialog(
props
):SelectedCourseDialog
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:27
Parameters
Parameter | Type |
---|---|
props | UiViewProps |
Returns
SelectedCourseDialog
Inherit Doc
Inherited from
AbstractSimpleUiNumberDialog
.constructor
Properties
_knobLabelState
protected
readonly
_knobLabelState:FilteredMapSubject
<UiKnobId
,string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:13
Inherited from
AbstractSimpleUiNumberDialog
._knobLabelState
activeInputDef?
protected
optional
activeInputDef:UiNumberDialogInputDefinition
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:80
Inherited from
AbstractSimpleUiNumberDialog
.activeInputDef
backButtonImgSrc
protected
readonly
backButtonImgSrc:Subject
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:76
Inherited from
AbstractSimpleUiNumberDialog
.backButtonImgSrc
backButtonLabel
protected
readonly
backButtonLabel:Subject
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:75
Inherited from
AbstractSimpleUiNumberDialog
.backButtonLabel
backRef
protected
readonly
backRef:NodeReference
<ImgTouchButton
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:69
Inherited from
AbstractSimpleUiNumberDialog
.backRef
backspaceRef
protected
readonly
backspaceRef:NodeReference
<ImgTouchButton
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:68
Inherited from
AbstractSimpleUiNumberDialog
.backspaceRef
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
AbstractSimpleUiNumberDialog
.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
AbstractSimpleUiNumberDialog
.contextType
enterRef
protected
readonly
enterRef:NodeReference
<ImgTouchButton
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:70
Inherited from
AbstractSimpleUiNumberDialog
.enterRef
focusController
protected
readonly
focusController:UiFocusController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:17
Inherited from
AbstractSimpleUiNumberDialog
.focusController
inputContainerRef
protected
readonly
inputContainerRef:NodeReference
<HTMLDivElement
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:66
Inherited from
AbstractSimpleUiNumberDialog
.inputContainerRef
inputDefinitions
protected
readonly
inputDefinitions:Map
<string
,UiNumberDialogInputDefinition
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:78
Inherited from
AbstractSimpleUiNumberDialog
.inputDefinitions
inputRef
protected
readonly
inputRef:NodeReference
<NumberInput
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractSimpleUiNumberDialog.tsx:21
Inherited from
AbstractSimpleUiNumberDialog
.inputRef
isAlive
protected
isAlive:boolean
=true
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:87
Inherited from
AbstractSimpleUiNumberDialog
.isAlive
isEnterButtonEnabled
protected
readonly
isEnterButtonEnabled: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
readonly
knobLabelState: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
protected
readonly
numpadRef:NodeReference
<NumberPad
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:67
Inherited from
AbstractSimpleUiNumberDialog
.numpadRef
props
props:
UiViewProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
AbstractSimpleUiNumberDialog
.props
resolveFunction()?
protected
optional
resolveFunction: (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
protected
resultObject:UiDialogResult
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:83
Inherited from
AbstractSimpleUiNumberDialog
.resultObject
rootCssClass
protected
readonly
rootCssClass:SetSubject
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:71
Inherited from
AbstractSimpleUiNumberDialog
.rootCssClass
showDecimalButton
protected
readonly
showDecimalButton: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
protected
readonly
showSignButton: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
protected
readonly
title:Subject
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:73
Inherited from
AbstractSimpleUiNumberDialog
.title
value
protected
readonly
value: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()
protected
cleanupRequest():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()
protected
createFocusController():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/SelectedCourseDialog/SelectedCourseDialog.tsx:192
Destroys this component.
Returns
void
Overrides
AbstractSimpleUiNumberDialog
.destroy
getContext()
protected
getContext(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()
protected
getInvalidValueMessage():string
|VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:105
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()
protected
getInvalidValueMessageDialogLayerAndKey(): [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()
protected
getPayload(value
):number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:110
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()
protected
getRootCssClassName():string
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:120
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()
protected
isValueValid(value
):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:100
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/SelectedCourseDialog/SelectedCourseDialog.tsx:47
A callback that is called after the component is rendered.
Returns
void
Overrides
AbstractSimpleUiNumberDialog
.onAfterRender
onBackPressed()
protected
onBackPressed():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()
protected
onBackspacePressed():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()
protected
onCleanupRequest():void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:115
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
Overrides
AbstractSimpleUiNumberDialog
.onCleanupRequest
onClose()
onClose():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Dialogs/AbstractUiNumberDialog.tsx:220
Responds to when this view is closed.
Returns
void
Inherited from
AbstractSimpleUiNumberDialog
.onClose
onDecimalPressed()
protected
onDecimalPressed():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()
protected
onEditingActiveChanged(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()
protected
onEnterPressed():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()
protected
onNumberPressed(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/Shared/UiSystem/AbstractUiView.ts:29
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
Inherited from
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()
protected
onRequest(input
):number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:88
A callback method which is called when this dialog receives a request.
Parameters
Parameter | Type | Description |
---|---|---|
input | SelectedCourseDialogInput | 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()
protected
onSignPressed():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()
protected
registerInputDefinition(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
VNode
A JSX element to be rendered.
Inherited from
AbstractSimpleUiNumberDialog
.render
renderBackButton()
protected
renderBackButton(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()
protected
renderBackspaceButton(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()
protected
renderEnterButton(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()
protected
renderInput(ref
,value
):VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:153
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
VNode
This dialog's number input, as a VNode.
Overrides
AbstractSimpleUiNumberDialog
.renderInput
renderInputToContainer()
protected
renderInputToContainer(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()
protected
renderNumberPad(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
VNode
This dialog's number pad, as a VNode.
Inherited from
AbstractSimpleUiNumberDialog
.renderNumberPad
renderOtherContents()
protected
renderOtherContents():null
|VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/SelectedCourseDialog/SelectedCourseDialog.tsx:140
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()
protected
renderOtherNumberPadContents(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 | SelectedCourseDialogInput | 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()
protected
resetActiveInput(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()
protected
setBackButtonStyle(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()
protected
validateValueAndClose():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
>