Class: InputBoxTsc<T>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBoxTsc.tsx:7

An input box that can take inputs from the TSC or MF controller.

Extends

• InputBox<T>

Type Parameters

Type Parameter
T extends string | number

Constructors

Constructor

new InputBoxTsc<T>(props): InputBoxTsc<T>

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	InputBoxProps	The propertis of the component.

Returns

InputBoxTsc<T>

Inherited from

InputBox.constructor

Properties

_isActive

protected readonly _isActive: Subject<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:95

Inherited from

InputBox._isActive

---

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

InputBox.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

InputBox.contextType

---

dragRef

readonly dragRef: NodeReference<HTMLElement>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:111

Inherited from

InputBox.dragRef

---

inputId

readonly inputId: string

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:112

Inherited from

InputBox.inputId

---

inputRef

readonly inputRef: NodeReference<HTMLInputElement>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:109

Inherited from

InputBox.inputRef

---

isActive

readonly isActive: Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:98

Inherited from

InputBox.isActive

---

isCapturing

readonly isCapturing: Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:99

Inherited from

InputBox.isCapturing

---

isEnabled

readonly isEnabled: Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:93

Inherited from

InputBox.isEnabled

---

isError

readonly isError: Subscribable<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:97

Inherited from

InputBox.isError

---

isReadOnly

protected readonly isReadOnly: boolean

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:101

Inherited from

InputBox.isReadOnly

---

props

props: InputBoxProps<T> & ComponentProps

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

The properties of the component.

Inherited from

InputBox.props

---

subscriptions

protected subscriptions: Subscription[] = []

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:121

Inherited from

InputBox.subscriptions

Methods

applyDragBounds()

applyDragBounds(value): number

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:257

Restrict upper/lower bounds of input

Parameters

Parameter	Type	Description
value	number	number to check

Returns

number

number

Inherited from

InputBox.applyDragBounds

---

destroy()

destroy(): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBoxTsc.tsx:83

Destroys this component.

Returns

void

Overrides

InputBox.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

InputBox.getContext

---

handleError()

handleError(): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:404

Handles any errors

Returns

void

Inherited from

InputBox.handleError

---

handleInput()

protected readonly handleInput(): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBoxTsc.tsx:63

Handles the input event from the input element.

Returns

void

Overrides

InputBox.handleInput

---

isValidator()

protected isValidator(formatter): formatter is Formatter<T, string> | Validator<T>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:330

Checks if a formatter is also a validator.

Parameters

Parameter	Type	Description
formatter	unknown	The formatter to check.

Returns

formatter is Formatter<T, string> | Validator<T>

true if the formatter is also a validator.

Inherited from

InputBox.isValidator

---

onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBoxTsc.tsx:13

A callback that is called after the component is rendered.

Returns

void

Overrides

InputBox.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

InputBox.onBeforeRender

---

onDestroy()

onDestroy(): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:412

Returns

void

Inherit Doc

Inherited from

InputBox.onDestroy

---

onInputBlur()

protected onInputBlur(): Promise<void>

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBoxTsc.tsx:51

Method to handle on input blur

Returns

Promise<void>

Overrides

InputBox.onInputBlur

---

onInputFocus()

protected onInputFocus(e): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBoxTsc.tsx:57

Method to handle when input focus is set

Parameters

Parameter	Type	Description
e	FocusEvent	The focus event.

Returns

void

Overrides

InputBox.onInputFocus

---

onMouseDown()

onMouseDown(event): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:163

Handles mouse press for draggable inputs.

Parameters

Parameter	Type	Description
event	MouseEvent	The DOM event.

Returns

void

Inherited from

InputBox.onMouseDown

---

onMouseMove()

onMouseMove(event): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:174

Update the endPoint on mousemove

Parameters

Parameter	Type	Description
event	MouseEvent	MouseCoordinates

Returns

void

Inherited from

InputBox.onMouseMove

---

onMouseUp()

onMouseUp(): void

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:182

Remove the listeners and reset

Returns

void

Inherited from

InputBox.onMouseUp

---

render()

render(): VNode

Defined in: workingtitle-instruments-epic2/shared/Components/Inputs/InputBox.tsx:420

Renders the component.

Returns

VNode

A JSX element to be rendered.

Inherited from

InputBox.render