Class: GtcWeightDialog

A dialog which allows the user to enter a weight. The dialog can operate with any arbitrary weight unit type and supports three-, four-, and five-digit inputs.

Hierarchy

• AbstractGtcNumberDialog<GtcWeightDialogInput, GtcWeightDialogOutput, GtcWeightDialogInputDefinition>

  ↳ GtcWeightDialog

Constructors

constructor

• new GtcWeightDialog(props): GtcWeightDialog

Parameters

Name	Type
props	GtcViewProps

Returns

GtcWeightDialog

Inherit Doc

Overrides

AbstractGtcNumberDialog.constructor

Defined in

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

Properties

_activeComponent

• Protected Readonly _activeComponent: Subject<null | GtcInteractionHandler>

Inherited from

AbstractGtcNumberDialog._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

AbstractGtcNumberDialog._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

AbstractGtcNumberDialog._title

Defined in

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

---

activeInputDef

• Protected Optional activeInputDef: GtcWeightDialogInputDefinition

Inherited from

AbstractGtcNumberDialog.activeInputDef

Defined in

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

---

backspaceRef

• Protected Readonly backspaceRef: NodeReference<ImgTouchButton>

Inherited from

AbstractGtcNumberDialog.backspaceRef

Defined in

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

---

bus

• Protected Readonly bus: EventBus

Inherited from

AbstractGtcNumberDialog.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

AbstractGtcNumberDialog.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

AbstractGtcNumberDialog.contextType

Defined in

sdk/components/FSComponent.ts:67

---

gtcService

• Protected Readonly gtcService: GtcService

Inherited from

AbstractGtcNumberDialog.gtcService

Defined in

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

---

inputDefinitions

• Protected Readonly inputDefinitions: Map<string, GtcWeightDialogInputDefinition>

Inherited from

AbstractGtcNumberDialog.inputDefinitions

Defined in

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

---

isAlive

• Protected isAlive: boolean = true

Inherited from

AbstractGtcNumberDialog.isAlive

Defined in

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

---

numpadRef

• Protected Readonly numpadRef: NodeReference<NumberPad>

Inherited from

AbstractGtcNumberDialog.numpadRef

Defined in

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

---

props

• props: GtcViewProps & ComponentProps

The properties of the component.

Inherited from

AbstractGtcNumberDialog.props

Defined in

sdk/components/FSComponent.ts:61

---

resolveFunction

• Protected Optional resolveFunction: (value: any) => void

Type declaration

▸ (value): void

Parameters

Name	Type
value	any

Returns

void

Inherited from

AbstractGtcNumberDialog.resolveFunction

Defined in

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

---

resultObject

• Protected resultObject: GtcDialogResult<GtcWeightDialogOutput>

Inherited from

AbstractGtcNumberDialog.resultObject

Defined in

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

---

rootCssClass

• Protected Readonly rootCssClass: SetSubject<string>

Inherited from

AbstractGtcNumberDialog.rootCssClass

Defined in

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

---

showDecimalButton

• Protected Readonly showDecimalButton: Subject<boolean>

Whether the decimal button is shown. Defaults to false.

Inherited from

AbstractGtcNumberDialog.showDecimalButton

Defined in

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

---

showSignButton

• Protected Readonly showSignButton: Subject<boolean>

Whether the sign button is shown. Defaults to false.

Inherited from

AbstractGtcNumberDialog.showSignButton

Defined in

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

---

sidebarState

• Readonly sidebarState: SidebarStateReadonly

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

Inherited from

AbstractGtcNumberDialog.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

AbstractGtcNumberDialog.title

Defined in

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

Methods

cleanupRequest

▸ cleanupRequest(): void

Clears this dialog's pending request and fulfills the pending request Promise if one exists.

Returns

void

Inherited from

AbstractGtcNumberDialog.cleanupRequest

Defined in

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

---

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

AbstractGtcNumberDialog.destroy

Defined in

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

---

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

AbstractGtcNumberDialog.getContext

Defined in

sdk/components/FSComponent.ts:106

---

getDualConcentricKnobLabel

▸ getDualConcentricKnobLabel(): string

