Class: DataBarFieldSelectDialog
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/DataBarFieldEditView/DataBarFieldSelectDialog.tsx:40
A dialog which allows the user to select a CNS data bar field type.
Extends
Implements
UiDialogView
<DataBarFieldSelectDialogInput
,NavDataFieldType
>
Constructors
Constructor
new DataBarFieldSelectDialog(
props
):DataBarFieldSelectDialog
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | DataBarFieldSelectDialogProps | The propertis of the component. |
Returns
DataBarFieldSelectDialog
Inherited from
Properties
_knobLabelState
protected
readonly
_knobLabelState:FilteredMapSubject
<UiKnobId
,string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:13
Inherited from
AbstractUiView
._knobLabelState
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
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
focusController
protected
readonly
focusController:UiFocusController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:17
Inherited from
AbstractUiView
.focusController
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
props
props:
DataBarFieldSelectDialogProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
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
AbstractUiView
.createFocusController
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/DataBarFieldEditView/DataBarFieldSelectDialog.tsx:234
Destroys this component.
Returns
void
Overrides
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
onAfterRender()
onAfterRender():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/DataBarFieldEditView/DataBarFieldSelectDialog.tsx:96
A callback that is called after the component is rendered.
Returns
void
Overrides
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
onClose()
onClose():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/DataBarFieldEditView/DataBarFieldSelectDialog.tsx:120
Responds to when this view is closed.
Returns
void
Overrides
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
AbstractUiView
.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
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
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
onResume()
onResume():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:39
Responds to when this view is resumed.
Returns
void
Inherited from
onUiInteractionEvent()
onUiInteractionEvent(
event
):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/DataBarFieldEditView/DataBarFieldSelectDialog.tsx:137
Handles a UiInteractionEvent.
Parameters
Parameter | Type | Description |
---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Overrides
AbstractUiView
.onUiInteractionEvent
onUpdate()
onUpdate(
time
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/DataBarFieldEditView/DataBarFieldSelectDialog.tsx:125
Called every update cycle.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Overrides
render()
render():
VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/DataBarFieldEditView/DataBarFieldSelectDialog.tsx:164
Renders the component.
Returns
VNode
A JSX element to be rendered.
Overrides
request()
request(
input
):Promise
<UiDialogResult
<NavDataFieldType
>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Views/DataBarFieldEditView/DataBarFieldSelectDialog.tsx:101
Requests a value from this dialog.
Parameters
Parameter | Type | Description |
---|---|---|
input | DataBarFieldSelectDialogInput | Input parameters defining the request. |
Returns
Promise
<UiDialogResult
<NavDataFieldType
>>
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.