@serenity-is/sleekgrid / Editor
Interface: Editor
Defined in: src/core/editing.ts:148
Contract that all cell editors must implement.
Properties
keyCaptureList?
optionalkeyCaptureList:number[]
Defined in: src/core/editing.ts:166
Key codes the editor captures even when the grid also handles them.
Methods
applyValue()
applyValue(
item,value):void
Defined in: src/core/editing.ts:156
Writes the edited value back to the data item.
Parameters
item
any
Row item to mutate.
value
any
Serialized value from Editor.serializeValue.
Returns
void
destroy()
destroy():
void
Defined in: src/core/editing.ts:150
Tears down DOM and listeners created by the editor.
Returns
void
focus()
focus():
void
Defined in: src/core/editing.ts:158
Focuses the editor's input element.
Returns
void
hide()?
optionalhide():void
Defined in: src/core/editing.ts:182
Hides the editor without destroying it.
Returns
void
isValueChanged()
isValueChanged(
args):boolean
Defined in: src/core/editing.ts:164
Checks whether the current editor value differs from the original.
Parameters
args
Flags influencing the check (e.g. whether a commit is in progress).
commitEdit?
boolean
Returns
boolean
true if the value has changed.
loadValue()
loadValue(
value):void
Defined in: src/core/editing.ts:171
Loads an existing cell value into the editor.
Parameters
value
any
The value to load.
Returns
void
position()?
optionalposition(pos):void
Defined in: src/core/editing.ts:178
Repositions the editor overlay.
Parameters
pos
New pixel bounds.
Returns
void
preClick()?
optionalpreClick():void
Defined in: src/core/editing.ts:180
Hook invoked when the cell received a pre-click; editors may skip selection.
Returns
void
serializeValue()
serializeValue():
any
Defined in: src/core/editing.ts:173
Serializes the current editor value for commit.
Returns
any
show()?
optionalshow():void
Defined in: src/core/editing.ts:184
Shows a previously hidden editor.
Returns
void
validate()?
optionalvalidate():ValidationResult
Defined in: src/core/editing.ts:186
Validates the current value.
Returns
Validation result.