Class: GtcListDialog
A pop-up dialog which allows the user to select an item from a scrolling list.
Hierarchy
↳
GtcListDialog
Implements
GtcDialogView<GtcListDialogParams<any>,any>
Constructors
constructor
• new GtcListDialog(props): GtcListDialog
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | GtcViewProps | The propertis of the component. |
Returns
Inherited from
Defined in
sdk/components/FSComponent.ts:73
Properties
_activeComponent
• Protected Readonly _activeComponent: Subject<null | GtcInteractionHandler>
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:26
_sidebarState
• Protected Readonly _sidebarState: GtcSidebarState
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:28
_title
• Protected Readonly _title: Subject<undefined | string>
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:32
bus
• Protected Readonly bus: EventBus
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:23
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:67
gtcService
• Protected Readonly gtcService: GtcService
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:24
props
• props: GtcViewProps & ComponentProps
The properties of the component.
Inherited from
Defined in
sdk/components/FSComponent.ts:61
sidebarState
• Readonly sidebarState: SidebarStateReadonly
The GTC sidebar state (labels and buttons) requested by this view.
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:30
title
• Readonly title: Subscribable<undefined | string>
This view's title.
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:34
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Overrides
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcListDialog.tsx:243
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
sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
A callback that is called after the component is rendered.
Returns
void
Overrides
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcListDialog.tsx:100
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
Defined in
sdk/components/FSComponent.ts:80
onClose
▸ onClose(): void
The Close lifecycle method
Returns
void
Overrides
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcListDialog.tsx:166
onGtcInteractionEvent
▸ onGtcInteractionEvent(event): boolean
Called when there is an interaction event when this is the active view.
Parameters
| Name | Type | Description |
|---|---|---|
event | GtcInteractionEvent | The event. |
Returns
boolean
Whether the event was handled or not.
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:65
onOpen
▸ onOpen(wasPreviouslyOpened): void
The Open lifecycle method
Parameters
| Name | Type | Description |
|---|---|---|
wasPreviouslyOpened | boolean | True when this view was open in a previous view stack (like if the go back button was used to reach this page). |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:42
onPause
▸ onPause(): void
The Pause lifecycle method
Returns
void
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:52
onResume
▸ onResume(): void
The Resume lifecycle method
Returns
void
Inherited from
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:57
render
▸ render(): VNode
Renders the component.
Returns
VNode
A JSX element to be rendered.
Overrides
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcListDialog.tsx:224
request
▸ request<T>(input): Promise<GtcDialogResult<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 | GtcListDialogParams<T> | The input parameters. |
Returns
Promise<GtcDialogResult<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
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcListDialog.tsx:112