Class: GtcListDialog

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcListDialog.tsx:72

A pop-up dialog which allows the user to select an item from a scrolling list.

Extends

• GtcView

Implements

• GtcDialogView<GtcListDialogParams<any>, any>

Constructors

Constructor

new GtcListDialog(props): GtcListDialog

Defined in: sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	GtcViewProps	The propertis of the component.

Returns

GtcListDialog

Inherited from

GtcView.constructor

Properties

_activeComponent

protected readonly _activeComponent: Subject<null | GtcInteractionHandler>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:34

Inherited from

GtcView._activeComponent

---

_sidebarState

protected readonly _sidebarState: GtcSidebarState

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:36

Inherited from

GtcView._sidebarState

---

_title

protected readonly _title: Subject<undefined | string>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:40

Inherited from

GtcView._title

---

bus

protected readonly bus: EventBus

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:31

Inherited from

GtcView.bus

---

context?

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

GtcView.context

---

contextType?

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

GtcView.contextType

---

gtcService

protected readonly gtcService: GtcService

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:32

Inherited from

GtcView.gtcService

---

props

props: GtcViewProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

GtcView.props

---

sidebarState

readonly sidebarState: SidebarStateReadonly

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:38

The GTC sidebar state (labels and buttons) requested by this view.

Inherited from

GtcView.sidebarState

---

title

readonly title: Subscribable<undefined | string>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:42

This view's title.

Inherited from

GtcView.title

Methods

destroy()

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcListDialog.tsx:243

Destroys this component.

Returns

void

Overrides

GtcView.destroy

---

getContext()

protected getContext(context): never

Defined in: 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

GtcView.getContext

---

onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcListDialog.tsx:100

A callback that is called after the component is rendered.

Returns

void

Overrides

GtcView.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

GtcView.onBeforeRender

---

onClose()

onClose(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcListDialog.tsx:166

A method that is called when this view is closed. A view is closed when it does not appear in the most recent history state of its parent view stack.

Returns

void

Overrides

GtcView.onClose

---

onGtcInteractionEvent()

onGtcInteractionEvent(event): boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:97

Called when there is an interaction event when this is the active view.

Parameters

Parameter	Type	Description
event	GtcInteractionEvent	The event.

Returns

boolean

Whether the event was handled or not.

Inherited from

GtcView.onGtcInteractionEvent

---

onInUse()

onInUse(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:48

A method that is called when this view comes into use. A view is in-use when it appears in at least one history state of its parent view stack.

Returns

void

Inherited from

GtcView.onInUse

---

onOpen()

onOpen(wasPreviouslyOpened): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:67

A method that is called when this view is opened. A view is open when it appears in the most recent history state of its parent view stack.

Parameters

Parameter	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

GtcView.onOpen

---

onOutOfUse()

onOutOfUse(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:56

A method that is called when this view goes out of use. A view is out-of-use when it does not appear in any history states of its parent view stack.

Returns

void

Inherited from

GtcView.onOutOfUse

---

onPause()

onPause(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:89

A method that is called when this view is paused. A view is paused when it is not the active view.

Returns

void

Inherited from

GtcView.onPause

---

onResume()

onResume(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:82

A method that is called when this view is resumed. A view is resumed when it is the active view.

Returns

void

Inherited from

GtcView.onResume

---

render()

render(): VNode

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcListDialog.tsx:224

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

GtcView.render

---

request()

request<T>(input): Promise<GtcDialogResult<T>>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcListDialog.tsx:112

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

Type Parameter
T

Parameters

Parameter	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

GtcDialogView.request