Skip to main content

Class: CharInputSlot

A cursor input slot which allows the user to select a single arbitrary character.

Hierarchy

Constructors

constructor

new CharInputSlot(props): CharInputSlot

Creates an instance of a DisplayComponent.

Parameters

NameTypeDescription
propsCharInputSlotPropsThe propertis of the component.

Returns

CharInputSlot

Inherited from

DisplayComponent<CharInputSlotProps>.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: CharInputSlotProps & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

sdk/components/FSComponent.ts:61

Accessors

value

get value(): Subscribable<string>

The value bound to this slot.

Returns

Subscribable<string>

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/CharInput/CharInputSlot.tsx:74

Methods

decrementValue

decrementValue(): boolean

Decrements this slot's value.

Returns

boolean

Whether the decrement operation was accepted.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/CharInput/CharInputSlot.tsx:123


destroy

destroy(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/CharInput/CharInputSlot.tsx:258


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
contextneverThe 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


incrementValue

incrementValue(): boolean

Increments this slot's value.

Returns

boolean

Whether the increment operation was accepted.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/CharInput/CharInputSlot.tsx:115


onAfterRender

onAfterRender(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/CharInput/CharInputSlot.tsx:83


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/CharInput/CharInputSlot.tsx:219


setAllowEmptyValue

setAllowEmptyValue(allow): void

Sets whether this slot should allow its value to be set to the empty string. Disallowing empty string values will not cause this slot's current value to change, even if the current value is the empty string.

Parameters

NameTypeDescription
allowbooleanWhether this slot should allow its value to be set to the empty string.

Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/CharInput/CharInputSlot.tsx:96


setChar

setChar(char, force?): boolean

Sets the value of this slot's character.

Parameters

NameTypeDescription
charnull | stringThe value to set.
force?booleanWhether to force the character to accept a value that would normally be invalid. Defaults to false.

Returns

boolean

Whether the operation was accepted.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/CharInput/CharInputSlot.tsx:133


setValue

setValue(value): string

Sets the value of this slot. As part of the operation, this slot's character will be set to a non-null representation of the new value, if possible. The value of this slot after the operation is complete may differ from the requested value depending on whether the requested value can be accurately represented by this slot.

Parameters

NameTypeDescription
valuestringThe new value.

Returns

string

The value of this slot after the operation is complete.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/CharInput/CharInputSlot.tsx:107