/*
* Ext JS Library 1.1 RC 1
* Copyright(c) 2006-2007, Ext JS, LLC.
* licensing@extjs.com
*
* http://www.extjs.com/license
*/
/**
* @class Ext.data.Record
* Instances of this class encapsulate both record definition information, and record
* value information for use in {@link Ext.data.Store} objects, or any code which needs
* to access Records cached in an {@link Ext.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 Ext.data.Reader} implementations when processing unformatted data
* objects.
*
* Record objects generated by this constructor inherit all the methods of Ext.data.Record listed below.
* @constructor
* This constructor should not be used to create Record objects. Instead, use the constructor generated by
* {@link #create}. The parameters are the same.
* @param {Array} data An associative Array of data values keyed by the field name.
* @param {Object} id (Optional) The id of the record. This id should be unique, and is used by the
* {@link Ext.data.Store} object which owns the Record to index its collection of Records. If
* not specified an integer id is generated.
*/
Ext.data.Record = function(data, id){
this.id = (id || id === 0) ? id : ++Ext.data.Record.AUTO_ID;
this.data = data;
};
/**
* Generate a constructor for a specific record layout.
* @param {Array} o An Array of field definition objects which specify field names, and optionally,
* data types, and a mapping for an {@link Ext.data.Reader} to extract the field's value from a data object.
* Each field definition object may contain the following properties:
* name : StringThe 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 Ext.grid.ColumnModel}
* mapping : String(Optional) A path specification for use by the {@link Ext.data.Reader} implementation
* that is creating the Record to access the data value from the data object. If an {@link Ext.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 Ext.data.XmlReader} is being used, this is an {@link Ext.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 Ext.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:
* v : MixedThe data value as read by the Reader.
*
* dateFormat : String(Optional) A format String for the {@link Date#Date.parseDate} function.
*
* usage:
var TopicRecord = Ext.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);
* @method create
* @static
*/
Ext.data.Record.create = function(o){
var f = function(){
f.superclass.constructor.apply(this, arguments);
};
Ext.extend(f, Ext.data.Record);
var p = f.prototype;
p.fields = new Ext.util.MixedCollection(false, function(field){
return field.name;
});
for(var i = 0, len = o.length; i < len; i++){
p.fields.add(new Ext.data.Field(o[i]));
}
f.getField = function(name){
return p.fields.get(name);
};
return f;
};
Ext.data.Record.AUTO_ID = 1000;
Ext.data.Record.EDIT = 'edit';
Ext.data.Record.REJECT = 'reject';
Ext.data.Record.COMMIT = 'commit';
Ext.data.Record.prototype = {
/**
* Readonly flag - true if this record has been modified.
* @type Boolean
*/
dirty : false,
editing : false,
error: null,
modified: null,
// private
join : function(store){
this.store = store;
},
/**
* Set the named field to the specified value.
* @param {String} name The name of the field to set.
* @param {Object} value The value to set the field to.
*/
set : function(name, value){
if(this.data[name] == value){
return;
}
this.dirty = true;
if(!this.modified){
this.modified = {};
}
if(typeof this.modified[name] == 'undefined'){
this.modified[name] = this.data[name];
}
this.data[name] = value;
if(!this.editing){
this.store.afterEdit(this);
}
},
/**
* Get the value of the named field.
* @param {String} name The name of the field to get the value of.
* @return {Object} The value of the field.
*/
get : function(name){
return this.data[name];
},
// private
beginEdit : function(){
this.editing = true;
this.modified = {};
},
// private
cancelEdit : function(){
this.editing = false;
delete this.modified;
},
// private
endEdit : function(){
this.editing = false;
if(this.dirty && this.store){
this.store.afterEdit(this);
}
},
/**
* Usually called by the {@link Ext.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 Ext.data.Store#update} event to have their code notified
* of reject operations.
*/
reject : function(){
var m = this.modified;
for(var n in m){
if(typeof m[n] != "function"){
this.data[n] = m[n];
}
}
this.dirty = false;
delete this.modified;
this.editing = false;
if(this.store){
this.store.afterReject(this);
}
},
/**
* Usually called by the {@link Ext.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 Ext.data.Store#update} event to have their code notified
* of commit operations.
*/
commit : function(){
this.dirty = false;
delete this.modified;
this.editing = false;
if(this.store){
this.store.afterCommit(this);
}
},
// private
hasError : function(){
return this.error != null;
},
// private
clearError : function(){
this.error = null;
}
};
