Files
Record.js

Instances of this class encapsulate both Record definition information, and Record\nvalue information for use in Ext.data.Store objects, or any code which needs\nto access Records cached in an Ext.data.Store object.

\n\n\n

Constructors for this class are generated by passing an Array of field definition objects to create.\nInstances are usually only created by Ext.data.Reader implementations when processing unformatted data\nobjects.

\n\n\n

Note that an instance of a Record class may only belong to one Store at a time.\nIn order to copy data from one Store to another, use the copy method to create an exact\ncopy of the Record, and insert the new instance into the other Store.

\n\n\n

When serializing a Record for submission to the server, be aware that it contains many private\nproperties, and also a reference to its owning Store which in turn holds references to its Records.\nThis means that a whole Record may not be encoded using Ext.util.JSON.encode. Instead, use the\ndata and id properties.

\n\n\n

Record objects generated by this constructor inherit all the methods of Ext.data.Record listed below.

\n\n

Defined By

Properties

Ext.data.Record
view source

data : Object

An object hash representing the data for this Record. ...

An object hash representing the data for this Record. Every field name in the Record definition\nis represented by a property of that name in this object. Note that unless you specified a field\nwith name \"id\" in the Record definition, this will not contain\nan id property.

Ext.data.Record
view source

dirty : Boolean

Readonly flag - true if this Record has been modified. ...

Readonly flag - true if this Record has been modified.

Defaults to: false

Ext.data.Record
view source

fields : Ext.util.MixedCollection

This property is stored in the Record definition's prototype\n\n\nA MixedCollection containing the defined Fields for th...

This property is stored in the Record definition's prototype

\n\n\n

A MixedCollection containing the defined Fields for this Record. Read-only.

Ext.data.Record
view source

id : Object

The unique ID of the Record as specified at construction time.

Ext.data.Record
view source

json : Array|Object

Only present if this Record was created by an ArrayReader or a JsonReader. ...

Only present if this Record was created by an ArrayReader or a JsonReader.

\n\n\n

The Array or object which was the source of the data for this Record.

\n\n

Ext.data.Record
view source

modified : Object

This object contains a key and value storing the original values of all modified\nfields or is null if no fields have ...

This object contains a key and value storing the original values of all modified\nfields or is null if no fields have been modified.

Ext.data.Record
view source

node : XMLElement

Only present if this Record was created by an XmlReader. ...

Only present if this Record was created by an XmlReader.

\n\n\n

The XML element which was the source of the data for this Record.

\n\n

Ext.data.Record
view source

phantom : Boolean

true when the record does not yet exist in a server-side database (see\nmarkDirty). ...

true when the record does not yet exist in a server-side database (see\nmarkDirty). Any record which has a real database pk set as its id property\nis NOT a phantom -- it's real.

Defaults to: false

Ext.data.Record
view source

store : Ext.data.Store

The Ext.data.Store to which this Record belongs.

Methods

Defined By

Instance Methods

Ext.data.Record
view source

newExt.data.Record( [data], [id] ) : Ext.data.Record

This constructor should not be used to create Record objects. ...

This constructor should not be used to create Record objects. Instead, use create to\ngenerate a subclass of Ext.data.Record configured with information about its constituent fields.

The generated constructor has the same signature as this constructor.

\n\n

Parameters

data : Object (optional)
An object, the properties of which provide values for the new Record's\nfields. If not specified the defaultValue\nfor each field will be assigned.
\n
id : Object (optional)
The id of the Record. The id is used by the\nExt.data.Store object which owns the Record to index its collection\nof Records (therefore this id should be unique within each store). If an\nid is not specified a phantom\nRecord will be created with an automatically generated id.
\n

Returns

Ext.data.Record
\n

Ext.data.Record
view source

beginEdit( )

Begin an edit. ...

Begin an edit. While in edit mode, no events (e.g.. the update event)\nare relayed to the containing store.\nSee also: endEdit and cancelEdit.

Ext.data.Record
view source

cancelEdit( )

Cancels all changes made in the current edit operation. ...

Cancels all changes made in the current edit operation.

Ext.data.Record
view source

commit( [silent] )

Usually called by the Ext.data.Store which owns the Record. ...

Usually called by the Ext.data.Store which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.

\n\n

Developers should subscribe to the Ext.data.Store.update event\nto have their code notified of commit operations.

\n\n

Parameters

silent : Boolean (optional)
True to skip notification of the owning\nstore of the change (defaults to false)
\n

Ext.data.Record
view source

copy( [id] ) : Record

Creates a copy (clone) of this Record. ...

Creates a copy (clone) of this Record.

Parameters

id : String (optional)
A new Record id, defaults to the id\nof the record being copied. See id.\nTo generate a phantom record with a new id use:
\n\n
```
var rec = record.copy(); // clone the record\nExt.data.Record.id(rec); // automatically generate a unique sequential id\n
```
\n\n

Returns

Record
\n

Ext.data.Record
view source

endEdit( )

End an edit. ...

