For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

Sencha Documentation

Hierarchy

Ext.data.Model
Ext.grid.property.Property

Mixins

A specific Ext.data.Model type that represents a name/value pair and is made to work with the Ext.grid.property.Grid. Typically, Properties do not need to be created directly as they can be created implicitly by simply using the appropriate data configs either via the Ext.grid.property.Grid.source config property or by calling Ext.grid.property.Grid.setSource. However, if the need arises, these records can also be created explicitly as shown below. Example usage:

var rec = new Ext.grid.property.Property({
    name: 'birthday',
    value: Ext.Date.parse('17/06/1962', 'd/m/Y')
});
// Add record to an already populated grid
grid.store.addSorted(rec);
Defined By

Config Options

Other Configs

 

The name of the field treated as this Model's unique id (defaults to 'id').

The name of the field treated as this Model's unique id (defaults to 'id').

 
(optional) A config object containing one or more event handlers to be added to this object during initialization. T...

(optional)

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.


DOM events from ExtJs Components


While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this

is usually only done when extra value can be added. For example the DataView's click event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

 
The property on this Persistable object that its data is saved to. Defaults to 'data' (e.g. all persistable data resi...

The property on this Persistable object that its data is saved to. Defaults to 'data' (e.g. all persistable data resides in this.data.)

Defined By

Properties

 

The string type of the default Model Proxy. Defaults to 'ajax'

The string type of the default Model Proxy. Defaults to 'ajax'

 

Readonly flag - true if this Record has been modified.

Readonly flag - true if this Record has been modified.

 

Internal flag used to track whether or not the model instance is currently being edited. Read-only

Internal flag used to track whether or not the model instance is currently being edited. Read-only

 

An array of the fields defined on this model

An array of the fields defined on this model

 

Key: value pairs of all fields whose values have changed

Key: value pairs of all fields whose values have changed

 
true when the record does not yet exist in a server-side database (see setDirty). Any record which has a real databa...

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

 

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

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

Defined By

Methods

 

 

Parameters

  • config : Object

    A data object in the format:

    {
        name: [name],
        value: [value]
    }

    The specified value's type will be read automatically by the grid to determine the type of editor to use when displaying it.

Returns

  • void   
 
addEvents( Object/String o, String ) : void

Adds the specified events to the list of events which this Observable may fire.

Adds the specified events to the list of events which this Observable may fire.

Parameters

  • o : Object/String

    Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

  • : String

    [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

    this.addEvents('storeloaded', 'storecleared');
    

Returns

  • void   
 
addListener( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object.

Appends an event handler to this object.

Parameters

  • eventName : String

    The name of the event to listen for. May also be an object who's property names are event names. See

  • handler : Function

    The method the event invokes.

  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options : Object

    (optional) An object containing handler configuration. properties. This may contain any of the following properties:

    • scope : Object
      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
    • element : String
      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

      This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

      new Ext.panel.Panel({
          title: 'The title',
          listeners: {
              click: this.handlePanelClick,
              element: 'body'
          }
      });
      

      When added in this way, the options available are the options applicable to Ext.core.Element.addListener


    Combining Options
    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
    });

    Attaching multiple handlers in 1 call
    The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

    myGridPanel.on({
        cellClick: this.onCellClick,
        mouseover: this.onMouseOver,
        mouseout: this.onMouseOut,
        scope: this // Important. Ensure "this" is correct during handler execution
    });
    
    .

Returns

  • void   
 
addManagedListener( Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) : void

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Parameters

  • item : Observable/Element

    The item to which to add a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function

    Optional. If the ename parameter was an event name, this is the handler function.

  • scope : Object

    Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

  • opt : Object

    Optional. If the ename parameter was an event name, this is the addListener options.

Returns

  • void   
 
Begin an edit. While in edit mode, no events (e.g.. the update event) are relayed to the containing store. When an ed...

Begin an edit. While in edit mode, no events (e.g.. the update event) are relayed to the containing store. When an edit has begun, it must be followed by either endEdit or cancelEdit.

Returns

  • void   
 

Cancels all changes made in the current edit operation.

Cancels all changes made in the current edit operation.

Returns

  • void   
 
capture( Observable o, Function fn, [Object scope]) : void
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

  • o : Observable

    The Observable to capture events from.

  • fn : Function

    The function to call when an event is fired.

  • scope : Object

    (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

  • void   
 

Removes all listeners for this object including the managed listeners

Removes all listeners for this object including the managed listeners

Returns

  • void   
 

Removes all managed listeners for this object.

Removes all managed listeners for this object.

Returns

  • void   
 
commit( [Boolean silent]) : void
Usually called by the Ext.data.Store which owns the model instance. Commits all changes made to the instance since ei...

Usually called by the Ext.data.Store which owns the model instance. Commits all changes made to the instance since either creation or the last commit operation.

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

Parameters

  • silent : Boolean

    (optional) True to skip notification of the owning store of the change (defaults to false)

Returns

  • void   
 
copy( [String id]) : Record

Creates a copy (clone) of this Model instance.

Creates a copy (clone) of this Model instance.

Parameters

  • id : String

    (optional) A new id, defaults to the id of the instance being copied. See id. To generate a phantom instance with a new id use:

    var rec = record.copy(); // clone the record
    Ext.data.Model.id(rec); // automatically generate a unique sequential id
    

Returns

  • Record   
 
destroy( Object options) : Ext.data.Model

Destroys the model using the configured proxy

Destroys the model using the configured proxy

Parameters

  • options : Object

    Options to pass to the proxy

Returns

  • Ext.data.Model   

    The Model instance

 
enableBubble( String/Array events) : void
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present....

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.override(Ext.form.field.Base, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
    this.enableBubble('change');
}),

//  We know that we want Field's events to bubble directly to the FormPanel.
getBubbleTarget : function() {
    if (!this.formPanel) {
        this.formPanel = this.findParentByType('form');
    }
    return this.formPanel;
}
});

