Class: GtcDesignatedPaneButton

A touchscreen button displaying a label and image whose state is dependent on the designated pane view of a display pane. The button is considered selected when the designated pane view is one of a set of specified views. When selected, the button is marked with a cyan border and optionally displays a different label and image. The button can be configured to execute certain actions based on whether it is selected, including setting the designated and displayed pane views to a specific view.

Hierarchy

• DisplayComponent<GtcDesignatedPaneButtonProps>

  ↳ GtcDesignatedPaneButton

Constructors

constructor

• new GtcDesignatedPaneButton(props): GtcDesignatedPaneButton

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	GtcDesignatedPaneButtonProps	The propertis of the component.

Returns

GtcDesignatedPaneButton

Inherited from

DisplayComponent<GtcDesignatedPaneButtonProps>.constructor

Defined in

sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

DisplayComponent.context

Defined in

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

sdk/components/FSComponent.ts:67

---

props

• props: GtcDesignatedPaneButtonProps & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

sdk/components/FSComponent.ts:61

Methods

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:157

---

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

sdk/components/FSComponent.ts:106

---

onAfterRender

▸ onAfterRender(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:85

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80

---

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:106

---

simulatePressed

▸ simulatePressed(ignoreDisabled?): void

Simulates this button being pressed. This will execute the onPressed() callback if one is defined.

Parameters

Name	Type	Default value	Description
ignoreDisabled	boolean	false	Whether to simulate the button being pressed regardless of whether the button is disabled. Defaults to false.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:101