Class: TabbedContainer
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Tabs/TabbedContainer.tsx:68
A TabbedContainer which holds TabbedContent(s)
Extends
DisplayComponent
<TabbedContainerProps
>
Constructors
Constructor
new TabbedContainer(
props
):TabbedContainer
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | TabbedContainerProps | The propertis of the component. |
Returns
TabbedContainer
Inherited from
DisplayComponent<TabbedContainerProps>.constructor
Properties
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
props
props:
TabbedContainerProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Tabs/TabbedContainer.tsx:211
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: 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
DisplayComponent.getContext
onAfterRender()
onAfterRender():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Tabs/TabbedContainer.tsx:78
Returns
void
Inherit Doc
Overrides
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
pause()
pause():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Tabs/TabbedContainer.tsx:170
Pause the currently-selected tab's content view
Returns
void
render()
render():
VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Tabs/TabbedContainer.tsx:177
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
resume()
resume():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Tabs/TabbedContainer.tsx:163
Resume the currently-selected tab's content view
Returns
void
selectTab()
selectTab(
position
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Tabs/TabbedContainer.tsx:124
Selects and opens a tab. If the chosen tab is disabled, this method does nothing.
Parameters
Parameter | Type | Description |
---|---|---|
position | number | The position at which the tab to select is located. |
Returns
void
Throws
Error if no tab exists at the specified position.
setTabEnabled()
setTabEnabled(
position
,enabled
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Tabs/TabbedContainer.tsx:152
Sets whether a tab is enabled. If a tab is enabled, it can be freely selected. If a tab is disabled, it cannot be selected. Disabling the currently selected tab will not close the tab or change the selected tab, but will prevent it from being re-selected while it remains disabled once the selected tab changes.
Parameters
Parameter | Type | Description |
---|---|---|
position | number | The position of the tab to enable or disable. |
enabled | boolean | Whether the tab should be enabled. |
Returns
void