var myForm = new Ext.formPanel({
title: 'User Details',
items: [{
    ...
}],
listeners: {
    change: function() {
        // Title goes red if form has been modified.
        myForm.header.setStyle('color', 'red');
    }
}
});

Parameters

  • events : String/Array

    The event name to bubble, or an Array of event names.

Returns

  • void   
 
endEdit( Boolean silent) : void

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

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

Parameters

  • silent : Boolean

    True to not notify the store of the change

Returns

  • void   
 
fireEvent( String eventName, Object... args) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

Parameters

  • eventName : String

    The name of the event to fire.

  • args : Object...

    Variable number of parameters are passed to handlers.

Returns

  • Boolean   

    returns false if any of the handlers return false otherwise it returns true.

 
get( String fieldName) : Mixed

Returns the value of the given field

Returns the value of the given field

Parameters

  • fieldName : String

    The field to fetch the value for

Returns

  • Mixed   

    The value

 
Gets all of the data from this Models loaded associations. It does this recursively - for example if we have a User w...

Gets all of the data from this Models loaded associations. It does this recursively - for example if we have a User which hasMany Orders, and each Order hasMany OrderItems, it will return an object like this: {

orders: [
    {
        id: 123,
        status: 'shipped',
        orderItems: [
            ...
        ]
    }
]

}

Returns

  • Object   

    The nested data set for the Model's loaded associations

 

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

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

Returns

  • void   

    Object

 

Returns the unique ID allocated to this model instance as defined by idProperty

Returns the unique ID allocated to this model instance as defined by idProperty

Returns

  • Number   

    The id

 
getProxy : Ext.data.proxy.Proxy

Returns the configured Proxy for this Model

Returns the configured Proxy for this Model

Returns

  • Ext.data.proxy.Proxy   

    The proxy

 
hasListener( String eventName) : Boolean

Checks to see if this object has any listeners for a specified event

Checks to see if this object has any listeners for a specified event

Parameters

  • eventName : String

    The name of the event to check for

Returns

  • Boolean   

    True if the event is being listened for, else false

 
id( Ext.data.Model rec) : String
Generates a sequential id. This method is typically called when a record is created and no id has been specified. The...

Generates a sequential id. This method is typically called when a record is created and no id has been specified. The id will automatically be assigned to the record. The returned id takes the form: {PREFIX}-{AUTO_ID}.

  • PREFIX : String

    Ext.data.Model.PREFIX (defaults to 'ext-record')

  • AUTO_ID : String

    Ext.data.Model.AUTO_ID (defaults to 1 initially)

Parameters

  • rec : Ext.data.Model

    The record being created. The record does not exist, it's a phantom.

Returns

  • String   

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

 
isModified( String fieldName) : Boolean

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

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

Parameters

Returns

  • Boolean   
 

Checks if the model is valid. See validate.

Checks if the model is valid. See validate.

Returns

  • Boolean   

    True if the model is valid.

 
join( Ext.data.Store store) : void

Tells this model instance that it has been added to a store

Tells this model instance that it has been added to a store

Parameters

  • store : Ext.data.Store

    The store that the model has been added to

Returns

  • void   
 
