Skip to main content

Abstract Class: AbstractTabbedContent<P>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:10

An abstract implementation of TabbedContent.

Extends

  • DisplayComponent<P>

Extended by

Type Parameters

Type ParameterDefault type
P extends TabbedContentPropsTabbedContentProps

Implements

Constructors

Constructor

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

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsPThe propertis of the component.

Returns

AbstractTabbedContent<P>

Inherited from

DisplayComponent<P>.constructor

Properties

_knobLabelState

protected readonly _knobLabelState: MapSubject<UiKnobId, string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:14


context?

optional context: [] = undefined

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

The context on this component, if any.

Implementation of

TabbedContent.context

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Implementation of

TabbedContent.contextType

Inherited from

DisplayComponent.contextType


isTabbedContent

readonly isTabbedContent: true = true

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:12

Flags this component as a TabbedContent.

Implementation of

TabbedContent.isTabbedContent


knobLabelState

readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:16

The bezel rotary knob label state requested by this content.

Implementation of

TabbedContent.knobLabelState


props

props: P & ComponentProps

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

The properties of the component.

Implementation of

TabbedContent.props

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Implementation of

TabbedContent.destroy

Inherited from

DisplayComponent.destroy


getContext()

protected getContext(context): never

Defined in: src/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.

Implementation of

TabbedContent.getContext

Inherited from

DisplayComponent.getContext


onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Implementation of

TabbedContent.onAfterRender

Inherited from

DisplayComponent.onAfterRender


onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Implementation of

TabbedContent.onBeforeRender

Inherited from

DisplayComponent.onBeforeRender


onClose()

onClose(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:34

Responds to when this content is closed. Content is closed when it is deselected or its parent container is closed.

Returns

void

Implementation of

TabbedContent.onClose


onDeselect()

onDeselect(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:24

Responds to when this content is deselected.

Returns

void

Implementation of

TabbedContent.onDeselect


onOpen()

onOpen(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:29

Responds to when this content is opened. Content is opened when it is selected and its parent container is open.

Returns

void

Implementation of

TabbedContent.onOpen


onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:44

Responds to when this content is paused. Content is paused when it is deselected or its parent container is paused.

Returns

void

Implementation of

TabbedContent.onPause


onResume()

onResume(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:39

Responds to when this content is resumed. Content is resumed when it is selected and its parent container is resumed.

Returns

void

Implementation of

TabbedContent.onResume


onSelect()

onSelect(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:19

Responds to when this content is selected to be displayed in its parent container.

Returns

void

Implementation of

TabbedContent.onSelect


onUiInteractionEvent()

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:56

Handles a UiInteractionEvent.

Parameters

ParameterTypeDescription
eventUiInteractionEventThe event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

TabbedContent.onUiInteractionEvent


onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:50

Responds to when this content is updated. Content is updated when it is selected and its parent container is updated.

Parameters

ParameterTypeDescription
timenumberThe current real (operating system) time, as a Javascript timestamp.

Returns

void

Implementation of

TabbedContent.onUpdate


render()

abstract render(): null | VNode

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

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Implementation of

TabbedContent.render

Inherited from

DisplayComponent.render