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

beginEditing(newInitialValue, event)

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

Parameters:
Name Type Description
newInitialValue *
event *

cancelChanges()

Finishes editing without singout saving value.

close()

Required method to close editor.

discardEditor(result)

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

Parameters:
Name Type Description
result Boolean | undefined

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.

extend()

Fallback method to provide extendable editors in ES5.

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

getValue()

Required method to get current value from editable element.

init()

Initializes an editor's intance.

isInFullEditMode(){Boolean}

Checks if editor is in full edit mode.

Returns: {Boolean}

isOpened()

Returns information whether the editor is open.

isWaiting()

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

open()

Required method to open editor.

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

Prepares editor's meta data.

Parameters:
Name Type Description
row Number
col Number
prop Number | String
td HTMLTableCellElement
originalValue *
cellProperties Object

saveValue(value, ctrlDown)

Saves value from editor into data storage.

Parameters:
Name Type Description
value *
ctrlDown Boolean

If true, applies value to each cell in the last selected range.

setValue()

Required method to set new value into editable element.

Class: BaseEditor