GridEditBase
Abstract

Base for features, which edit the grid.

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

autoEdit : Booleanfalse

Set to true to start editing when user starts typing text on a focused cell (as in Excel)

Has a corresponding runtime autoEdit property.
continueEditingOnCellClick : Booleantrue

By default, while editing, clicking on a grid cell outside the editor will commence editing for the clicked cell context.

Set to false to stop editing when clicking another cell while editing.
ignoreCSSSelector : Stringbutton,.b-icon,.fa,svg,input,.b-widget

A CSS selector for elements that when clicked, should not trigger editing. Useful if you render actionable icons or buttons into a grid cell.
triggerEvent : Stringcelldblclick
The name of the grid event that will trigger cell editing. Defaults to celldblclick but can be changed to any other event, such as cellclick.
```
features : {
    cellEdit : {
        triggerEvent : 'cellclick'
    }
}
```

Properties are getters/setters or publicly accessible variables on this class

activeRecord : Model

READONLY

Returns the record currently being edited, or null
autoEdit : Booleanfalse

Set to true to start editing when user starts typing text on a focused cell (as in Excel)

Has a corresponding autoEdit config.
isEditing : Boolean

READONLY

Is editing currently active?
isGridEditBase : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of GridEditBase class, or subclass thereof.

Functions are methods available for calling on the class

onCellClick( )
: Promise

private

ASYNC

Starts editing if user taps selected cell again on touch device. Chained function called when user clicks a cell.
onCellClickWhileEditing( )
: Promise

private

ASYNC

Event handler added when editing is active called when user clicks a cell in the grid during editing. It finishes editing and moves editor to the selected cell instead.
onStoreUpdate( )

private

Update the input field if underlying data changes during edit.
onTriggerEditEvent( )
: Promise

private

ASYNC

Called when the user triggers the edit action in triggerEvent config. Starts editing.

Grid/feature/base/GridEditBase.js