Class CellEditorController

An object which manages cell editing. It stores editor overrides, decides which editor to use for a cell, makes sure there is only one editor active.

Implements

ICellEditorController

Index

Constructors

Properties

_cell _editor _metadataBasedOverrides _typeBasedOverrides

Methods

_getDataTypeKey _getEditor _getMetadataBasedEditor _metadataIdentifierToKey _metadataMatchesIdentifier _objectToKey _onCancel _onCommit cancel edit setEditor

Constructors

constructor

new CellEditorController(): CellEditorController
Returns CellEditorController

Properties

`Private` _cell

_cell: null | CellEditor.CellConfig = null

`Private` _editor

_editor: null | ICellEditor = null

`Private` _metadataBasedOverrides

_metadataBasedOverrides: Map<string, [Metadata, ICellEditor | Resolver]> = ...

`Private` _typeBasedOverrides

_typeBasedOverrides: Map<string, ICellEditor | Resolver> = ...

Methods

`Private` _getDataTypeKey

_getDataTypeKey(cell): string
Parameters
- cell: CellEditor.CellConfig
Returns string
- Defined in datagrid/src/celleditorcontroller.ts:223

`Private` _getEditor

_getEditor(cell): undefined | ICellEditor
Choose the most appropriate cell editor to use based on overrides / cell data type.

If no match is found in overrides or based on cell data type, and if cell has a primitive data type then TextCellEditor is used as default cell editor. If 'default' cell editor is overridden, then it is used instead of TextCellEditor for default.
Parameters
- cell: CellEditor.CellConfig
Returns undefined | ICellEditor
- Defined in datagrid/src/celleditorcontroller.ts:320

`Private` _getMetadataBasedEditor

_getMetadataBasedEditor(cell): undefined | ICellEditor
Parameters
- cell: CellEditor.CellConfig
Returns undefined | ICellEditor
- Defined in datagrid/src/celleditorcontroller.ts:290

`Private` _metadataIdentifierToKey

_metadataIdentifierToKey(metadata): string
Parameters
- metadata: Metadata
Returns string
- Defined in datagrid/src/celleditorcontroller.ts:263

`Private` _metadataMatchesIdentifier

_metadataMatchesIdentifier(metadata, identifier): boolean
Parameters
- metadata: Metadata
- identifier: Metadata
Returns boolean
- Defined in datagrid/src/celleditorcontroller.ts:267

`Private` _objectToKey

_objectToKey(object): string
Parameters
- object: any
Returns string
- Defined in datagrid/src/celleditorcontroller.ts:249

`Private` _onCancel

_onCancel(): void
Returns void
- Defined in datagrid/src/celleditorcontroller.ts:215

`Private` _onCommit

_onCommit(response): void
Parameters
- response: ICellEditResponse
Returns void
- Defined in datagrid/src/celleditorcontroller.ts:189

cancel

cancel(): void
Cancel editing.

Returns void
Implementation of ICellEditorController.cancel
- Defined in datagrid/src/celleditorcontroller.ts:180

edit

edit(cell, options?): boolean
Start editing a cell.
Parameters
- cell: CellEditor.CellConfig
  The object holding cell configuration data.
- Optional options: ICellEditOptions
  The cell editing options.
Returns boolean
Implementation of ICellEditorController.edit
- Defined in datagrid/src/celleditorcontroller.ts:143

setEditor

setEditor(identifier, editor): void
Override cell editor for the cells matching the identifier.
Parameters
- identifier: EditorOverrideIdentifier
  Cell identifier to use when matching cells. if identifier is a CellDataType, then cell matching is done using data type of the cell, if identifier is a Metadata, then partial match of the cell metadata with identifier is used for match, if identifier is 'default' then override is used as default editor when no other editor is found suitable
- editor: ICellEditor | Resolver
  The cell editor to use or resolver to use to get an editor for matching cells.
Returns void
Implementation of ICellEditorController.setEditor
- Defined in datagrid/src/celleditorcontroller.ts:124