Namespace: settings

Ancestry: Editor » .models. » settings

DataTables Editor v1.2.4 documentation

Navigation

Hiding private elements (toggle)
Showing extended elements (toggle)

Settings object for Editor - this provides the state for each instance of Editor and can be accessed through the instance's s property. Note that the settings object is considered to be "private" and thus is liable to change between versions. As such if you do read any of the setting parameters, please keep this in mind when upgrading!

Summary

Namespaces

events

Arrays that contain the callback functions which are registered with Editor. For full details see: Editor.defaults (note that the arrays do not have the 'on' prefix of the callback / events.

Properties - static

<static> action :string

The current form action - 'create', 'edit' or 'remove'. If no current action then it is set to null.

<static> ajax :function

Ajax submit function. This is directly set by the initialisation parameter / default of the same name.

<static> ajaxUrl :string

URL to submit Ajax data to. This is directly set by the initialisation parameter / default of the same name.

<static> dbTable :string

Name of the database table that is to be operated on - passed to the server in the Ajax request. This is directly set by the initialisation parameter / default of the same name.

<static> displayController :string

The display controller object for the Form. This is directly set by the initialisation parameter / default of the same name.

<static> displayed :string

Flag to indicate if the form is currently displayed (true) or not (false)

<static> domTable :string

URL to submit Ajax data to. This is directly set by the initialisation parameter / default of the same name.

<static> editRow :string

The TR element that is being edited (set to null for create and remove actions)

<static> fields :array

The form fields - see Editor.models.field for details of the objects held in this array.

<static> id :string

The ID of the row being edited (set to -1 on create and remove actions)

<static> idSrc :string

JSON property from which to read / write the row's ID property.

<static> opts :string

The initialisation object that was given by the user - stored for future reference. This is directly set by the initialisation parameter / default of the same name.

<static> order :array

Field order - order that the fields will appear in on the form. Array of strings, the names of the fields.

<static> processing :string

Flag to indicate if the form is current in a processing state (true) or not (false)

<static> removeRows :array

An array of TR elements that are scheduled to be removed on delete (set to null on create and edit actions).

Details

Properties - static

<static> action :string

The current form action - 'create', 'edit' or 'remove'. If no current action then it is set to null.

<static> ajax :function

Ajax submit function. This is directly set by the initialisation parameter / default of the same name.

<static> ajaxUrl :string

URL to submit Ajax data to. This is directly set by the initialisation parameter / default of the same name.

<static> dbTable :string

Name of the database table that is to be operated on - passed to the server in the Ajax request. This is directly set by the initialisation parameter / default of the same name.

<static> displayController :string

The display controller object for the Form. This is directly set by the initialisation parameter / default of the same name.

<static> displayed :string

Flag to indicate if the form is currently displayed (true) or not (false)

<static> domTable :string

URL to submit Ajax data to. This is directly set by the initialisation parameter / default of the same name.

<static> editRow :string

The TR element that is being edited (set to null for create and remove actions)

<static> fields :array

The form fields - see Editor.models.field for details of the objects held in this array.

<static> id :string

The ID of the row being edited (set to -1 on create and remove actions)

<static> idSrc :string

JSON property from which to read / write the row's ID property.

<static> opts :string

The initialisation object that was given by the user - stored for future reference. This is directly set by the initialisation parameter / default of the same name.

<static> order :array

Field order - order that the fields will appear in on the form. Array of strings, the names of the fields.

<static> processing :string

Flag to indicate if the form is current in a processing state (true) or not (false)

<static> removeRows :array

An array of TR elements that are scheduled to be removed on delete (set to null on create and edit actions).