Interface CellEditorIf

A cell editor of Excel-style editing: lives in one element above the cell (it survives scrolling) until it is committed or cancelled. Built-in: TextCellEditor, NumberCellEditor, SelectCellEditor, DateCellEditor. The table handles Enter, Tab, Escape and the arrow keys; an editor that needs a key itself (a list, a date field) says so in wantsKey.

Example

class UpperCaseEditor extends TextCellEditor {
  override getValue(): unknown {
    return String(super.getValue()).toUpperCase();
  }
}
ColumnDef.create({ property: "code", editable: TrueFn, editor: ctx => new UpperCaseEditor() });

Since

1.1.99

Hierarchy

CellEditorIf

Implemented by

Index

Methods

close focus getFocusElement getText? getValue isComposing? open setMode? setText? wantsKey?

Methods

close

close(): void
Removes listeners and elements.

Returns void
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:85

focus

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

Returns void
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:83

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
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:87

`Optional` getText

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

Returns string
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:95

getValue

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

Returns unknown
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:81

`Optional` isComposing

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

Returns boolean
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:91

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
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:79

`Optional` setMode

setMode(mode): void
F2 switched the mode.
Parameters
- mode: CellEditMode
Returns void
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:89

`Optional` setText

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

`Optional` 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
- Defined in src/lib/table/sheet-editing/cell-editor.if.ts:93

Interface CellEditorIf

Example

Since

Hierarchy

Implemented by

Index

Methods

Methods

close

Returns void

focus

Returns void

getFocusElement

Returns undefined | HTMLElement

Optional getText

Returns string

getValue

Returns unknown

Optional isComposing

Returns boolean

open

Parameters

container: HTMLDivElement

ctx: CellEditorContextIf

Returns void

Optional setMode

Parameters

mode: CellEditMode

Returns void

Optional setText

Parameters

text: string

Returns void

Optional wantsKey

Parameters

evt: KeyboardEvent

mode: CellEditMode

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Optional` getText

`Optional` isComposing

`Optional` setMode

`Optional` setText

`Optional` wantsKey