Classes

BaseEditor

Members

_closeCallbackfunction

Callback to call after closing editor.

cellPropertiesobject

Object containing the cell's properties.

colnumber

Visual column index.

hotHandsontable

A reference to the source instance of the Handsontable.

instanceHandsontable

A reference to the source instance of the Handsontable.

Deprecated

Yes

originalValue*

Original cell's value.

propnumber string

Column property name or a column index, if datasource is an array of arrays.

rownumber

Visual row index.

statestring

Editor's state.

TDHTMLTableCellElement

Currently rendered cell's TD element.

Methods

Source code

beginEditing(newInitialValue, event)

Begins editing on a highlighted cell and hides fillHandle corner if was present.

Parameters:

Name	Type	Description
newInitialValue	*	The initial editor value.
event	Event	The keyboard event object.

Source code

cancelChanges()

Finishes editing without singout saving value.

Source code

close()

Required method to close editor.

Source code

discardEditor(result)

Verifies result of validation or closes editor if user's cancelled changes.

Parameters:

Name	Type	Description
result	boolean | undefined	If false and the cell using allowInvalid option, then an editor won't be closed until validation is passed.

Source code

enableFullEditMode()

Switch editor into full edit mode. In this state navigation keys don't close editor. This mode is activated
automatically after hit ENTER or F2 key on the cell or while editing cell press F2 key.

Source code

extend(){function}

Fallback method to provide extendable editors in ES5.

Returns: {function}

Source code

finishEditing(restoreOriginalValue, ctrlDown, callback)

Finishes editing and start saving or restoring process for editing cell or last selected range.

Parameters:

Name	Type	Description
restoreOriginalValue	boolean	If true, then closes editor without saving value from the editor into a cell.
ctrlDown	boolean	If true, then saveValue will save editor's value to each cell in the last selected range.
callback	function	The callback function, fired after editor closing.

Source code

getEditedCell(){HTMLTableCellElement|null}

Gets HTMLTableCellElement of the edited cell if exist.

Returns: {HTMLTableCellElement|null}

Source code

getEditedCellsLayerClass(){string}

Gets className of the edited cell if exist.

Returns: {string}

Source code

getValue()

Required method to get current value from editable element.

Source code

init()

Initializes an editor's intance.

Source code

isInFullEditMode(){boolean}

Checks if editor is in full edit mode.

Returns: {boolean}

Source code

isOpened(){boolean}

Returns information whether the editor is open.

Returns: {boolean}

Source code

isWaiting(){boolean}

Returns information whether the editor is waiting, eg.: for async validation.

Returns: {boolean}

Source code

open()

Required method to open editor.

Source code

prepare(row, col, prop, td, value, cellProperties)

Prepares editor's meta data.

Parameters:

Name	Type	Description
row	number	The visual row index.
col	number	The visual column index.
prop	number | string	The column property (passed when datasource is an array of objects).
td	HTMLTableCellElement	The rendered cell element.
value	*	The rendered value.
cellProperties	object	The cell meta object ({@see Core#getCellMeta}).

Source code

saveValue(value, ctrlDown)

Saves value from editor into data storage.

Parameters:

Name	Type	Description
value	*	The editor value.
ctrlDown	boolean	If true, applies value to each cell in the last selected range.

Source code

setValue()

Required method to set new value into editable element.