| Classes (0) | Namespaces (0) |
| Properties (0) | Static properties (24) |
| Methods (0) | Static methods (0) |
| Events (0) |
| Properties (0) | Static properties (24) |
| Methods (0) | Static methods (0) |
| Events (0) |
Events / callbacks - event handlers can be assigned as an individual function during initialisation using the parameters in this name space. The names, and the parameters passed to each callback match their event equivalent in the Editor object.
Form hidden event, fired when the form is removed from the document. The of the inverse onOpen event.
Create new row event, fired when a new row has been created in the DataTable by a form submission. This is called just after the fnAddData call to the DataTable.
Edit row event, fired when a row has been edited in the DataTable by a form submission. This is called just after the fnUpdate call to the DataTable.
Initialisation of the Editor instance has been completed.
Create method activated event, fired when the create API method has been called, just prior to the form being shown. Useful for manipulating the form specifically for the create state.
Edit method activated event, fired when the edit API method has been called, just prior to the form being shown. Useful for manipulating the form specifically for the edit state.
Remove method activated event, fired when the remove API method has been called, just prior to the form being shown. Useful for manipulating the form specifically for the remove state.
Form displayed event, fired when the form is made available in the DOM. This can be useful for fields that require height and width calculations to be performed since the element is not available in the document until the form is displayed.
As per the onCreate event - included for naming consistency.
As per the onEdit event - included for naming consistency.
As per the onRemove event - included for naming consistency.
Post-submit event for the form, fired immediately after the data has been loaded by the Ajax call, allowing modification or any other interception of the data returned form the server.
Before a form is closed, this event is fired. It allows the close action to be cancelled by returning false from the function. This can be useful for confirming that the user actually wants to close the display (if they have unsaved changes for example).
Pre-create new row event, fired just before DataTables calls the fnAddData method to add new data to the DataTable, allowing modification of the data that will be used to insert into the table.
Pre-edit row event, fired just before DataTables calls the fnUpdate method to edit data in a DataTables row, allowing modification of the data that will be used to update the table.
Before a form is displayed, this event is fired. It allows the open action to be cancelled by returning false from the function.
Pre-remove row event, fired just before DataTables calls the fnDeleteRow method to delete a DataTables row.
Pre-submit event for the form, fired just before the data is submitted to the server. This event allows you to modify the data that will be submitted to the server. Note that this event runs after the 'formatdata' callback function of the Editor#submit API method.
Processing event, fired when Editor submits data to the server for processing. This can be used to provide your own processing indicator if your UI framework already has one.
Row removed event, fired when a row has been removed in the DataTable by a form submission. This is called just after the fnDeleteRow call to the DataTable.
Set data event, fired when the data is gathered from the form to be used to update the DataTable. This is a "global" version of onPreCreate, onPreEdit and onPreRemove and can be used to manipulate the data that will be added to the DataTable for all three actions
Submission complete event, fired when data has been submitted to the server and after any of the return handling code has been run (updating the DataTable for example). Note that unlike onSubmitSuccess and onSubmitError, onSubmitComplete will be fired for both a successful submission and an error. Additionally this event will be fired after onSubmitSuccess or onSubmitError.
Submission complete, but in error event, fired when data has been submitted to the server but an error occurred on the server (typically a JSON formatting error)
Submission complete and successful event, fired when data has been successfully submitted to the server and all actions required by the returned data (inserting or updating a row) have been completed.
Form hidden event, fired when the form is removed from the document. The of the inverse onOpen event.
Create new row event, fired when a new row has been created in the DataTable by a form submission. This is called just after the fnAddData call to the DataTable.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that was used to update the DataTable |
Edit row event, fired when a row has been edited in the DataTable by a form submission. This is called just after the fnUpdate call to the DataTable.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that was used to update the DataTable |
Initialisation of the Editor instance has been completed.
Create method activated event, fired when the create API method has been called, just prior to the form being shown. Useful for manipulating the form specifically for the create state.
Edit method activated event, fired when the edit API method has been called, just prior to the form being shown. Useful for manipulating the form specifically for the edit state.
Remove method activated event, fired when the remove API method has been called, just prior to the form being shown. Useful for manipulating the form specifically for the remove state.
Form displayed event, fired when the form is made available in the DOM. This can be useful for fields that require height and width calculations to be performed since the element is not available in the document until the form is displayed.
As per the onCreate event - included for naming consistency.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that was used to update the DataTable |
As per the onEdit event - included for naming consistency.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that was used to update the DataTable |
As per the onRemove event - included for naming consistency.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server |
Post-submit event for the form, fired immediately after the data has been loaded by the Ajax call, allowing modification or any other interception of the data returned form the server.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data object that was be submitted to the server |
Before a form is closed, this event is fired. It allows the close action to be cancelled by returning false from the function. This can be useful for confirming that the user actually wants to close the display (if they have unsaved changes for example).
Pre-create new row event, fired just before DataTables calls the fnAddData method to add new data to the DataTable, allowing modification of the data that will be used to insert into the table.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that will be used to update the DataTable |
Pre-edit row event, fired just before DataTables calls the fnUpdate method to edit data in a DataTables row, allowing modification of the data that will be used to update the table.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that will be used to update the DataTable |
Before a form is displayed, this event is fired. It allows the open action to be cancelled by returning false from the function.
Pre-remove row event, fired just before DataTables calls the fnDeleteRow method to delete a DataTables row.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server |
Pre-submit event for the form, fired just before the data is submitted to the server. This event allows you to modify the data that will be submitted to the server. Note that this event runs after the 'formatdata' callback function of the Editor#submit API method.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | data | object | The data object that will be submitted to the server |
Processing event, fired when Editor submits data to the server for processing. This can be used to provide your own processing indicator if your UI framework already has one.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | processing | boolean | Flag for if the processing is running (true) or not (false). |
Row removed event, fired when a row has been removed in the DataTable by a form submission. This is called just after the fnDeleteRow call to the DataTable.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server |
Set data event, fired when the data is gathered from the form to be used to update the DataTable. This is a "global" version of onPreCreate, onPreEdit and onPreRemove and can be used to manipulate the data that will be added to the DataTable for all three actions
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that will be used to update the DataTable | ||
3 | action | string | The action being performed by the form - 'create', 'edit' or 'remove'. |
Submission complete event, fired when data has been submitted to the server and after any of the return handling code has been run (updating the DataTable for example). Note that unlike onSubmitSuccess and onSubmitError, onSubmitComplete will be fired for both a successful submission and an error. Additionally this event will be fired after onSubmitSuccess or onSubmitError.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that was used to update the DataTable |
Submission complete, but in error event, fired when data has been submitted to the server but an error occurred on the server (typically a JSON formatting error)
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | xhr | object | The Ajax object | ||
2 | err | string | The error message from jQuery | ||
3 | thrown | object | The exception thrown by jQuery | ||
4 | data | object | The data that was used to update the DataTable |
Submission complete and successful event, fired when data has been successfully submitted to the server and all actions required by the returned data (inserting or updating a row) have been completed.
| Name | Type | Attributes | Default | Description | |
|---|---|---|---|---|---|
1 | json | object | The JSON object returned from the server | ||
2 | data | object | The data that was used to update the DataTable |