Events

Editor will emit custom DOM events when it performs particular operations, providing the ability to listen for these events and take action on them when they occur, for example starting or completing an edit for a particular row.

The events Editor emits can all be listened for using the on() and one() methods, and removed with off(). The example below shows how the create event can be listened for:

editor.on('create', function (e, json, data) {
    alert('New row added');
});

For further general information about Editor's custom events, please refer to the events manual.

Name Summary Library Group

cancelOpen

Form open action was cancelled by the preOpen event

Deprecated

close

Form hide event, fired when the form is removed from the display

closed

Form close is complete

create

Row creation event - triggered immediately after the row has been added

destroyEditor

Editor instance destroyed

displayOrder

Field elements have been inserted into the DOM

edit

Row edit event - triggered immediately after the row / page has been updated

initComplete

Editor initialisation complete event

Deprecated

initCreate

Form initialised for the create action event

initEdit

Form initialised for the edit action event

initEditor

Editor instance created

initRemove

Form initialised for the remove action event

initSubmit

Start of the submit process, allowing changes to be made to the form.

open

Form open (display) event - triggered when the form is displayed for user input

opened

Form open is complete

postCreate

Post-row creation event - triggered after the row is added to the DataTable

postEdit

Post-row edit event - triggered after the row / page has been updated

postRemove

Post-row removal event - triggered after the rows have been removed

postSubmit

Submit complete event (before the returned data is processed by Editor)

postUpload

Event to indicate that a file upload is complete and has been processed

preBlur

Form blur event - triggered when the form loses focus (cancellable)

preBlurCancelled

Form blur event - triggered when the form loses focus (cancellable)

preClose

Form close event - Triggered before the form is closed (cancellable)

preCloseCancelled

Form close event - Triggered before the form is closed (cancellable)

preCreate

Pre-row creation event - triggered before the row is added to the DataTable

preEdit

Pre-row update event - triggered before the row / page data is updated

preOpen

Form open (displayed) event - Triggered before the form is displayed (cancellable)

preOpenCancelled

Form open action was cancelled by the preOpen event

preRemove

Pre-row remove event - triggered before the selected rows are removed

preSubmit

Pre-submit of data to server event (cancellable)

preSubmitCancelled

Pre-submit event cancelled submission

preUpload

Triggered prior to each file being uploaded (cancellable)

preUploadCancelled

Event to indicate if a file upload was cancelled

processing

Form processing event

remove

Row removal event - triggered immediately after the rows have been removed

setData

Set data event - triggered before the page is updated (deprecated)

submitComplete

Form submitted to the server, and data processed event (success and failure)

submitError

Form submitted to the server, and data processed event (error only)

submitSuccess

Form submitted to the server, and data processed event (success only)

submitUnsuccessful

Form submitted to the server, but failed server-side validation

uploadXhrError

File upload received an error response from the server

uploadXhrSuccess

File upload has been completed