Class TextCellEditor

The default editor of Excel-style editing: a text field (input type="text"). Built with DOM APIs only (no inline handlers, no innerHTML) – it works under a strict Content Security Policy.

Example

ColumnDef.create({ property: "name", editable: TrueFn, editor: () => new TextCellEditor() });

Since

1.1.99

Hierarchy

TextCellEditor
- NumberCellEditor
- DateCellEditor

Implements

CellEditorIf

Index

Constructors

constructor

new TextCellEditor(): TextCellEditor
Returns TextCellEditor

Properties

`Protected` composing

composing: boolean = false

`Protected` `Optional` ctx

ctx?: CellEditorContextIf

`Protected` `Optional` input

input?: HTMLInputElement

Methods

close

close(): void
Removes listeners and elements.

Returns void
Implementation of CellEditorIf.close
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:111

`Protected` decorate

decorate(_input, _ctx): void
Extra attributes and classes (subclasses).
Parameters
- _input: HTMLInputElement
- _ctx: CellEditorContextIf
Returns void
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:45

focus

focus(): void
Gives the input element the keyboard focus.

Returns void
Implementation of CellEditorIf.focus
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:69

getFocusElement

getFocusElement(): undefined | HTMLElement
The element that has the focus (the table names it and lets the active cell own it for screen readers).

Returns undefined | HTMLElement
Implementation of CellEditorIf.getFocusElement
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:95

getText

getText(): string
The text of the editor, e.g. "=B2*C2" (formula input, later stages).

Returns string
Implementation of CellEditorIf.getText
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:58

getValue

getValue(): unknown
The value to write (it runs through editInputPipe and validate of the column).

Returns unknown
Implementation of CellEditorIf.getValue
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:54

`Protected` inputType

inputType(): string
The type attribute of the input.

Returns string
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:40

isComposing

isComposing(): boolean
true while an IME composition is running – the table ignores Enter, Tab and arrows then.

Returns boolean
Implementation of CellEditorIf.isComposing
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:103

open

open(container, ctx): void
Builds the editor into container (the table positions the container over the cell).
Parameters
- container: HTMLDivElement
- ctx: CellEditorContextIf
Returns void
Implementation of CellEditorIf.open
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:20

setMode

setMode(_mode): void
F2 switched the mode.
Parameters
- _mode: CellEditMode
Returns void
Implementation of CellEditorIf.setMode
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:99

setText

setText(text): void
Replaces the text and puts the caret at the end.
Parameters
- text: string
Returns void
Implementation of CellEditorIf.setText
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:62

`Protected` toText

toText(ctx): string
The start text from the cell value.
Parameters
- ctx: CellEditorContextIf
Returns string
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:50

wantsKey

wantsKey(_evt, _mode): boolean
true if the editor needs this key itself (e.g. ↑/↓ in a list) – the table does not commit then.
Parameters
- _evt: KeyboardEvent
- _mode: CellEditMode
Returns boolean
Implementation of CellEditorIf.wantsKey
- Defined in src/lib/table/sheet-editing/editors/text-cell-editor.ts:107

Class TextCellEditor

Example

Since

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TextCellEditor

Properties

Protected composing

Protected Optional ctx

Protected Optional input

Methods

close

Returns void

Protected decorate

Parameters

_input: HTMLInputElement

_ctx: CellEditorContextIf

Returns void

focus

Returns void

getFocusElement

Returns undefined | HTMLElement

getText

Returns string

getValue

Returns unknown

Protected inputType

Returns string

isComposing

Returns boolean

open

Parameters

container: HTMLDivElement

ctx: CellEditorContextIf

Returns void

setMode

Parameters

_mode: CellEditMode

Returns void

setText

Parameters

text: string

Returns void

Protected toText

Parameters

ctx: CellEditorContextIf

Returns string

wantsKey

Parameters

_evt: KeyboardEvent

_mode: CellEditMode

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` composing

`Protected` `Optional` ctx

`Protected` `Optional` input

`Protected` decorate

`Protected` inputType

`Protected` toText