Class: TabbedContainer
A container which displays content organized into an arbitrary number of tabs. Only the content associated with one tab is displayed at any given time. Tabs are displayed on one of the four edges of the container in a list which supports scrolling if the total number of tabs exceeds the amount that can be displayed simultaneously.
The container's contents are added as children that implement the TabbedContent interface. It is forbidden to add children to TabbedContainer that do not implement TabbedContent. Each TabbedContent child defines one tab and its contents. The order in which tabs are presented in the container's tab list is the same as the order in which their associated TabbedContents were added to the container as children.
Hierarchy
DisplayComponent<TabbedContainerProps>↳
TabbedContainer
Implements
Constructors
constructor
• new TabbedContainer(props): TabbedContainer
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | TabbedContainerProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<TabbedContainerProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
src/sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
knobLabelState
• Readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>
The bezel rotary knob label state requested by this container.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:171
props
• props: TabbedContainerProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
close
▸ close(): void
Closes this container. This will close the currently selected tab, if one exists. If the container is resumed, then this will also pause the container before closing it.
Returns
void
Throws
Error if this container has been destroyed.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:316
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:849
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
DisplayComponent.getContext
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:183
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
onUiInteractionEvent
▸ onUiInteractionEvent(event): boolean
Handles a UiInteractionEvent.
Parameters
| Name | Type | Description |
|---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Implementation of
UiInteractionHandler.onUiInteractionEvent
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:595
open
▸ open(): void
Opens this container. This will open the currently selected tab, if one exists. While open, this container can be updated.
Returns
void
Throws
Error if this container has been destroyed.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:290
pause
▸ pause(): void
Pauses this container. This will pause the currently selected tab, if one exists.
Returns
void
Throws
Error if this container has been destroyed.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:377
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:713
resume
▸ resume(): void
Resumes this container. This will resume the currently selected tab, if one exists. If the container is closed, then this will also open the container before resuming it. While resumed, the container will forward requested bezel rotary knob label states from the selected tab and handle UI interaction events (including routing events to the selected tab).
Returns
void
Throws
Error if this container has been destroyed.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:346
selectFirstTab
▸ selectFirstTab(startIndex?): number
Selects the lowest-indexed enabled tab. Tabs are indexed in the order in which they were added to this container as children.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
startIndex | number | 0 | The index from which to start the search for enabled tabs to select. Defaults to 0. |
Returns
number
The index of the selected tab, or -1 if there were no enabled tabs to select.
Throws
Error if this container has been destroyed or has not been rendered.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:546
selectLastTab
▸ selectLastTab(startIndex?): number
Selects the highest-indexed enabled tab. Tabs are indexed in the order in which they were added to this container as children.
Parameters
| Name | Type | Description |
|---|---|---|
startIndex | number | The index from which to start the search for enabled tabs to select. Defaults to the index of this container's highest-indexed tab. |
Returns
number
The index of the selected tab, or -1 if there were no enabled tabs to select.
Throws
Error if this container has been destroyed or has not been rendered.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:574
selectNextTab
▸ selectNextTab(): number
Selects the lowest-indexed enabled tab with a higher index than the currently selected tab. If there is no currently selected tab, then selects the overall lowest-indexed enabled tab. Tabs are indexed in the order in which they were added to this container as children.
Returns
number
The index of the selected tab, or -1 if there were no enabled tabs to select.
Throws
Error if this container has been destroyed or has not been rendered.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:508
selectPrevTab
▸ selectPrevTab(): number
Selects the highest-indexed enabled tab with a lower index than the currently selected tab. If there is no currently selected tab, then selects the overall highest-indexed enabled tab. Tabs are indexed in the order in which they were added to this container as children.
Returns
number
The index of the selected tab, or -1 if there were no enabled tabs to select.
Throws
Error if this container has been destroyed or has not been rendered.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:527
selectTabIndex
▸ selectTabIndex(index): void
Selects a tab by index. Tabs are indexed in the order in which they were added to this container as children.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the tab to select, or -1 to deselect the currently selected tab without selecting a new tab. |
Returns
void
Throws
Error if this container has been destroyed or has not been rendered.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:428
update
▸ update(time): void
Updates this container. This will update the currently selected tab, if one exists. If this container is closed, then this method does nothing.
Parameters
| Name | Type | Description |
|---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Throws
Error if this container has been destroyed.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TabbedContainer/TabbedContainer.tsx:407