Class: UiListDialog
A pop-up dialog which allows the user to select an item from a vertically scrolling list.
Hierarchy
↳
UiListDialog
Implements
UiDialogView<UiListDialogParams<any>,any>
Constructors
constructor
• new UiListDialog(props): UiListDialog
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | UiViewProps | The propertis of the component. |
Returns
Inherited from
Defined in
src/sdk/components/FSComponent.ts:73
Properties
_knobLabelState
• Protected Readonly _knobLabelState: FilteredMapSubject<UiKnobId, string>
Inherited from
AbstractUiView._knobLabelState
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:13
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
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
Defined in
src/sdk/components/FSComponent.ts:67
focusController
• Protected Readonly focusController: UiFocusController
Inherited from
AbstractUiView.focusController
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:17
knobLabelState
• Readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>
The bezel rotary knob label state requested by this view.
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:15
props
• props: UiViewProps & ComponentProps
The properties of the component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:61
Methods
createFocusController
▸ createFocusController(): UiFocusController
Creates a new focus controller for this view.
Returns
A new focus controller.
Inherited from
AbstractUiView.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
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/UiListDialog.tsx:326
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
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
A callback that is called after the component is rendered.
Returns
void
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/UiListDialog.tsx:143
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
Defined in
src/sdk/components/FSComponent.ts:80
onClose
▸ onClose(): void
Responds to when this view is closed.
Returns
void
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/UiListDialog.tsx:232
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
AbstractUiView.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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:44
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
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:39
onUiInteractionEvent
▸ onUiInteractionEvent(event): boolean
Handles a UiInteractionEvent.
Parameters
| Name | Type | Description |
|---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Overrides
AbstractUiView.onUiInteractionEvent
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/UiListDialog.tsx:237
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:62
render
▸ render(): VNode
Renders the component.
Returns
VNode
A JSX element to be rendered.
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/UiListDialog.tsx:304
request
▸ request<T>(input): Promise<UiDialogResult<T>>
Requests a selected value from this dialog. Based on the input parameters, the dialog will display a list of buttons, each one causing a certain value to be selected when pressed.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
input | UiListDialogParams<T> | The input parameters. |
Returns
Promise<UiDialogResult<T>>
A Promise which is fulfilled with the selected value when a selection is made, or with an empty payload
if this dialog is closed or request() is called again before a selection is made.
Throws
Error if the dialog has been destroyed.
Implementation of
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Dialogs/UiListDialog.tsx:155