Class: Keyboard

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Keyboard/Keyboard.tsx:44

A keyboard with buttons for all alphanumeric characters and the space character, a backspace button, and an optional "Find" button. The display of letters and numerals is mutually exclusive, and the keyboard can be toggled between the two states. The letters are ordered alphabetically.

Extends

• DisplayComponent<KeyboardProps>

Constructors

Constructor

new Keyboard(props): Keyboard

Defined in: sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	KeyboardProps	The propertis of the component.

Returns

Keyboard

Inherited from

DisplayComponent.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: KeyboardProps & 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/Keyboard/Keyboard.tsx:226

Destroys this component.

Returns

void

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(thisNode): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Keyboard/Keyboard.tsx:62

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
thisNode	VNode	The component's VNode.

Returns

void

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

---

render()

render(): VNode

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Keyboard/Keyboard.tsx:109

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

renderKey()

protected renderKey(cssClass, char, label): VNode

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Keyboard/Keyboard.tsx:215

Renders a character key.

Parameters

Parameter	Type	Default value	Description
cssClass	string	undefined	CSS class(es) to apply to the key's root element.
char	string	undefined	The character for which to render the key.
label	string	char	The key's label text. Defaults to the same value as char.

Returns

VNode

A key for the specified character, as a VNode.

---

setShowNumpad()

setShowNumpad(show): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Keyboard/Keyboard.tsx:75

Sets whether the keyboard shows the numpad keys instead of the alphabet keys.

Parameters

Parameter	Type	Description
show	boolean	Whether to show the numpad keys.

Returns

void