Skip to main content

Abstract Class: GtcView<P>

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

A GtcView component

Extends

  • DisplayComponent<P>

Extended by

Type Parameters

Type ParameterDefault type
P extends GtcViewPropsGtcViewProps

Implements

Constructors

Constructor

new GtcView<P>(props): GtcView<P>

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsPThe propertis of the component.

Returns

GtcView<P>

Inherited from

DisplayComponent<P>.constructor

Properties

_activeComponent

protected readonly _activeComponent: Subject<null | GtcInteractionHandler>

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


_sidebarState

protected readonly _sidebarState: GtcSidebarState

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


_title

protected readonly _title: Subject<undefined | string>

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


bus

protected readonly bus: EventBus

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


context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

DisplayComponent.contextType


gtcService

protected readonly gtcService: GtcService

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


props

props: P & ComponentProps

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

The properties of the component.

Inherited from

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


title

readonly title: Subscribable<undefined | string>

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

This view's title.

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy


getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe 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

DisplayComponent.getContext


onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

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

DisplayComponent.onBeforeRender


onClose()

onClose(): void

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

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


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

ParameterTypeDescription
eventGtcInteractionEventThe event.

Returns

boolean

Whether the event was handled or not.

Implementation of

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


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

ParameterTypeDescription
wasPreviouslyOpenedbooleanTrue when this view was open in a previous view stack (like if the go back button was used to reach this page).

Returns

void


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


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


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


render()

abstract render(): null | VNode

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

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render