Interface: TabbedContent<P>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:23
Tab-associated content which can be rendered inside a tabbed container.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
P extends TabbedContentProps | TabbedContentProps |
Properties
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
isTabbedContent
readonlyisTabbedContent:true
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:25
Flags this component as a TabbedContent.
knobLabelState
readonlyknobLabelState:SubscribableMap<UiKnobId,string> &Subscribable<UiKnobRequestedLabelState>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:28
The bezel rotary knob label state requested by this content.
props
props:
P&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
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
onAfterRender()
onAfterRender(
node):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
| Parameter | Type | Description |
|---|---|---|
node | VNode | The component's VNode. |
Returns
void
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
Inherited from
DisplayComponent.onBeforeRender
onClose()
onClose():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:50
Responds to when this content is closed. Content is closed when it is deselected or its parent container is closed.
Returns
void
onDeselect()
onDeselect():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:38
Responds to when this content is deselected.
Returns
void
onOpen()
onOpen():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:44
Responds to when this content is opened. Content is opened when it is selected and its parent container is open.
Returns
void
onPause()
onPause():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:62
Responds to when this content is paused. Content is paused when it is deselected or its parent container is paused.
Returns
void
onResume()
onResume():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:56
Responds to when this content is resumed. Content is resumed when it is selected and its parent container is resumed.
Returns
void
onSelect()
onSelect():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:33
Responds to when this content is selected to be displayed in its parent container.
Returns
void
onUiInteractionEvent()
onUiInteractionEvent(
event):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiInteraction.ts:90
Handles a UiInteractionEvent.
Parameters
| Parameter | Type | Description |
|---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Inherited from
UiInteractionHandler.onUiInteractionEvent
onUpdate()
onUpdate(
time):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TabbedContainer/TabbedContent.ts:69
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
render()
abstractrender():null|VNode
Defined in: src/sdk/components/FSComponent.ts:93
Renders the component.
Returns
null | VNode
A JSX element to be rendered.