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() method. 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.

Library Name Summary
Editor

close

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

Editor

create

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

Editor

displayOrder

Field elements have been inserted into the DOM

Editor

edit

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

Editor

initCreate

Form initialised for the create action event

Editor

initEdit

Form initialised for the edit action event

Editor

initRemove

Form initialised for the remove action event

Editor

initSubmit

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

Editor

open

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

Editor

postCreate

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

Editor

postEdit

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

Editor

postRemove

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

Editor

postSubmit

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

Editor

preBlur

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

Editor

preBlurCancelled

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

Editor

preClose

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

Editor

preCloseCancelled

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

Editor

preCreate

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

Editor

preEdit

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

Editor

preOpen

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

Editor

preOpenCancelled

Form open action was cancelled by the preOpen event

Editor

preRemove

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

Editor

preSubmit

Pre-submit of data to server event (cancellable)

Editor

preSubmitCancelled

Pre-submit event cancelled submission

Editor

preUpload

Triggered prior to each file being uploaded (cancellable)

Editor

preUploadCancelled

Event to indicate if a file upload was cancelled

Editor

processing

Form processing event

Editor

remove

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

Editor

setData

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

Editor

submitComplete

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

Editor

submitError

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

Editor

submitSuccess

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

Editor

submitUnsuccessful

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

Editor

uploadXhrError

File upload received an error response from the server

Editor

uploadXhrSuccess

File upload has been completed

Deprecated

cancelOpen

Form open action was cancelled by the preOpen event

Deprecated

initComplete

Editor initialisation complete event