load( Number id, Object config) : void
Static. Asynchronously loads a model instance by id. Sample usage: MyApp.User = Ext.define('User', { ext...

Static. Asynchronously loads a model instance by id. Sample usage:

    MyApp.User = Ext.define('User', {
        extend: 'Ext.data.Model',
        fields: [
            {name: 'id', type: 'int'},
            {name: 'name', type: 'string'}
        ]
    });

    MyApp.User.load(10, {
        scope: this,
        failure: function(record, operation) {
            //do something if the load failed
        },
        success: function(record, operation) {
            //do something if the load succeeded
        },
        callback: function(record, operation) {
            //do something whether the load succeeded or failed
        }
    });
    

Parameters

  • id : Number

    The id of the model to load

  • config : Object

    Optional config object containing success, failure and callback functions, plus optional scope

Returns

  • void   
 
observe( Function c, Object listeners) : void
Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
Ext.data.Connection.on('beforerequest', function(con, options) {
    console.log('Ajax request made to ' + options.url);
});

Parameters

  • c : Function

    The class constructor to make observable.

  • listeners : Object

    An object containing a series of listeners to add. See addListener.

Returns

  • void   
 
on( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object (shorthand for addListener.)

Appends an event handler to this object (shorthand for addListener.)

Parameters

  • eventName : String

    The type of event to listen for

  • handler : Function

    The method the event invokes

  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options : Object

    (optional) An object containing handler configuration.

Returns

  • void   
 
reject( [Boolean silent]) : void
Usually called by the Ext.data.Store to which this model instance has been joined. Rejects all changes made to the mo...

Usually called by the Ext.data.Store to which this model instance has been joined. Rejects all changes made to the model instance since either creation, or the last commit operation. Modified fields are reverted to their original values.

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

Parameters

  • silent : Boolean

    (optional) True to skip notification of the owning store of the change (defaults to false)

Returns

  • void   
 
relayEvents( Object origin, Array events, Object prefix) : void

Relays selected events from the specified Observable as if the events were fired by this.

Relays selected events from the specified Observable as if the events were fired by this.

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

  • events : Array

    Array of event names to relay.

  • prefix : Object

Returns

  • void   
 

Removes all added captures from the Observable.

Removes all added captures from the Observable.

Parameters

  • o : Observable

    The Observable to release

Returns

  • void   
 
removeListener( String eventName, Function handler, [Object scope]) : void

Removes an event handler.

Removes an event handler.

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope : Object

    (optional) The scope originally specified for the handler.

Returns

  • void   
 
removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope) : void

Removes listeners that were added by the mon method.

Removes listeners that were added by the mon method.

Parameters

  • item : Observable|Element

    The item from which to remove a listener/listeners.

  • ename : Object|String

    The event name, or an object containing event name properties.

  • fn : Function

    Optional. If the ename parameter was an event name, this is the handler function.

  • scope : Object

    Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Returns

  • void   
 
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Returns

  • void   
 
save( Object options) : Ext.data.Model

Saves the model instance using the configured proxy

Saves the model instance using the configured proxy

Parameters

  • options : Object

    Options to pass to the proxy

Returns

  • Ext.data.Model   

    The Model instance

 
set( String|Object fieldName, Mixed value) : void

Sets the given field to the given value, marks the instance as dirty

Sets the given field to the given value, marks the instance as dirty

Parameters

  • fieldName : String|Object

    The field to set, or an object containing key/value pairs

  • value : Mixed

    The value to set

Returns

  • void   
 
Marks this Record as dirty. This method is used interally when adding phantom records to a writer enabled store. M...

Marks this Record as dirty. This method is used interally when adding phantom records to a writer enabled store.


Marking a record dirty causes the phantom to

be returned by Ext.data.Store.getModifiedRecords where it will have a create action composed for it during store save operations.

Returns

  • void   
 

Sets the model instance's id field to the given id

Sets the model instance's id field to the given id

Parameters

  • id : Number

    The new id

Returns

  • void   
 
setProxy( String/Object/Ext.data.proxy.Proxy proxy) : void

Sets the Proxy to use for this model. Accepts any options that can be accepted by Ext.createByAlias

Sets the Proxy to use for this model. Accepts any options that can be accepted by Ext.createByAlias

Parameters

  • proxy : String/Object/Ext.data.proxy.Proxy

    The proxy

Returns

  • void   
 
suspendEvents( Boolean queueSuspended) : void

Suspend the firing of all events. (see resumeEvents)

Suspend the firing of all events. (see resumeEvents)

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

Returns

  • void   
 
un( String eventName, Function handler, [Object scope]) : void

Removes an event handler (shorthand for removeListener.)

Removes an event handler (shorthand for removeListener.)

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope : Object

    (optional) The scope originally specified for the handler.

Returns

  • void   
 

Tells this model instance that it has been removed from the store

Tells this model instance that it has been removed from the store

Returns

  • void   
 

Validates the current data against all of its configured validations and returns an Errors object

Validates the current data against all of its configured validations and returns an Errors object

Returns

  • Ext.data.Errors   

    The errors object