End an edit. If any data was modified, the containing store is notified\n(ie, the store's update event will fire).

Ext.data.Record
view source

get( name ) : Object

Get the value of the named field. ...

Get the value of the named field.

Parameters

name : String
The name of the field to get the value of.
\n

Returns

Object
The value of the field.
\n

Ext.data.Record
view source

getChanges( ) : Object

Gets a hash of only the fields that have been modified since this Record was created or commited. ...

Gets a hash of only the fields that have been modified since this Record was created or commited.

Returns

Object
Object
\n

Ext.data.Record
view source

id( rec ) : String

Generates a sequential id. ...

Generates a sequential id. This method is typically called when a record is created\nand no id has been specified. The returned id takes the form:\n{PREFIX}-{AUTO_ID}.

PREFIX : String
Ext.data.Record.PREFIX\n(defaults to 'ext-record')
AUTO_ID : String
Ext.data.Record.AUTO_ID\n(defaults to 1 initially)

Parameters

rec : Record
The record being created. The record does not exist, it's a phantom.
\n

Returns

String
auto-generated string id, \"ext-record-i++';
\n

Ext.data.Record
view source

isModified( fieldName ) : Boolean

Returns true if the passed field name has been modified\nsince the load or last commit. ...

Returns true if the passed field name has been modified\nsince the load or last commit.

Parameters

fieldName : String
Ext.data.Field#name
\n

Returns

Boolean
\n

Ext.data.Record
view source

isValid( ) : Boolean

By default returns false if any field within the\nrecord configured with Ext.data.Field.allowBlank = false returns\ntru...

By default returns false if any field within the\nrecord configured with Ext.data.Field.allowBlank = false returns\ntrue from an Ext.isempty test.

Returns

Boolean
\n

Ext.data.Record
view source

markDirty( )

Marks this Record as dirty. ...

Marks this Record as dirty. This method\nis used interally when adding phantom records to a\nwriter enabled store.

\n\n\n

Marking a record dirty causes the phantom to\n\n\n

be returned by Ext.data.Store.getModifiedRecords where it will\nhave a create action composed for it during store save\noperations.

Ext.data.Record
view source

reject( [silent] )

Usually called by the Ext.data.Store which owns the Record. ...

Usually called by the Ext.data.Store which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.

\n\n

Developers should subscribe to the Ext.data.Store.update event\nto have their code notified of reject operations.

\n\n

Parameters

silent : Boolean (optional)
True to skip notification of the owning\nstore of the change (defaults to false)
\n

Ext.data.Record
view source

set( name, value )

Set the named field to the specified value. ...

Set the named field to the specified value. For example:

\n\n

// record has a field named 'firstname'\nvar Employee = Ext.data.Record.create([\n    {name: 'firstname'},\n    ...\n]);\n\n// update the 2nd record in the store:\nvar rec = myStore.getAt(1);\n\n// set the value (shows dirty flag):\nrec.set('firstname', 'Betty');\n\n// commit the change (removes dirty flag):\nrec.commit();\n\n// update the record in the store, bypass setting dirty flag,\n// and do not store the change in the modified records\nrec.data['firstname'] = 'Wilma'; // updates record, but not the view\nrec.commit(); // updates the view\n

\n\n\n

Notes:

If the store has a writer and autoSave=true, each set()\nwill execute an XHR to the server.
Use beginEdit to prevent the store's update\nevent firing while using set().
Use endEdit to have the store's update\nevent fire.

Parameters

name : String
The name of the field to set.
\n
value : String/Object/Array
The value to set the field to.
\n

Defined By

Static Methods

Ext.data.Record
view source

create( o ) : Functionstatic

Generate a constructor for a specific Record layout. ...

Generate a constructor for a specific Record layout.

Parameters

o : Array

An Array of Field definition objects.\nThe constructor generated by this method may be used to create new Record instances. The data\nobject must contain properties named after the field\nExt.data.Field.names. Example usage:

\n\n

// create a Record constructor from a description of the fields\nvar TopicRecord = Ext.data.Record.create([ // creates a subclass of Ext.data.Record\n    {name: 'title', mapping: 'topic_title'},\n    {name: 'author', mapping: 'username', allowBlank: false},\n    {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n    {name: 'lastPost', mapping: 'post_time', type: 'date'},\n    {name: 'lastPoster', mapping: 'user2'},\n    {name: 'excerpt', mapping: 'post_text', allowBlank: false},\n    // In the simplest case, if no properties other than name are required,\n    // a field definition may consist of just a String for the field name.\n    'signature'\n]);\n\n// create Record instance\nvar myNewRecord = new TopicRecord(\n    {\n        title: 'Do my job please',\n        author: 'noobie',\n        totalPosts: 1,\n        lastPost: new Date(),\n        lastPoster: 'Animal',\n        excerpt: 'No way dude!',\n        signature: ''\n    },\n    id // optionally specify the id of the record otherwise one is auto-assigned\n);\nmyStore.add(myNewRecord);\n

\n\n

Returns

Function
A constructor which is used to create new Records according\nto the definition. The constructor has the same signature as Record.
\n