Ext JS 4.2.0 Sencha Docs

Ext.data.Model

Alternate names

Ext.data.Record

Hierarchy

Ext.Base
Ext.data.Model

Mixins

Requires

Subclasses

Files

A Model represents some object that your application manages. For example, one might define a Model for Users, Products, Cars, or any other real-world object that we want to model in the system. Models are registered via the model manager, and are used by stores, which are in turn used by many of the data-bound components in Ext.

Models are defined as a set of fields and any arbitrary methods and properties relevant to the model. For example:

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: [
        {name: 'name',  type: 'string'},
        {name: 'age',   type: 'int', convert: null},
        {name: 'phone', type: 'string'},
        {name: 'alive', type: 'boolean', defaultValue: true, convert: null}
    ],

    changeName: function() {
        var oldName = this.get('name'),
            newName = oldName + " The Barbarian";

        this.set('name', newName);
    }
});

The fields array is turned into a MixedCollection automatically by the ModelManager, and all other functions and properties are copied to the new Model's prototype.

A Model definition always has an identifying field which should yield a unique key for each instance. By default, a field named "id" will be created with a mapping of "id". This happens because of the default idProperty provided in Model definitions.

To alter which field is the identifying field, use the idProperty config.

If the Model should not have any identifying field (for example if you are defining ab abstract base class for your application models), configure the {@liknk idProperty} as null.

By default, the built in numeric and boolean field types have a Ext.data.Field.convert function which coerces string values in raw data into the field's type. For better performance with Json or Array readers if you are in control of the data fed into this Model, you can null out the default convert function which will cause the raw property to be copied directly into the Field's value.

Now we can create instances of our User model and call any model logic we defined:

var user = Ext.create('User', {
    id   : 'ABCD12345',
    name : 'Conan',
    age  : 24,
    phone: '555-555-5555'
});

user.changeName();
user.get('name'); //returns "Conan The Barbarian"

Validations

Models have built-in support for validations, which are executed against the validator functions in Ext.data.validations (see all validation functions). Validations are easy to add to models:

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: [
        {name: 'name',     type: 'string'},
        {name: 'age',      type: 'int'},
        {name: 'phone',    type: 'string'},
        {name: 'gender',   type: 'string'},
        {name: 'username', type: 'string'},
        {name: 'alive',    type: 'boolean', defaultValue: true}
    ],

    validations: [
        {type: 'presence',  field: 'age'},
        {type: 'length',    field: 'name',     min: 2},
        {type: 'inclusion', field: 'gender',   list: ['Male', 'Female']},
        {type: 'exclusion', field: 'username', list: ['Admin', 'Operator']},
        {type: 'format',    field: 'username', matcher: /([a-z]+)[0-9]{2,3}/}
    ]
});

The validations can be run by simply calling the validate function, which returns a Ext.data.Errors object:

var instance = Ext.create('User', {
    name: 'Ed',
    gender: 'Male',
    username: 'edspencer'
});

var errors = instance.validate();

Associations

Models can have associations with other Models via Ext.data.association.HasOne, belongsTo and hasMany associations. For example, let's say we're writing a blog administration application which deals with Users, Posts and Comments. We can express the relationships between these models like this:

Ext.define('Post', {
    extend: 'Ext.data.Model',
    fields: ['id', 'user_id'],

    belongsTo: 'User',
    hasMany  : {model: 'Comment', name: 'comments'}
});

Ext.define('Comment', {
    extend: 'Ext.data.Model',
    fields: ['id', 'user_id', 'post_id'],

    belongsTo: 'Post'
});

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: ['id'],

    hasMany: [
        'Post',
        {model: 'Comment', name: 'comments'}
    ]
});

See the docs for Ext.data.association.HasOne, Ext.data.association.BelongsTo and Ext.data.association.HasMany for details on the usage and configuration of associations. Note that associations can also be specified like this:

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: ['id'],

    associations: [
        {type: 'hasMany', model: 'Post',    name: 'posts'},
        {type: 'hasMany', model: 'Comment', name: 'comments'}
    ]
});

Using a Proxy

Models are great for representing types of data and relationships, but sooner or later we're going to want to load or save that data somewhere. All loading and saving of data is handled via a Proxy, which can be set directly on the Model:

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: ['id', 'name', 'email'],

    proxy: {
        type: 'rest',
        url : '/users'
    }
});

Here we've set up a Rest Proxy, which knows how to load and save data to and from a RESTful backend. Let's see how this works:

var user = Ext.create('User', {name: 'Ed Spencer', email: 'ed@sencha.com'});

user.save(); //POST /users

Calling save on the new Model instance tells the configured RestProxy that we wish to persist this Model's data onto our server. RestProxy figures out that this Model hasn't been saved before because it doesn't have an id, and performs the appropriate action - in this case issuing a POST request to the url we configured (/users). We configure any Proxy on any Model and always follow this API - see Ext.data.proxy.Proxy for a full list.

Loading data via the Proxy is equally easy:

//get a reference to the User model class
var User = Ext.ModelManager.getModel('User');

//Uses the configured RestProxy to make a GET request to /users/123
User.load(123, {
    success: function(user) {
        console.log(user.getId()); //logs 123
    }
});

Models can also be updated and destroyed easily:

//the user Model we loaded in the last snippet:
user.set('name', 'Edward Spencer');

//tells the Proxy to save the Model. In this case it will perform a PUT request to /users/123 as this Model already has an id
user.save({
    success: function() {
        console.log('The User was updated');
    }
});

//tells the Proxy to destroy the Model. Performs a DELETE request to /users/123
user.destroy({
    success: function() {
        console.log('The User was destroyed!');
    }
});

Usage in Stores

It is very common to want to load a set of Model instances to be displayed and manipulated in the UI. We do this by creating a Store:

var store = Ext.create('Ext.data.Store', {
    model: 'User'
});

//uses the Proxy we set up on Model to load the Store data
store.load();

A Store is just a collection of Model instances - usually loaded from a server somewhere. Store can also maintain a set of added, updated and removed Model instances to be synchronized with the server via the Proxy. See the Store docs for more information on Stores.