Gets the label key or label string for the dual concentric knob while this dialog is active.

Returns

string

The label key or label string for the dual concentric knob while this dialog is active.

Inherited from

AbstractGtcNumberDialog.getDualConcentricKnobLabel

Defined in

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

---

getInvalidValueMessage

▸ getInvalidValueMessage(): string | VNode

Gets the message to display when attempting to return an invalid value.

Returns

string | VNode

The message to display when attempting to return an invalid value.

Overrides

AbstractGtcNumberDialog.getInvalidValueMessage

Defined in

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

---

getInvalidValueMessageDialogKey

▸ getInvalidValueMessageDialogKey(): string

Gets the key of the message dialog to open to display the invalid value message.

Returns

string

The key of the message dialog to open to display the invalid value message.

Inherited from

AbstractGtcNumberDialog.getInvalidValueMessageDialogKey

Defined in

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

---

getPayload

▸ getPayload(value): GtcWeightDialogOutput

Gets the payload for a completed request.

Parameters

Name	Type	Description
value	number	The numeric value to return with the request.

Returns

GtcWeightDialogOutput

The payload for a completed request.

Overrides

AbstractGtcNumberDialog.getPayload

Defined in

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

---

getRootCssClassName

▸ getRootCssClassName(): string

Gets the CSS class name (singular) for this dialog's root element.

Returns

string

The CSS class name (singular) for this dialog's root element.

Overrides

AbstractGtcNumberDialog.getRootCssClassName

Defined in

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

---

isValueValid

▸ isValueValid(value): boolean

Checks if a value is valid to be returned for a request.

Parameters

Name	Type	Description
value	number	The value to check.

Returns

boolean

Whether the specified value is valid to be returned for a request.

Overrides

AbstractGtcNumberDialog.isValueValid

Defined in

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

---

onAfterRender

▸ onAfterRender(): void

A callback that is called after the component is rendered.

Returns

void

Inherited from

AbstractGtcNumberDialog.onAfterRender

Defined in

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

---

onBackspacePressed

▸ onBackspacePressed(): void

Responds to when this dialog's backspace button is pressed.

Returns

void

Inherited from

AbstractGtcNumberDialog.onBackspacePressed

Defined in

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

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

AbstractGtcNumberDialog.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80

---

onCleanupRequest

▸ onCleanupRequest(): void

A callback method which is called when this dialog cleans up a request. This method is called before the pending request Promise is fulfilled, if one exists.

Returns

void

Inherited from

AbstractGtcNumberDialog.onCleanupRequest

Defined in

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

---

onClose

▸ onClose(): void

The Close lifecycle method

Returns

void

Inherited from

AbstractGtcNumberDialog.onClose

Defined in

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

---

onDecimalPressed

▸ onDecimalPressed(): void

Called when this dialog's decimal button is pressed.

Returns

void

Inherited from

AbstractGtcNumberDialog.onDecimalPressed

Defined in

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

---

onEditingActiveChanged

▸ onEditingActiveChanged(isEditingActive, activeInputDef): void

Responds to when the editing state of this dialog's active number input changes.

Parameters

Name	Type	Description
isEditingActive	boolean	Whether editing is active.
activeInputDef	GtcWeightDialogInputDefinition	The active input definition.

Returns

void

Inherited from

AbstractGtcNumberDialog.onEditingActiveChanged

Defined in

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

---

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

AbstractGtcNumberDialog.onGtcInteractionEvent

Defined in

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

---

onNumberPressed

▸ onNumberPressed(value): void

Responds to when one of this dialog's number pad buttons is pressed.

Parameters

Name	Type	Description
value	number	The value of the button that was pressed.

Returns

void

Inherited from

AbstractGtcNumberDialog.onNumberPressed

Defined in

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

---

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

AbstractGtcNumberDialog.onOpen

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

AbstractGtcNumberDialog.onPause

Defined in

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

---

onRequest

▸ onRequest(input): void

A callback method which is called when this dialog receives a request.

Parameters

Name	Type	Description
input	GtcWeightDialogInput	The input for the request.

Returns

void

Overrides

AbstractGtcNumberDialog.onRequest

Defined in

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

