| Package: | CQ.Ext.data |
| Class: | Field |
| Extends: | Object |
| Clientlib: | cq.widgets |
This class encapsulates the field definition information specified in the field definition objects passed to CQ.Ext.data.Record.create.
Developers do not need to instantiate this class. Instances are created by CQ.Ext.data.Record.create and cached in the fields property of the created Record constructor's prototype.
| Config Options | Defined By | |
|---|---|---|
|
allowBlank : Boolean (Optional) Used for validating a record, defaults to true. An empty value here will cause CQ.Ext.data.Record.isValid ...
(Optional) Used for validating a record, defaults to
true. An empty value here will cause CQ.Ext.data.Record.isValid to evaluate to false. |
Field | |
|
convert : Function (Optional) A function which converts the value provided by the Reader into an object that will be stored in the Recor...
(Optional) A function which converts the value provided by the Reader into an object that will be stored in the Record. It is passed the following parameters:
|
Field | |
|
dateFormat : String (Optional) Used when converting received data into a Date when the type is specified as "date". A format string for t...
(Optional) Used when converting received data into a Date when the type is specified as A format string for the Date.parseDate function, or "timestamp" if the value provided by the Reader is a UNIX timestamp, or "time" if the value provided by the Reader is a javascript millisecond timestamp. See Date |
Field | |
|
defaultValue : Mixed (Optional) The default value used when a Record is being created by a DataReader when the item referenced by the mapp...
(Optional) The default value used when a Record is being created by a DataReader when the item referenced by the
mapping does not exist in the data object (i.e. undefined). (defaults to "") |
Field | |
|
mapping : String/Number (Optional) A path expression for use by the CQ.Ext.data.DataReader implementation that is creating the Record to extr...
(Optional) A path expression for use by the CQ.Ext.data.DataReader implementation that is creating the Record to extract the Field value from the data object. If the path expression is the same as the field name, the mapping may be omitted. The form of the mapping expression depends on the Reader being used.
If a more complex value extraction strategy is required, then configure the Field with a convert function. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to return the desired data. |
Field | |
|
name : String The name by which the field is referenced within the Record. This is referenced by, for example, the dataIndex proper...
The name by which the field is referenced within the Record. This is referenced by, for example, the
dataIndex property in column definition objects passed to CQ.Ext.grid.ColumnModel. Note: In the simplest case, if no properties other than |
Field | |
|
sortDir : String (Optional) Initial direction to sort ("ASC" or "DESC"). Defaults to "ASC".
(Optional) Initial direction to sort (
"ASC" or "DESC"). Defaults to "ASC". |
Field | |
|
sortType : Function (Optional) A function which converts a Field's value to a comparable value in order to ensure correct sort ordering. ...
(Optional) A function which converts a Field's value to a comparable value in order to ensure correct sort ordering. Predefined functions are provided in CQ.Ext.data.SortTypes. A custom sort example:
|
Field | |
|
type : Mixed (Optional) The data type for automatic conversion from received data to the stored value if convert has not been spec...
(Optional) The data type for automatic conversion from received data to the stored value if
convert has not been specified. This may be specified as a string value. Possible values are
This may also be specified by referencing a member of the CQ.Ext.data.Types class. Developers may create their own application-specific data types by defining new members of the CQ.Ext.data.Types class. |
Field | |
|
useNull : Boolean (Optional) Use when converting received data into a Number type (either int or float). If the value cannot be parsed,...
(Optional) Use when converting received data into a Number type (either int or float). If the value cannot be parsed, null will be used if useNull is true, otherwise the value will be 0. Defaults to false |
Field | |