Class: GtcKeyboardDialog<T>

Allows user to input text using an alphanumeric keyboard.

Type parameters

Name	Type
T	extends Facility | string

Hierarchy

• GtcView<GtcKeyboardDialogProps>

  ↳ GtcKeyboardDialog

Implements

• GtcDialogView<GtcKeyboardDialogParams, Facility | string>

Constructors

constructor

• new GtcKeyboardDialog<T>(props): GtcKeyboardDialog<T>

Creates an instance of a DisplayComponent.

Type parameters

Name	Type
T	extends string | Facility

Parameters

Name	Type	Description
props	GtcKeyboardDialogProps	The propertis of the component.

Returns

GtcKeyboardDialog<T>

Inherited from

GtcView.constructor

Defined in

sdk/components/FSComponent.ts:73

Properties

_activeComponent

• Protected Readonly _activeComponent: Subject<null | GtcInteractionHandler>

Inherited from

GtcView._activeComponent

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:26

---

_sidebarState

• Protected Readonly _sidebarState: GtcSidebarState

Inherited from

GtcView._sidebarState

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

GtcView._title

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:32

---

bus

• Protected Readonly bus: EventBus

Inherited from

GtcView.bus

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

GtcView.context

Defined in

sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

GtcView.contextType

Defined in

sdk/components/FSComponent.ts:67

---

gtcService

• Protected Readonly gtcService: GtcService

Inherited from

GtcView.gtcService

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/GtcView.ts:24

---

props

• props: GtcKeyboardDialogProps & ComponentProps

The properties of the component.

Inherited from

GtcView.props

Defined in

sdk/components/FSComponent.ts:61

---

sidebarState

• Readonly sidebarState: SidebarStateReadonly

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

Inherited from

GtcView.sidebarState

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

GtcView.title

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

GtcView.destroy

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcKeyboardDialog.tsx:748

---

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

GtcView.getContext

Defined in

sdk/components/FSComponent.ts:106

---

onAfterRender

▸ onAfterRender(thisNode): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
thisNode	VNode	The component's VNode.

Returns

void

Overrides

GtcView.onAfterRender

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcKeyboardDialog.tsx:118

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

GtcView.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80

---

onClose

▸ onClose(): void

The Close lifecycle method

Returns

void

Overrides

GtcView.onClose

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcKeyboardDialog.tsx:167

---

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.

Overrides

GtcView.onGtcInteractionEvent

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcKeyboardDialog.tsx:174

---

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

Overrides

GtcView.onOpen

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcKeyboardDialog.tsx:154

---

onPause

▸ onPause(): void

The Pause lifecycle method

Returns

void

Inherited from

GtcView.onPause

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

GtcView.onResume

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

GtcView.render

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcKeyboardDialog.tsx:646

---

request

▸ request(params): Promise<GtcDialogResult<T>>

Requests a value from this dialog.

Parameters

Name	Type	Description
params	GtcKeyboardDialogParams	Input parameters defining the request.

Returns

Promise<GtcDialogResult<T>>

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.

Implementation of

GtcDialogView.request

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Dialog/GtcKeyboardDialog.tsx:188