Class: GenericTabbedContent
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:73
A generic implementation of TabbedContent which renders its children as-is and defers callback logic to
functions passed to its props.
Extends
Constructors
Constructor
new GenericTabbedContent(
props):GenericTabbedContent
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
| Parameter | Type | Description |
|---|---|---|
props | GenericTabbedContentProps | The propertis of the component. |
Returns
GenericTabbedContent
Inherited from
AbstractTabbedContent.constructor
Properties
_knobLabelState
protectedreadonly_knobLabelState:MapSubject<UiKnobId,string>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:14
Inherited from
AbstractTabbedContent._knobLabelState
context?
optionalcontext: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonlyoptionalcontextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
AbstractTabbedContent.contextType
isTabbedContent
readonlyisTabbedContent:true=true
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/AbstractTabbedContent.ts:12
Flags this component as a TabbedContent.
Inherited from
AbstractTabbedContent.isTabbedContent
knobLabelState
readonlyknobLabelState: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.
Inherited from
AbstractTabbedContent.knobLabelState
props
props:
GenericTabbedContentProps&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:135
Destroys this component.
Returns
void
Overrides
getContext()
protectedgetContext(context):never
Defined in: src/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
AbstractTabbedContent.getContext
onAfterRender()
onAfterRender(
thisNode):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:81
A callback that is called after the component is rendered.
Parameters
| Parameter | Type | Description |
|---|---|---|
thisNode | VNode | The component's VNode. |
Returns
void
Overrides
AbstractTabbedContent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
AbstractTabbedContent.onBeforeRender
onClose()
onClose():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:103
Responds to when this content is closed. Content is closed when it is deselected or its parent container is closed.
Returns
void
Overrides
onDeselect()
onDeselect():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:93
Responds to when this content is deselected.
Returns
void
Overrides
AbstractTabbedContent.onDeselect
onOpen()
onOpen():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:98
Responds to when this content is opened. Content is opened when it is selected and its parent container is open.
Returns
void
Overrides
onPause()
onPause():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:113
Responds to when this content is paused. Content is paused when it is deselected or its parent container is paused.
Returns
void
Overrides
onResume()
onResume():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:108
Responds to when this content is resumed. Content is resumed when it is selected and its parent container is resumed.
Returns
void
Overrides
AbstractTabbedContent.onResume
onSelect()
onSelect():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:88
Responds to when this content is selected to be displayed in its parent container.
Returns
void
Overrides
AbstractTabbedContent.onSelect
onUiInteractionEvent()
onUiInteractionEvent(
event):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:123
Handles a UiInteractionEvent.
Parameters
| Parameter | Type | Description |
|---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Overrides
AbstractTabbedContent.onUiInteractionEvent
onUpdate()
onUpdate(
time):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:118
Responds to when this content is updated. Content is updated when it is selected and its parent container is updated.
Parameters
| Parameter | Type | Description |
|---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Overrides
AbstractTabbedContent.onUpdate
render()
render():
VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/GenericTabbedContent.tsx:128
Renders the component.
Returns
VNode
A JSX element to be rendered.