Available since: 1.1.0

Defined By

Config options

An array of associations for this model.

An array of associations for this model.

Available since: 4.0.4

One or more BelongsTo associations for this model.

One or more BelongsTo associations for this model.

Available since: 4.0.4

The name of a property that is used for submitting this Model's unique client-side identifier to the server when mult...

The name of a property that is used for submitting this Model's unique client-side identifier to the server when multiple phantom records are saved as part of the same Operation. In such a case, the server response should include the client id for each record so that the server response data can be used to update the client-side records if necessary. This property cannot have the same name as any of this Model's fields.

Available since: 4.1.0

The string type of the default Model Proxy. ...

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

Defaults to: 'ajax'

Available since: 4.0.4

Ext.data.Model
view source
: Object[]/String[]
The fields for this model. ...

The fields for this model. This is an Array of Field definition objects. A Field definition may simply be the name of the Field, but a Field encapsulates data type, custom conversion of raw data, and a mapping property to specify by name of index, how to extract a field's value from a raw data object, so it is best practice to specify a full set of Field config objects.

Available since: 4.0.4

One or more HasMany associations for this model.

One or more HasMany associations for this model.

Available since: 4.0.4

The name of the field treated as this Model's unique id. ...

The name of the field treated as this Model's unique id. Defaults to 'id'.

This may also be specified as a Field config object. This means that the identifying field can be calculated using a convert function which might aggregate several values from the raw data object to use as an identifier.

The resulting Field is added to the Model's field collection unless there is already a configured field with a mapping that reads the same property.

If defining an abstract base Model class, the idProperty may be configured as null which will mean that no identifying field will be generated.

Defaults to: 'id'

Available since: 4.0.0

The id generator to use for this model. ...

The id generator to use for this model. The default id generator does not generate values for the idProperty.

This can be overridden at the model level to provide a custom generator for a model. The simplest form of this would be:

 Ext.define('MyApp.data.MyModel', {
     extend: 'Ext.data.Model',
     requires: ['Ext.data.SequentialIdGenerator'],
     idgen: 'sequential',
     ...
 });

The above would generate sequential id's such as 1, 2, 3 etc..

Another useful id generator is Ext.data.UuidGenerator:

 Ext.define('MyApp.data.MyModel', {
     extend: 'Ext.data.Model',
     requires: ['Ext.data.UuidGenerator'],
     idgen: 'uuid',
     ...
 });

An id generation can also be further configured:

 Ext.define('MyApp.data.MyModel', {
     extend: 'Ext.data.Model',
     idgen: {
         type: 'sequential',
         seed: 1000,
         prefix: 'ID_'
     }
 });

The above would generate id's such as ID_1000, ID_1001, ID_1002 etc..

If multiple models share an id space, a single generator can be shared:

 Ext.define('MyApp.data.MyModelX', {
     extend: 'Ext.data.Model',
     idgen: {
         type: 'sequential',
         id: 'xy'
     }
 });

 Ext.define('MyApp.data.MyModelY', {
     extend: 'Ext.data.Model',
     idgen: {
         type: 'sequential',
         id: 'xy'
     }
 });

For more complex, shared id generators, a custom generator is the best approach. See Ext.data.IdGenerator for details on creating custom id generators.

Available since: 4.0.5

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

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 Ext JS Components

While some Ext JS 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 itemclick 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'); }
        }
    }
});

Available since: 1.1.0

Ext.data.Model
view source
: Stringdeprecated
The name of the property on this Persistable object that its data is saved to. ...

The name of the property on this Persistable object that its data is saved to. Defaults to 'data' (i.e: all persistable data resides in this.data.)

Defaults to: 'data'

Available since: 4.0.2

This cfg has been deprecated

This config is deprecated. In future this will no longer be configurable and will be data.

The proxy to use for this model.

The proxy to use for this model.

Available since: 4.0.4

Ext.data.Model
view source
: Object[]

An array of validations for this model.

An array of validations for this model.

Available since: 4.0.4

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

Ext.data.Model
view source
: Objectprivate
This object is used whenever the set() method is called and given a string as the first argument. ...

This object is used whenever the set() method is called and given a string as the first argument. This approach saves memory (and GC costs) since we could be called a lot.

Defaults to: {}

Available since: 4.1.0

...

Defaults to: {}

Available since: 4.1.1

Ext.data.Model
view source
: Booleanreadonly
True if this Record has been modified. ...

True if this Record has been modified.

Defaults to: false

Available since: 1.1.0

Ext.data.Model
view source
: Booleanreadonly
Internal flag used to track whether or not the model instance is currently being edited. ...

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

Defaults to: false

Available since: 4.0.0

Ext.data.Model
view source
: Arrayprivate
Used as a dummy source array when constructor is called with no args ...

Used as a dummy source array when constructor is called with no args

Defaults to: []

Available since: Ext JS 4.2.0

Ext.data.Model
view source
: Booleanprivate
...

Defaults to: false

Available since: 4.0.0

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Available since: 4.1.1

A Collection of the fields defined for this Model (including fields defined in superclasses) This is a collection of...

A Collection of the fields defined for this Model (including fields defined in superclasses)

This is a collection of Ext.data.Field instances, each of which encapsulates information that the field was configured with. By default, you can specify a field as simply a String, representing the name of the field, but a Field encapsulates data type, custom conversion of raw data, and a mapping property to specify by name of index, how to extract a field's value from a raw data object.

Available since: 2.3.0

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }

Available since: 4.1.0

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

Ext.data.Model
view source
: Number/Stringprivate

An internal unique ID for each Model instance, used to identify Models that don't have an ID yet

An internal unique ID for each Model instance, used to identify Models that don't have an ID yet

Available since: 4.0.0

...

Defaults to: true

Available since: 4.1.1

Ext.data.Model
view source
: Boolean
true in this class to identify an object as an instantiated Model, or subclass thereof. ...

true in this class to identify an object as an instantiated Model, or subclass thereof.

Defaults to: true

Available since: 4.0.0

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Available since: 4.0.0

Ext.data.Model
view source
: Object
Key: value pairs of all fields whose values have changed ...