---

onResume

▸ onResume(): void

The Resume lifecycle method

Returns

void

Inherited from

AbstractGtcNumberDialog.onResume

Defined in

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

---

onSignPressed

▸ onSignPressed(): void

Called when this dialog's sign button is pressed.

Returns

void

Inherited from

AbstractGtcNumberDialog.onSignPressed

Defined in

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

---

registerInputDefinition

▸ registerInputDefinition(key, def): void

Registers an input definition with this dialog. Definitions must be registered before this dialog is rendered in order to function properly.

Parameters

Name	Type	Description
key	string	The key to register the definition under. If an existing definition is already registered under the same key, it will be replaced.
def	GtcWeightDialogInputDefinition	The definition to register.

Returns

void

Inherited from

AbstractGtcNumberDialog.registerInputDefinition

Defined in

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

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Inherited from

AbstractGtcNumberDialog.render

Defined in

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

---

renderBackspaceButton

▸ renderBackspaceButton(ref, rootCssClassName): null | VNode

Renders this dialog's backspace button.

Parameters

Name	Type	Description
ref	NodeReference<DisplayComponent<any, []>>	The reference to which to assign the rendered button.
rootCssClassName	undefined | string	The CSS class name for this dialog's root element.

Returns

null | VNode

This dialog's backspace button, as a VNode, or null if this dialog does not have a backspace button.

Inherited from

AbstractGtcNumberDialog.renderBackspaceButton

Defined in

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

---

renderNumberPad

▸ renderNumberPad(ref, rootCssClassName): VNode

Renders this dialog's number pad.

Parameters

Name	Type	Description
ref	NodeReference<NumberPad>	The reference to which to assign the rendered number pad.
rootCssClassName	undefined | string	The CSS class name for this dialog's root element.

Returns

VNode

This dialog's number pad, as a VNode.

Inherited from

AbstractGtcNumberDialog.renderNumberPad

Defined in

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

---

renderOtherContents

▸ renderOtherContents(rootCssClassName): null | VNode

Renders additional contents in this dialog's root container.

Parameters

Name	Type	Description
rootCssClassName	undefined | string	The CSS class name for this dialog's root element.

Returns

null | VNode

Additional contents in this dialog's root container, as a VNode, or null if there are no additional contents.

Inherited from

AbstractGtcNumberDialog.renderOtherContents

Defined in

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

---

renderOtherNumberPadContents

▸ renderOtherNumberPadContents(rootCssClassName): null | VNode

Renders additional contents in this dialog's number pad container.

Parameters

Name	Type	Description
rootCssClassName	undefined | string	The CSS class name for this dialog's root element.

Returns

null | VNode

Additional contents in this dialog's number pad container, as a VNode, or null if there are no additional contents.

Inherited from

AbstractGtcNumberDialog.renderOtherNumberPadContents

Defined in

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

---

request

▸ request(input): Promise<GtcDialogResult<GtcWeightDialogOutput>>

Requests a value from this dialog.

Parameters

Name	Type	Description
input	GtcWeightDialogInput	Input parameters defining the request.

Returns

Promise<GtcDialogResult<GtcWeightDialogOutput>>

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.

Inherited from

AbstractGtcNumberDialog.request

Defined in

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

---

resetActiveInput

▸ resetActiveInput(key?, initialValue?, resetEditing?): void

Resets the active input. This will

Parameters

Name	Type	Default value	Description
key?	string	undefined	The key of the input to set as the active input. Defaults to the key of the current active input.
initialValue?	number	undefined	The initial value to set on the new active input. If not defined, the new active input will retain its current value.
resetEditing	boolean	false	Whether to reset the editing state of this dialog, in effect resetting the Back/Cancel button on the button bar to Back. Defaults to false.

Returns

void

Inherited from

AbstractGtcNumberDialog.resetActiveInput

Defined in

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

---

validateValueAndClose

▸ validateValueAndClose(): Promise<void>

Validates the currently selected value, and if valid sets the value to be returned for the currently pending request and closes this dialog.

Returns

Promise<void>

Inherited from

AbstractGtcNumberDialog.validateValueAndClose

Defined in

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