Class Roo.data.Record
Instances of this class encapsulate both record
definition information, and record
value information for use in {
link Roo.data.Store} objects, or any code which needs
to access Records cached in an {
link Roo.data.Store} object.
Constructors for this class are generated by passing an Array of field definition objects to {link create}.
Instances are usually only created by {link Roo.data.Reader} implementations when processing unformatted data
objects.
Record objects generated by this constructor inherit all the methods of Roo.data.Record listed below.
Config Options - Has None
Public Properties - Has None
Public Methods
|
Create a new Roo.data.Record
Create a new Roo.data.Record
- Parameters:
-
Array data
- An associative Array of data values keyed by the field name.
-
Object id
- (Optional) The id of the record. This id should be unique, and is used by the
{link Roo.data.Store} object which owns the Record to index its collection of Records. If not specified an integer id is generated.
|
|
|
Roo.data.Record.create
( Array o)
Generate a constructor for a specific record layout.
Generate a constructor for a specific record layout.
- Parameters:
-
Array o
- An Array of field definition objects which specify field names, and optionally,
data types, and a mapping for an {link Roo.data.Reader} to extract the field's value from a data object. Each field definition object may contain the following properties:
- name : String
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 {link Roo.grid.ColumnModel}
- mapping : String
(Optional) A path specification for use by the {link Roo.data.Reader} implementation that is creating the Record to access the data value from the data object. If an {link Roo.data.JsonReader} is being used, then this is a string containing the javascript expression to reference the data relative to the record item's root. If an {link Roo.data.XmlReader} is being used, this is an {link Roo.DomQuery} path to the data item relative to the record element. If the mapping expression is the same as the field name, this may be omitted.
- type : String
(Optional) The data type for conversion to displayable value. Possible values are
- auto (Default, implies no conversion)
- string
- int
- float
- boolean
- date
- sortType : Mixed
(Optional) A member of {link Roo.data.SortTypes}.
- sortDir : String
(Optional) Initial direction to sort. "ASC" or "DESC"
- convert : Function
(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:
- dateFormat : String
(Optional) A format String for the Date.parseDate function.
usage:
var TopicRecord = Roo.data.Record.create( {name: 'title', mapping: 'topic_title'}, {name: 'author', mapping: 'username'}, {name: 'totalPosts', mapping: 'topic_replies', type: 'int'}, {name: 'lastPost', mapping: 'post_time', type: 'date'}, {name: 'lastPoster', mapping: 'user2'}, {name: 'excerpt', mapping: 'post_text'} );
var myNewRecord = new TopicRecord({ title: 'Do my job please', author: 'noobie', totalPosts: 1, lastPost: new Date(), lastPoster: 'Animal', excerpt: 'No way dude!' }); myStore.add(myNewRecord);
|
Roo.data.Record
|
|
commit
()
Usually called by the {link Roo.data.Store} which owns the Record.
Usually called by the { link Roo.data.Store} which owns the Record. Commits all changes made to the Record since either creation, or the last commit operation. Developers should subscribe to the {link Roo.data.Storeupdate} event to have their code notified of commit operations.
|
Roo.data.Record
|
|
Creates a copy of this record.
Creates a copy of this record.
- Parameters:
-
String id
- (optional) A new record id if you don't want to use this record's id
- Returns:
- Record
|
Roo.data.Record
|
|
Get the value of the named field.
Get the value of the named field.
- Parameters:
-
String name
- The name of the field to get the value of.
- Returns:
- Object The value of the field.
|
Roo.data.Record
|
|
reject
()
Usually called by the {link Roo.data.Store} which owns the Record.
Usually called by the { link Roo.data.Store} which owns the Record. Rejects all changes made to the Record since either creation, or the last commit operation. Modified fields are reverted to their original values. Developers should subscribe to the {link Roo.data.Storeupdate} event to have their code notified of reject operations.
|
Roo.data.Record
|
|
Set the named field to the specified value.
Set the named field to the specified value.
- Parameters:
-
String name
- The name of the field to set.
-
Object value
- The value to set the field to.
|
Roo.data.Record
|