Key: value pairs of all fields whose values have changed

Defaults to: {}

Available since: 2.3.0

Ext.data.Model
view source
: Boolean
True when the record does not yet exist in a server-side database (see setDirty). ...

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.

Defaults to: false

Available since: 3.4.0

Ext.data.Model
view source
: Object

The raw data used to create this model if created via a reader.

The raw data used to create this model if created via a reader.

Available since: 4.0.1

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

The Store to which this instance belongs. ...

The Store to which this instance belongs. NOTE: If this instance is bound to multiple stores, this property will reference only the first. To examine all the stores, use the stores property instead.

Available since: 3.4.0

The Stores to which this instance is bound. ...

The Stores to which this instance is bound.

Defaults to: []

Available since: 4.1.0

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Ext.data.Model
view source
: Numberprivatestatic
...

Defaults to: 1

Available since: 4.0.0

Ext.data.Model
view source
: Stringstatic
The update operation of type 'commit'. ...

The update operation of type 'commit'. Used by Store.update event.

Defaults to: 'commit'

Available since: 4.0.0

Ext.data.Model
view source
: Stringstatic
The update operation of type 'edit'. ...

The update operation of type 'edit'. Used by Store.update event.

Defaults to: 'edit'

Available since: 4.0.0

Ext.data.Model
view source
: Stringprivatestatic
...

Defaults to: 'ext-record'

Available since: 4.0.0

Ext.data.Model
view source
: Stringstatic
The update operation of type 'reject'. ...

The update operation of type 'reject'. Used by Store.update event.

Defaults to: 'reject'

Available since: 4.0.0

Methods

Defined By

Instance methods

Ext.data.Model
view source
new( data ) : Ext.data.Model
Creates new Model instance. ...

Creates new Model instance.

Available since: 1.1.0

Parameters

  • data : Object

    An object containing keys corresponding to this model's fields, and their associated values

Returns

Fires

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.

Available since: 1.1.0

Parameters

  • eventNames : Object/String...

    Either an object with event names as properties with a value of true. For example:

    this.addEvents({
        storeloaded: true,
        storecleared: true
    });
    

    Or any number of event names as separate parameters. For example:

    this.addEvents('storeloaded', 'storecleared');
    
( eventName, [fn], [scope], [options] ) : Object
Appends an event handler to this object. ...

Appends an event handler to this object. For example:

myGridPanel.on("mouseover", this.onMouseOver, this);

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
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellClick: {fn: this.onCellClick, scope: this, single: true},
    mouseover: {fn: panel.onMouseOver, scope: panel}
});

Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

myGridPanel.on({
    cellClick: {fn: 'onCellClick', scope: this, single: true},
    mouseover: {fn: 'onMouseOver', scope: panel}
});

Available since: 1.1.0

Parameters

  • eventName : String/Object

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

  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

  • 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.

    Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

    This object 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 : Ext.util.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'
            }
        });
      
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

      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
      });
      

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    

