Interface: UiPaneContent<P>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContent.ts:7
Content rendered inside a UI pane.
Extends
DisplayComponent
<P
>
Type Parameters
Type Parameter | Default type |
---|---|
P extends ComponentProps | ComponentProps |
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
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.
Inherited from
DisplayComponent.contextType
isUiPaneContent
readonly
isUiPaneContent:true
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContent.ts:9
Flags this component as a UiPaneContent.
props
props:
P
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
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
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(
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
onInit()
onInit(
sizeMode
,dimensions
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContent.ts:16
Responds to when this content is initially rendered to its parent pane.
Parameters
Parameter | Type | Description |
---|---|---|
sizeMode | UiPaneSizeMode | The size mode of this content's parent pane. |
dimensions | ReadonlyFloat64Array | The dimensions of this content's parent pane, as [width, height] in pixels. |
Returns
void
onPause()
onPause():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContent.ts:28
Responds to when this content's parent pane is made either hidden or asleep.
Returns
void
onResize()
onResize(
sizeMode
,dimensions
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContent.ts:35
Responds when this content's parent pane is resized while it is visible and awake.
Parameters
Parameter | Type | Description |
---|---|---|
sizeMode | UiPaneSizeMode | The new size mode of this content's pane. |
dimensions | ReadonlyFloat64Array | The new dimensions of this content's pane, as [width, height] in pixels. |
Returns
void
onResume()
onResume(
sizeMode
,dimensions
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContent.ts:23
Responds to when this content's parent pane is made visible and awake.
Parameters
Parameter | Type | Description |
---|---|---|
sizeMode | UiPaneSizeMode | The size mode of this content's parent pane. |
dimensions | ReadonlyFloat64Array | The dimensions of this content's parent pane, as [width, height] in pixels. |
Returns
void
onUpdate()
onUpdate(
time
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContent.ts:41
Called every update cycle.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
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.
Inherited from
DisplayComponent.render