Fires

    Overrides: Ext.AbstractComponent.addListener

    ( item, ename, [fn], [scope], [options] ) : Object
    Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

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

    Available since: 4.0.0

    Parameters

    • item : Ext.util.Observable/Ext.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.

    • options : Object (optional)

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

    Returns

    • Object

      Only when the destroyable option is specified.

      A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

      this.btnListeners =  = myButton.mon({
          destroyable: true
          mouseover:   function() { console.log('mouseover'); },
          mouseout:    function() { console.log('mouseout'); },
          click:       function() { console.log('click'); }
      });
      

      And when those listeners need to be removed:

      Ext.destroy(this.btnListeners);
      

      or

      this.btnListeners.destroy();
      

    Fires

      Ext.data.Model
      view source
      ( [modifiedFieldNames] )private
      If this Model instance has been joined to a store, the store's afterCommit method is called, ...

      If this Model instance has been joined to a store, the store's afterCommit method is called,

      Available since: 4.0.0

      Parameters

      • modifiedFieldNames : String[] (optional)

        Array of field names changed by syncing this field with the server.

      Fires

        Ext.data.Model
        view source
        ( [modifiedFieldNames] )private
        If this Model instance has been joined to a store, the store's afterEdit method is called. ...

        If this Model instance has been joined to a store, the store's afterEdit method is called.

        Available since: 4.0.0

        Parameters

        • modifiedFieldNames : String[] (optional)

          Array of field names changed during edit.

        Fires

          Ext.data.Model
          view source
          ( )private
          If this Model instance has been joined to a store, the store's afterReject method is called. ...

          If this Model instance has been joined to a store, the store's afterReject method is called.

          Available since: 4.0.0

          Fires

            Ext.data.Model
            view source
            ( )
            Begins an edit. ...

            Begins 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.

            Available since: 2.3.0

            ( args ) : Objectdeprecatedprotected
            Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

            Call the original method that was previously overridden with override

            Ext.define('My.Cat', {
                constructor: function() {
                    alert("I'm a cat!");
                }
            });
            
            My.Cat.override({
                constructor: function() {
                    alert("I'm going to be a cat!");
            
                    this.callOverridden();
            
                    alert("Meeeeoooowwww");
                }
            });
            
            var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                      // alerts "I'm a cat!"
                                      // alerts "Meeeeoooowwww"
            

            Available since: 4.0.0

            This method has been deprecated

            as of 4.1. Use callParent instead.

            Parameters

            • args : Array/Arguments

              The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

            Returns

            • Object

              Returns the result of calling the overridden method

            Call the "parent" method of the current method. ...

            Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

             Ext.define('My.Base', {
                 constructor: function (x) {
                     this.x = x;
                 },
            
                 statics: {
                     method: function (x) {
                         return x;
                     }
                 }
             });
            
             Ext.define('My.Derived', {
                 extend: 'My.Base',
            
                 constructor: function () {
                     this.callParent([21]);
                 }
             });
            
             var obj = new My.Derived();
            
             alert(obj.x);  // alerts 21
            

            This can be used with an override as follows:

             Ext.define('My.DerivedOverride', {
                 override: 'My.Derived',
            
                 constructor: function (x) {
                     this.callParent([x*2]); // calls original My.Derived constructor
                 }
             });
            
             var obj = new My.Derived();
            
             alert(obj.x);  // now alerts 42
            

            This also works with static methods.

             Ext.define('My.Derived2', {
                 extend: 'My.Base',
            
                 statics: {
                     method: function (x) {
                         return this.callParent([x*2]); // calls My.Base.method
                     }
                 }
             });
            
             alert(My.Base.method(10);     // alerts 10
             alert(My.Derived2.method(10); // alerts 20
            

            Lastly, it also works with overridden static methods.

             Ext.define('My.Derived2Override', {
                 override: 'My.Derived2',
            
                 statics: {
                     method: function (x) {
                         return this.callParent([x*2]); // calls My.Derived2.method
                     }
                 }
             });
            
             alert(My.Derived2.method(10); // now alerts 40
            

            To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

            Available since: 4.0.0

            Parameters

            • args : Array/Arguments

              The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

            Returns

            • Object

              Returns the result of calling the parent method

            Ext.data.Model
            view source
            ( fn )private
            Helper function used by afterEdit, afterReject and afterCommit. ...

            Helper function used by afterEdit, afterReject and afterCommit. Calls the given method on the store that this instance has joined, if any. The store function will always be called with the model instance as its single argument. If this model is joined to a Ext.data.NodeStore, then this method calls the given method on the NodeStore and the associated Ext.data.TreeStore

            Available since: 4.0.0

            Parameters

            • fn : String

              The function to call on the store

            This method is used by an override to call the superclass method but bypass any overridden method. ...

            This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

            Consider:

             Ext.define('Ext.some.Class', {
                 method: function () {
                     console.log('Good');
                 }
             });
            
             Ext.define('Ext.some.DerivedClass', {
                 method: function () {
                     console.log('Bad');
            
                     // ... logic but with a bug ...
            
                     this.callParent();
                 }
             });
            

            To patch the bug in DerivedClass.method, the typical solution is to create an override:

             Ext.define('App.paches.DerivedClass', {
                 override: 'Ext.some.DerivedClass',
            
                 method: function () {
                     console.log('Fixed');
            
                     // ... logic but with bug fixed ...
            
                     this.callSuper();
                 }
             });
            

            The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

            Available since: 4.1.3

            Parameters

            • args : Array/Arguments

              The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

            Returns

            • Object

              Returns the result of calling the superclass method

            Ext.data.Model
            view source
            ( )
            Cancels all changes made in the current edit operation. ...

            Cancels all changes made in the current edit operation.

            Available since: 2.3.0

            Ext.data.Model
            view source
            ( oldId, newId )private
            ...

            Available since: Ext JS 4.2.0

            Parameters

            Fires

            Removes all listeners for this object including the managed listeners ...

            Removes all listeners for this object including the managed listeners

            Available since: 4.0.0

            Fires

              Removes all managed listeners for this object. ...

              Removes all managed listeners for this object.

              Available since: 4.0.0

              Fires

                Ext.data.Model
                view source
                ( [silent], [modifiedFieldNames] )
                Usually called by the Ext.data.Store which owns the model instance. ...

                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.

                Available since: 1.1.0

                Parameters

                • silent : Boolean (optional)

                  Pass true to skip notification of the owning store of the change.

                  Defaults to: false

                • modifiedFieldNames : String[] (optional)

                  Array of field names changed during sync with server if known. Omit or pass null if unknown. An empty array means that it is known that no fields were modified by the server's response. Defaults to false.

                Fires

                  Ext.data.Model
                  view source
                  ( f1, f2 )private
                  ...

                  Available since: 4.1.0

                  Parameters

                  ...

                  Available since: 4.1.1

                  ( eventName, args, bubbles )private
                  Continue to fire event. ...

                  Continue to fire event.

                  Available since: 4.0.7

                  Parameters

                  Fires

                    Ext.data.Model
                    view source
                    ( [id] ) : Ext.data.Model
                    Creates a copy (clone) of this Model instance. ...

                    Creates a copy (clone) of this Model instance.

                    Available since: 1.1.0

                    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

                    Ext.data.Model
                    view source
                    ( sourceRecord ) : String[]private
                    Copies data from the passed record into this record. ...

                    Copies data from the passed record into this record. If the passed record is undefined, does nothing.

                    If this is a phantom record (represented only in the client, with no corresponding database entry), and the source record is not a phantom, then this record acquires the id of the source record.

                    Available since: 4.1.0

                    Parameters

                    Returns

                    • String[]

                      The names of the fields which changed value.

                    Fires

                    Creates an event handling function which refires the event from this object as the passed event name. ...

                    Creates an event handling function which refires the event from this object as the passed event name.

                    Available since: 4.0.0

                    Parameters

                    • newName : String

                      The name under which to refire the passed parameters.

                    • beginEnd : Array (optional)

                      The caller can specify on which indices to slice.

                    Returns

                    Ext.data.Model
                    view source
                    ( options ) : Ext.data.Model
                    Destroys the model using the configured proxy. ...

                    Destroys the model using the configured proxy.

                    Available since: 4.0.0

                    Parameters

                    Returns

                    Fires

                      Overrides: Ext.Base.destroy

                      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.define('Ext.overrides.form.field.Base', {
                          override: 'Ext.form.field.Base',
                      
                          //  Add functionality to Field's initComponent to enable the change event to bubble
                          initComponent: function () {
                              this.callParent();
                              this.enableBubble('change');
                          }
                      });
                      
                      var myForm = Ext.create('Ext.form.Panel', {
                          title: 'User Details',
                          items: [{
                              ...
                          }],
                          listeners: {
                              change: function() {
                                  // Title goes red if form has been modified.
                                  myForm.header.setStyle('color', 'red');
                              }
                          }
                      });
                      

                      Available since: 3.4.0

                      Parameters

                      • eventNames : String/String[]

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

                      Ext.data.Model
                      view source
                      ( [silent], [modifiedFieldNames] )
                      Ends an edit. ...

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

                      Available since: 2.3.0

                      Parameters

                      • silent : Boolean (optional)

                        True to not notify the store of the change

                      • modifiedFieldNames : String[] (optional)

                        Array of field names changed during edit.

                      Fires

                        Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

                        Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

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

                        Available since: 1.1.0

                        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.

                        Fires

                          Fires the specified event with the passed parameter list. ...

                          Fires the specified event with the passed parameter list.

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

                          Available since: Ext JS 4.2.0

                          Parameters

                          • eventName : String

                            The name of the event to fire.

                          • args : Object[]

                            An array of parameters which are passed to handlers.

                          Returns

                          • Boolean

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

                          Fires

                            Ext.data.Model
                            view source
                            ( fieldName ) : Object
                            Returns the value of the given field ...

                            Returns the value of the given field

                            Available since: 1.1.0

                            Parameters

                            • fieldName : String

                              The field to fetch the value for

                            Returns

                            Gets all of the data from this Models loaded associations. ...

                            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: [
                                            ...
                                        ]
                                    }
                                ]
                            }
                            

                            Available since: 4.0.0

                            Returns

                            • Object

                              The nested data set for the Model's loaded associations

                            Fires

                              Gets the bubbling parent for an Observable ...

                              Gets the bubbling parent for an Observable

                              Available since: 4.0.7

                              Returns

                              Fires

                                Ext.data.Model
                                view source
                                ( ) : Object
                                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.

                                Available since: 2.3.0

                                Returns

                                Fires

                                  ...

                                  Available since: 4.1.0

                                  Parameters

                                  Ext.data.Model
                                  view source
                                  ( includeAssociated ) : Object
                                  Gets all values for each field in this model and returns an object containing the current data. ...

                                  Gets all values for each field in this model and returns an object containing the current data.

                                  Available since: 4.1.0

                                  Parameters

                                  • includeAssociated : Boolean

                                    True to also include associated data. Defaults to false.

                                  Returns

                                  • Object

                                    An object hash containing all the values in this model

                                  Fires

                                    Ext.data.Model
                                    view source
                                    ( ) : Number/String
                                    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.

                                    Available since: 4.0.0

                                    Returns

                                    Fires

                                      Returns the initial configuration passed to constructor when instantiating this class. ...

                                      Returns the initial configuration passed to constructor when instantiating this class.

                                      Available since: 4.1.0

                                      Parameters

                                      • name : String (optional)

                                        Name of the config option to return.

                                      Returns

                                      • Object/Mixed

                                        The full config object or a single config value when name parameter specified.

                                      Ext.data.Model
                                      view source
                                      ( [saved] ) : String[]private
                                      Gets the names of all the fields that were modified during an edit ...

                                      Gets the names of all the fields that were modified during an edit

                                      Available since: 4.1.0

                                      Parameters

                                      • saved : Object (optional)

                                        The currently saved data. Defaults to the dataSave property on the object.

                                      Returns

                                      • String[]

                                        An array of modified field names

                                      Fires

                                        Ext.data.Model
                                        view source
                                        ( )private
                                        ...

                                        Available since: 4.1.0

                                        Returns the configured Proxy for this Model. ...

                                        Returns the configured Proxy for this Model.

                                        Available since: 4.0.0

                                        Returns

                                        Fires

                                          ...

                                          Available since: 4.1.0

                                          Parameters

                                          Ext.data.Model
                                          view source
                                          ( [id] ) : Booleanprivate
                                          Checks if this model has an id assigned ...

                                          Checks if this model has an id assigned

                                          Available since: Ext JS 4.2.0

                                          Parameters

                                          • id : Object (optional)

                                            The id, if not passed it will call getId()

                                          Returns

                                          • Boolean

                                            True if the model has an id

                                          Fires

                                            Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

                                            Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

                                            Available since: 1.1.0

                                            Parameters

                                            • eventName : String

                                              The name of the event to check for

                                            Returns

                                            • Boolean

                                              true if the event is being listened for or bubbles, else false

                                            ( config ) : Ext.Basechainableprotected
                                            Initialize configuration for this class. ...

                                            Initialize configuration for this class. a typical example:

                                            Ext.define('My.awesome.Class', {
                                                // The default config
                                                config: {
                                                    name: 'Awesome',
                                                    isAwesome: true
                                                },
                                            
                                                constructor: function(config) {
                                                    this.initConfig(config);
                                                }
                                            });
                                            
                                            var awesome = new My.awesome.Class({
                                                name: 'Super Awesome'
                                            });
                                            
                                            alert(awesome.getName()); // 'Super Awesome'
                                            

                                            Available since: 4.0.0

                                            Parameters

                                            Returns

                                            Ext.data.Model
                                            view source
                                            ( a, b ) : Booleanprivate
                                            Checks if two values are equal, taking into account certain special factors, for example dates. ...

                                            Checks if two values are equal, taking into account certain special factors, for example dates.

                                            Available since: 4.0.0

                                            Parameters

                                            Returns

                                            • Boolean

                                              True if the values are equal

                                            Ext.data.Model
                                            view source
                                            ( 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.

                                            Available since: 2.3.0

                                            Parameters

                                            Returns

                                            Ext.data.Model
                                            view source
                                            ( ) : Boolean
                                            Checks if the model is valid. ...

                                            Checks if the model is valid. See validate.

                                            Available since: 3.4.0

                                            Returns

                                            • Boolean

                                              True if the model is valid.

                                            Fires

                                              Ext.data.Model
                                              view source
                                              ( item )private
                                              ...

                                              Available since: 4.1.0

                                              Parameters

                                              Ext.data.Model
                                              view source
                                              ( store )
                                              Tells this model instance that it has been added to a store. ...

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

                                              Available since: 4.0.0

                                              Parameters

                                              Ext.data.Model
                                              view source
                                              ( )private
                                              ...

                                              Available since: 3.4.0

                                              ( item, ename, [fn], [scope], [options] ) : Object
                                              Shorthand for addManagedListener. ...

                                              Shorthand for addManagedListener.

                                              Available since: 4.0.2

                                              Parameters

                                              • item : Ext.util.Observable/Ext.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.

                                              • options : Object (optional)

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

                                              Returns

                                              • Object

                                                Only when the destroyable option is specified.

                                                A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                                this.btnListeners =  = myButton.mon({
                                                    destroyable: true
                                                    mouseover:   function() { console.log('mouseover'); },
                                                    mouseout:    function() { console.log('mouseout'); },
                                                    click:       function() { console.log('click'); }
                                                });
                                                

                                                And when those listeners need to be removed:

                                                Ext.destroy(this.btnListeners);
                                                

                                                or

                                                this.btnListeners.destroy();
                                                
                                              ( item, ename, [fn], [scope] )
                                              Shorthand for removeManagedListener. ...

                                              Shorthand for removeManagedListener.

                                              Available since: 4.0.2

                                              Parameters

                                              • item : Ext.util.Observable/Ext.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.

                                              ( eventName, [fn], [scope], [options] ) : Object
                                              Shorthand for addListener. ...

                                              Shorthand for addListener.

                                              Available since: 1.1.0

                                              Parameters

                                              • eventName : String/Object

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

                                              • fn : Function (optional)

                                                The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

                                              • 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.

                                                Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

                                                This object 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 : Ext.util.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'
                                                        }
                                                    });
                                                  
                                                • destroyable : Boolean (optional)

                                                  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

                                                  Defaults to: false

                                                • priority : Number (optional)

                                                  An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

                                                  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
                                                  });
                                                  

                                              Returns

                                              • Object

                                                Only when the destroyable option is specified.

                                                A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                                this.btnListeners =  = myButton.on({
                                                    destroyable: true
                                                    mouseover:   function() { console.log('mouseover'); },
                                                    mouseout:    function() { console.log('mouseout'); },
                                                    click:       function() { console.log('click'); }
                                                });
                                                

                                                And when those listeners need to be removed:

                                                Ext.destroy(this.btnListeners);
                                                

                                                or

                                                this.btnListeners.destroy();
                                                
                                              Ext.data.Model
                                              view source
                                              ( cls, data, hooks )private
                                              ...

                                              Available since: 4.0.0

                                              Parameters

                                              ( names, callback, scope )private
                                              ...

                                              Available since: 4.1.0

                                              Parameters

                                              Ext.data.Model
                                              view source
                                              ( seenKeys, depth ) : Objectprivate
                                              This complex-looking method takes a given Model instance and returns an object containing all data from all of that M...

                                              This complex-looking method takes a given Model instance and returns an object containing all data from all of that Model's loaded associations. See getAssociatedData

                                              Available since: 4.0.0

                                              Parameters

                                              • seenKeys : Object

                                                A hash of all the associations we've already seen

                                              • depth : Number

                                                The current depth

                                              Returns

                                              • Object

                                                The nested data set for the Model's loaded associations

                                              Prepares a given class for observable instances. ...

                                              Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

                                              Available since: 4.1.2

                                              Parameters

                                              • T : Function

                                                The class constructor to prepare.

                                              Ext.data.Model
                                              view source
                                              ( [silent] )
                                              Usually called by the Ext.data.Store to which this model instance has been joined. ...

                                              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.

                                              Available since: 1.1.0

                                              Parameters

                                              • silent : Boolean (optional)

                                                True to skip notification of the owning store of the change. Defaults to false.

                                              Fires

                                                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.

                                                For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

                                                this.relayEvents(this.getStore(), ['load']);
                                                

                                                The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

                                                Available since: 2.3.0

                                                Parameters

                                                • origin : Object

                                                  The Observable whose events this object is to relay.

                                                • events : String[]

                                                  Array of event names to relay.

                                                • prefix : String (optional)

                                                  A common prefix to prepend to the event names. For example:

                                                  this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                  

                                                  Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

                                                Returns

                                                • Object

                                                  A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

                                                  this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                  

                                                  Can be undone by calling

                                                  Ext.destroy(this.storeRelayers);
                                                  

                                                  or

                                                  this.store.relayers.destroy();
                                                  

                                                Fires

                                                  Removes an event handler. ...

                                                  Removes an event handler.

                                                  Available since: 1.1.0

                                                  Parameters

                                                  • eventName : String

                                                    The type of event the handler was associated with.

                                                  • fn : 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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                  Fires

                                                    Removes listeners that were added by the mon method. ...

                                                    Removes listeners that were added by the mon method.

                                                    Available since: 4.0.0

                                                    Parameters

                                                    • item : Ext.util.Observable/Ext.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.

                                                    Fires

                                                      Remove a single managed listener item ...

                                                      Remove a single managed listener item

                                                      Available since: 4.0.1

                                                      Parameters

                                                      • isClear : Boolean

                                                        True if this is being called during a clear

                                                      • managedListener : Object

                                                        The managed listener item See removeManagedListener for other args

                                                      Overrides: Ext.AbstractComponent.removeManagedListenerItem

                                                      Resumes firing of the named event(s). ...

                                                      Resumes firing of the named event(s).

                                                      After calling this method to resume events, the events will fire when requested to fire.

                                                      Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

                                                      Available since: Ext JS 4.2.0

                                                      Parameters

                                                      • eventName : String...

                                                        Multiple event names to resume.

                                                      Resumes firing events (see suspendEvents). ...

                                                      Resumes 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.

                                                      Available since: 2.3.0

                                                      Ext.data.Model
                                                      view source
                                                      ( [options] ) : Ext.data.Model
                                                      Saves the model instance using the configured proxy. ...

                                                      Saves the model instance using the configured proxy.

                                                      Available since: 4.0.0

                                                      Parameters

                                                      Returns

                                                      Fires

                                                        Ext.data.Model
                                                        view source
                                                        ( fieldName, newValue ) : String[]
                                                        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

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • fieldName : String/Object

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

                                                        • newValue : Object

                                                          The value to set

                                                        Returns

                                                        • String[]

                                                          The array of modified field names or null if nothing was modified.

                                                        Fires

                                                        ( config, applyIfNotSet ) : Ext.Basechainableprivate
                                                        ...

                                                        Available since: 4.0.0

                                                        Parameters

                                                        Returns

                                                        Ext.data.Model
                                                        view source
                                                        ( )
                                                        Marks this Record as dirty. ...

                                                        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.getUpdatedRecords where it will have a create action composed for it during model save operations.

                                                        Available since: 4.0.0

                                                        Fires

                                                          Ext.data.Model
                                                          view source
                                                          ( id )
                                                          Sets the model instance's id field to the given id. ...

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

                                                          Available since: 4.0.0

                                                          Parameters

                                                          Fires

                                                          Ext.data.Model
                                                          view source
                                                          ( proxy ) : Ext.data.proxy.Proxy
                                                          Sets the Proxy to use for this model. ...

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

                                                          Available since: 4.0.4

                                                          Parameters

                                                          Returns

                                                          Get the reference to the class from which this object was instantiated. ...

                                                          Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

                                                          Ext.define('My.Cat', {
                                                              statics: {
                                                                  totalCreated: 0,
                                                                  speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                              },
                                                          
                                                              constructor: function() {
                                                                  var statics = this.statics();
                                                          
                                                                  alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                  // equivalent to: My.Cat.speciesName
                                                          
                                                                  alert(this.self.speciesName);   // dependent on 'this'
                                                          
                                                                  statics.totalCreated++;
                                                              },
                                                          
                                                              clone: function() {
                                                                  var cloned = new this.self;                      // dependent on 'this'
                                                          
                                                                  cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                          
                                                                  return cloned;
                                                              }
                                                          });
                                                          
                                                          
                                                          Ext.define('My.SnowLeopard', {
                                                              extend: 'My.Cat',
                                                          
                                                              statics: {
                                                                  speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                              },
                                                          
                                                              constructor: function() {
                                                                  this.callParent();
                                                              }
                                                          });
                                                          
                                                          var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                          
                                                          var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                          
                                                          var clone = snowLeopard.clone();
                                                          alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                          alert(clone.groupName);                 // alerts 'Cat'
                                                          
                                                          alert(My.Cat.totalCreated);             // alerts 3
                                                          

                                                          Available since: 4.0.0

                                                          Returns

                                                          Suspends firing of the named event(s). ...

                                                          Suspends firing of the named event(s).

                                                          After calling this method to suspend events, the events will no longer fire when requested to fire.

                                                          Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

                                                          Available since: Ext JS 4.2.0

                                                          Parameters

                                                          • eventName : String...

                                                            Multiple event names to suspend.

                                                          Suspends the firing of all events. ...

                                                          Suspends the firing of all events. (see resumeEvents)

                                                          Available since: 2.3.0

                                                          Parameters

                                                          • queueSuspended : Boolean

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

                                                          ( eventName, fn, [scope] )
                                                          Shorthand for removeListener. ...

                                                          Shorthand for removeListener.

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • eventName : String

                                                            The type of event the handler was associated with.

                                                          • fn : 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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                          Ext.data.Model
                                                          view source
                                                          ( store )
                                                          Tells this model instance that it has been removed from the store. ...

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

                                                          Available since: 4.0.0

                                                          Parameters

                                                          • store : Ext.data.Store

                                                            The store from which this model has been removed.

                                                          Validates the current data against all of its configured validations. ...

                                                          Validates the current data against all of its configured validations.

                                                          Available since: 4.0.0

                                                          Returns

                                                          Fires

                                                            Defined By

                                                            Static methods

                                                            ( config )privatestatic
                                                            ...

                                                            Available since: 4.1.1

                                                            Parameters

                                                            ( members )chainableprivatestatic
                                                            ...

                                                            Available since: 4.1.1

                                                            Parameters

                                                            ( name, member )chainableprivatestatic
                                                            ...

                                                            Available since: 4.1.1

                                                            Parameters

                                                            ( members )chainablestatic
                                                            Add methods / properties to the prototype of this class. ...

                                                            Add methods / properties to the prototype of this class.

                                                            Ext.define('My.awesome.Cat', {
                                                                constructor: function() {
                                                                    ...
                                                                }
                                                            });
                                                            
                                                             My.awesome.Cat.addMembers({
                                                                 meow: function() {
                                                                    alert('Meowww...');
                                                                 }
                                                             });
                                                            
                                                             var kitty = new My.awesome.Cat;
                                                             kitty.meow();
                                                            

                                                            Available since: 4.1.0

                                                            Parameters

                                                            ( members ) : Ext.Basechainablestatic
                                                            Add / override static properties of this class. ...

                                                            Add / override static properties of this class.

                                                            Ext.define('My.cool.Class', {
                                                                ...
                                                            });
                                                            
                                                            My.cool.Class.addStatics({
                                                                someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                                                                method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
                                                                method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
                                                            });
                                                            

                                                            Available since: 4.0.2

                                                            Parameters

                                                            Returns

                                                            ( xtype )chainableprivatestatic
                                                            ...

                                                            Available since: 4.1.1

                                                            Parameters

                                                            ( fromClass, members ) : Ext.Basechainableprivatestatic
                                                            Borrow another class' members to the prototype of this class. ...

                                                            Borrow another class' members to the prototype of this class.

                                                            Ext.define('Bank', {
                                                                money: '$$$',
                                                                printMoney: function() {
                                                                    alert('$$$$$$$');
                                                                }
                                                            });
                                                            
                                                            Ext.define('Thief', {
                                                                ...
                                                            });
                                                            
                                                            Thief.borrow(Bank, ['money', 'printMoney']);
                                                            
                                                            var steve = new Thief();
                                                            
                                                            alert(steve.money); // alerts '$$$'
                                                            steve.printMoney(); // alerts '$$$$$$$'
                                                            

                                                            Available since: 4.0.2

                                                            Parameters

                                                            • fromClass : Ext.Base

                                                              The class to borrow members from

                                                            • members : Array/String

                                                              The names of the members to borrow

                                                            Returns

                                                            Create a new instance of this Class. ...

                                                            Create a new instance of this Class.

                                                            Ext.define('My.cool.Class', {
                                                                ...
                                                            });
                                                            
                                                            My.cool.Class.create({
                                                                someConfig: true
                                                            });
                                                            

                                                            All parameters are passed to the constructor of the class.

                                                            Available since: 4.0.2

                                                            Returns

                                                            Overrides: Ext.layout.Layout.create

                                                            ( alias, origin )static
                                                            Create aliases for existing prototype methods. ...

                                                            Create aliases for existing prototype methods. Example:

                                                            Ext.define('My.cool.Class', {
                                                                method1: function() { ... },
                                                                method2: function() { ... }
                                                            });
                                                            
                                                            var test = new My.cool.Class();
                                                            
                                                            My.cool.Class.createAlias({
                                                                method3: 'method1',
                                                                method4: 'method2'
                                                            });
                                                            
                                                            test.method3(); // test.method1()
                                                            
                                                            My.cool.Class.createAlias('method5', 'method3');
                                                            
                                                            test.method5(); // test.method3() -> test.method1()
                                                            

                                                            Available since: 4.0.2

                                                            Parameters

                                                            ( config )privatestatic
                                                            ...

                                                            Available since: 4.1.1

                                                            Parameters

                                                            Ext.data.Model
                                                            view source
                                                            ( ) : Ext.data.Field[]static
                                                            Returns an Array of Field definitions which define this Model's structure Fields are sorted upon Model class definit...

                                                            Returns an Array of Field definitions which define this Model's structure

                                                            Fields are sorted upon Model class definition. Fields with custom convert functions are moved to after fields with no convert functions. This is so that convert functions which rely on existing field values will be able to read those field values.

                                                            Available since: 4.1.0

                                                            Returns

                                                            Get the current class' name in string format. ...

                                                            Get the current class' name in string format.

                                                            Ext.define('My.cool.Class', {
                                                                constructor: function() {
                                                                    alert(this.self.getName()); // alerts 'My.cool.Class'
                                                                }
                                                            });
                                                            
                                                            My.cool.Class.getName(); // 'My.cool.Class'
                                                            

                                                            Available since: 4.0.4

                                                            Returns

                                                            Ext.data.Model
                                                            view source
                                                            ( ) : Ext.data.proxy.Proxystatic
                                                            Returns the configured Proxy for this Model ...

                                                            Returns the configured Proxy for this Model

                                                            Available since: 4.0.0

                                                            Returns

                                                            Ext.data.Model
                                                            view source
                                                            ( rec ) : Stringstatic
                                                            Generates a sequential id. ...

                                                            Generates a sequential id. This method is typically called when a record is created and no id has been specified either as a parameter, or through the idProperty in the passed data. The generated id will automatically be assigned to the record. The returned id takes the form: {PREFIX}-{AUTO_ID}.

                                                            Available since: 4.0.0

                                                            Parameters

                                                            Returns

                                                            • String

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

                                                            ( )deprecatedstatic
                                                            Adds members to class. ...

                                                            Adds members to class.

                                                            Available since: 4.0.2

                                                            This method has been deprecated since 4.1

                                                            Use addMembers instead.

                                                            Ext.data.Model
                                                            view source
                                                            ( id, [config] )static
                                                            Asynchronously loads a model instance by id. ...

                                                            Asynchronously loads a model instance by id. Sample usage:

                                                            Ext.define('MyApp.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
                                                                }
                                                            });
                                                            

                                                            Available since: 4.0.0

                                                            Parameters

                                                            • id : Number/String

                                                              The id of the model to load

                                                            • config : Object (optional)

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

                                                            ( name, mixinClass )privatestatic
                                                            Used internally by the mixins pre-processor ...

                                                            Used internally by the mixins pre-processor

                                                            Available since: 4.1.1

                                                            Parameters

                                                            ( fn, scope )chainableprivatestatic
                                                            ...

                                                            Available since: 4.1.1

                                                            Parameters

                                                            ( members ) : Ext.Basechainabledeprecatedstatic
                                                            Override members of this class. ...

                                                            Override members of this class. Overridden methods can be invoked via callParent.

                                                            Ext.define('My.Cat', {
                                                                constructor: function() {
                                                                    alert("I'm a cat!");
                                                                }
                                                            });
                                                            
                                                            My.Cat.override({
                                                                constructor: function() {
                                                                    alert("I'm going to be a cat!");
                                                            
                                                                    this.callParent(arguments);
                                                            
                                                                    alert("Meeeeoooowwww");
                                                                }
                                                            });
                                                            
                                                            var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                                      // alerts "I'm a cat!"
                                                                                      // alerts "Meeeeoooowwww"
                                                            

                                                            As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

                                                            Ext.define('My.CatOverride', {
                                                                override: 'My.Cat',
                                                                constructor: function() {
                                                                    alert("I'm going to be a cat!");
                                                            
                                                                    this.callParent(arguments);
                                                            
                                                                    alert("Meeeeoooowwww");
                                                                }
                                                            });
                                                            

                                                            The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

                                                            Available since: 4.0.2

                                                            This method has been deprecated since 4.1.0

                                                            Use Ext.define instead

                                                            Parameters

                                                            • members : Object

                                                              The properties to add to this class. This should be specified as an object literal containing one or more properties.

                                                            Returns

                                                            Ext.data.Model
                                                            view source
                                                            ( fields, idProperty, clientIdProperty )static
                                                            Apply a new set of field and/or property definitions to the existing model. ...

                                                            Apply a new set of field and/or property definitions to the existing model. This will replace any existing fields, including fields inherited from superclasses. Mainly for reconfiguring the model based on changes in meta data (called from Reader's onMetaChange method).

                                                            Available since: 4.1.0

                                                            Parameters

                                                            Ext.data.Model
                                                            view source
                                                            ( proxy ) : Ext.data.proxy.Proxystatic
                                                            Sets the Proxy to use for this model. ...

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

                                                            Available since: 4.0.0

                                                            Parameters

                                                            Returns

                                                            ...

                                                            Available since: 4.1.1

                                                            Defined By

                                                            Events

                                                            Ext.data.Model
                                                            view source
                                                            ( this, oldId, newId, eOpts )
                                                            Fired when this model's id changes ...

                                                            Fired when this model's id changes

                                                            Available since: 4.1.0

                                                            Parameters