Alternate names
Ext.data.Record
Hierarchy
Ext.BaseExt.data.Model
Mixins
Ext.util.Observable
Requires
Ext.ModelManager
Ext.data.Errors
Ext.data.Field
Ext.data.IdGenerator
Ext.data.Operation
Ext.data.validations
Ext.util.MixedCollection
Subclasses
Ext.data.TreeModel
Ext.grid.property.Property
Files
Model.js

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

\n\n

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

\n\n

Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: [\n        {name: 'name',  type: 'string'},\n        {name: 'age',   type: 'int', convert: null},\n        {name: 'phone', type: 'string'},\n        {name: 'alive', type: 'boolean', defaultValue: true, convert: null}\n    ],\n\n    changeName: function() {\n        var oldName = this.get('name'),\n            newName = oldName + \" The Barbarian\";\n\n        this.set('name', newName);\n    }\n});\n

\n\n

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.

\n\n

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

\n\n

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

\n\n

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

\n\n

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

\n\n

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

\n\n

var user = Ext.create('User', {\n    id   : 'ABCD12345',\n    name : 'Conan',\n    age  : 24,\n    phone: '555-555-5555'\n});\n\nuser.changeName();\nuser.get('name'); //returns \"Conan The Barbarian\"\n

\n\n

Validations

\n\n

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\nmodels:

\n\n

Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: [\n        {name: 'name',     type: 'string'},\n        {name: 'age',      type: 'int'},\n        {name: 'phone',    type: 'string'},\n        {name: 'gender',   type: 'string'},\n        {name: 'username', type: 'string'},\n        {name: 'alive',    type: 'boolean', defaultValue: true}\n    ],\n\n    validations: [\n        {type: 'presence',  field: 'age'},\n        {type: 'length',    field: 'name',     min: 2},\n        {type: 'inclusion', field: 'gender',   list: ['Male', 'Female']},\n        {type: 'exclusion', field: 'username', list: ['Admin', 'Operator']},\n        {type: 'format',    field: 'username', matcher: /([a-z]+)[0-9]{2,3}/}\n    ]\n});\n

\n\n

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

\n\n

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

\n\n

Associations

\n\n

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

\n\n

Ext.define('Post', {\n    extend: 'Ext.data.Model',\n    fields: ['id', 'user_id'],\n\n    belongsTo: 'User',\n    hasMany  : {model: 'Comment', name: 'comments'}\n});\n\nExt.define('Comment', {\n    extend: 'Ext.data.Model',\n    fields: ['id', 'user_id', 'post_id'],\n\n    belongsTo: 'Post'\n});\n\nExt.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['id'],\n\n    hasMany: [\n        'Post',\n        {model: 'Comment', name: 'comments'}\n    ]\n});\n

\n\n

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

\n\n

Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['id'],\n\n    associations: [\n        {type: 'hasMany', model: 'Post',    name: 'posts'},\n        {type: 'hasMany', model: 'Comment', name: 'comments'}\n    ]\n});\n

\n\n

Using a Proxy

\n\n

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

\n\n

Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['id', 'name', 'email'],\n\n    proxy: {\n        type: 'rest',\n        url : '/users'\n    }\n});\n

\n\n

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

\n\n

var user = Ext.create('User', {name: 'Ed Spencer', email: 'ed@sencha.com'});\n\nuser.save(); //POST /users\n

\n\n

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

\n\n

Loading data via the Proxy is equally easy:

\n\n

//get a reference to the User model class\nvar User = Ext.ModelManager.getModel('User');\n\n//Uses the configured RestProxy to make a GET request to /users/123\nUser.load(123, {\n    success: function(user) {\n        console.log(user.getId()); //logs 123\n    }\n});\n

\n\n

Models can also be updated and destroyed easily:

\n\n

//the user Model we loaded in the last snippet:\nuser.set('name', 'Edward Spencer');\n\n//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\nuser.save({\n    success: function() {\n        console.log('The User was updated');\n    }\n});\n\n//tells the Proxy to destroy the Model. Performs a DELETE request to /users/123\nuser.destroy({\n    success: function() {\n        console.log('The User was destroyed!');\n    }\n});\n

\n\n

Usage in Stores

\n\n

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\ncreating a Store:

\n\n

var store = Ext.create('Ext.data.Store', {\n    model: 'User'\n});\n\n//uses the Proxy we set up on Model to load the Store data\nstore.load();\n

\n\n

A Store is just a collection of Model instances - usually loaded from a server somewhere. Store can also maintain a\nset 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.

Defined By

Config options

Ext.data.Model
view source

associations : Object[]

An array of associations for this model.

Ext.data.Model
view source

belongsTo : String/Object/String[]/Object[]

One or more BelongsTo associations for this model.

Ext.data.Model
view source

clientIdProperty : String

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

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

Ext.data.Model
view source

defaultProxyType : String

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

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

Defaults to: 'ajax'

Ext.data.Model
view source

fields : Object[]/String[]

The fields for this model. ...

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

Ext.data.Model
view source

hasMany : String/Object/String[]/Object[]

One or more HasMany associations for this model.

Ext.data.Model
view source

idProperty : String/Object/Ext.data.Field

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

\n\n

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

\n\n

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

\n\n

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

Defaults to: 'id'

Ext.data.Model
view source

idgen : String/Object

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

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

\n\n

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

\n\n

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

\n\n

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

\n\n

Another useful id generator is Ext.data.UuidGenerator:

\n\n

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

\n\n

An id generation can also be further configured:

\n\n

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

\n\n

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

\n\n

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

\n\n

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

\n\n

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

Ext.util.Observable
view source

listeners : Object

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\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from Ext JS Components

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly 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\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n

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

Ext.data.Model
view source

persistenceProperty : 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'\n(i.e: all persistable data resides in this.data.)

Defaults to: 'data'

This cfg has been deprecated

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

\n\n

Ext.data.Model
view source

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

The proxy to use for this model.

Ext.data.Model
view source

validations : Object[]

An array of validations for this model.

Properties

Defined By

Instance Properties

Ext.Base
view source

$className : Stringprivate

...

Defaults to: 'Ext.Base'

Ext.data.Model
view source

_singleProp : Objectprivate

This object is used whenever the set() method is called and given a string as the\nfirst argument. ...

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

Defaults to: {}

Ext.Base
view source

configMap : Objectprivate

...

Defaults to: {}

Ext.data.Model
view source

dirty : Booleanreadonly

True if this Record has been modified. ...

True if this Record has been modified.

Defaults to: false

Ext.data.Model
view source

editing : 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

Ext.data.Model
view source

emptyData : 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: []

Ext.data.Model
view source

evented : Booleanprivate

...

Defaults to: false

Ext.util.Observable
view source

eventsSuspended : Numberprivate

Initial suspended call count. ...

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

Defaults to: 0

Ext.data.Model
view source

fields : Ext.util.MixedCollection

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

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

\n\n

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

Ext.util.Observable
view source

hasListeners : Objectreadonly

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\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

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

\n\n

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

Ext.Base
view source

initConfigList : Arrayprivate

...

Defaults to: []

Ext.Base
view source

initConfigMap : Objectprivate

...

Defaults to: {}

Ext.data.Model
view source

internalId : Number/Stringprivate

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

Ext.Base
view source

isInstance : Booleanprivate

...

Defaults to: true

Ext.data.Model
view source

isModel : 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

Ext.util.Observable
view source

isObservable : Boolean

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

Ext.data.Model
view source

modified : Object

Key: value pairs of all fields whose values have changed

Ext.data.Model
view source

phantom : 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).\nAny record which has a real database pk set as its id property is NOT a phantom -- it's real.

Defaults to: false

Ext.data.Model
view source

raw : Object

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

Ext.Base
view source

self : Ext.Classprotected

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,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

Ext.data.Model
view source

store : Ext.data.Store

The Store to which this instance belongs. ...

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

Ext.data.Model
view source

stores : Ext.data.Store[]

The Stores to which this instance is bound.

Defined By

Static Properties

Ext.Base
view source

$onExtended : Arrayprivatestatic

...

Defaults to: []

Ext.data.Model
view source

AUTO_ID : Numberprivatestatic

...

Defaults to: 1

Ext.data.Model
view source

COMMIT : Stringstatic

The update operation of type 'commit'. ...

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

Defaults to: 'commit'

Ext.data.Model
view source

EDIT : Stringstatic

The update operation of type 'edit'. ...

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

Defaults to: 'edit'

Ext.data.Model
view source

PREFIX : Stringprivatestatic

...

Defaults to: 'ext-record'

Ext.data.Model
view source

REJECT : Stringstatic

The update operation of type 'reject'. ...

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

Defaults to: 'reject'

Methods

Defined By

Instance Methods

Ext.data.Model
view source

newExt.data.Model( data ) : Ext.data.Model

Creates new Model instance. ...

Creates new Model instance.

Parameters

data : Object
An object containing keys corresponding to this model's fields, and their associated values
\n

Returns

Ext.data.Model
\n

Ext.util.Observable
view source

addEvents( eventNames )

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

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

Parameters

eventNames : Object/String...
Either an object with event names as properties with\na value of true. For example:
\n\n
```
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
```
\n\n
Or any number of event names as separate parameters. For example:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n

Ext.util.Observable
view source

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

Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n

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

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

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

\n\n

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

\n\n

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

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n
- 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.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Returns

Object

Only when the destroyable option is specified.

\n\n\n\n\n

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

\n\n\n\n\n

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

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

Ext.util.Observable
view source

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

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

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

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
options : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Returns

Object

Only when the destroyable option is specified.

\n\n\n\n\n

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

\n\n\n\n\n

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

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

Ext.data.Model
view source

afterCommit( [modifiedFieldNames] )private

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

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

Parameters

modifiedFieldNames : String[] (optional)
Array of field names changed by syncing this field with the server.
\n

Ext.data.Model
view source

afterEdit( [modifiedFieldNames] )private

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

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

Parameters

modifiedFieldNames : String[] (optional)
Array of field names changed during edit.
\n

Ext.data.Model
view source

afterReject( )private

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

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

Ext.data.Model
view source

beginEdit( )

Begins an edit. ...

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

Ext.Base
view source

callOverridden( args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

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

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

Ext.Base
view source

callParent( args ) : Objectprotected

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

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

\n\n

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

\n\n

This can be used with an override as follows:

\n\n

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

\n\n

This also works with static methods.

\n\n

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

\n\n

Lastly, it also works with overridden static methods.

\n\n

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

\n\n

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

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

Ext.data.Model
view source

callStore( fn )private

Helper function used by afterEdit, afterReject and afterCommit. ...

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

Parameters

fn : String
The function to call on the store
\n

Ext.Base
view source

callSuper( args ) : Objectprotected

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

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

\n\n

Consider:

\n\n

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

\n\n

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

\n\n

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

\n\n

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

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callSuper(arguments)
\n

Returns

Object
Returns the result of calling the superclass method
\n

Ext.data.Model
view source

cancelEdit( )

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

Cancels all changes made in the current edit operation.

Ext.util.Observable
view source

captureArgs( o, fn, scope )private

...

Parameters

o : Object
\n
fn : Object
\n
scope : Object
\n

Ext.data.Model
view source

changeId( oldId, newId )private

...

Parameters

oldId : Object
\n
newId : Object
\n

Ext.util.Observable
view source

clearListeners( )

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

Removes all listeners for this object including the managed listeners

Ext.util.Observable
view source

clearManagedListeners( )

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

Ext.data.Model
view source

commit( [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\ninstance since either creation or the last commit operation.

\n\n

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

Parameters

silent : Boolean (optional)
Pass true to skip notification of the owning store of the change.
\n
Defaults to: false
modifiedFieldNames : String[] (optional)
Array of field names changed during sync with server if known.\nOmit or pass null if unknown. An empty array means that it is known that no fields were modified\nby the server's response.\nDefaults to false.
\n

Ext.data.Model
view source

compareConvertFields( f1, f2 )private

...

Parameters

f1 : Object
\n
f2 : Object
\n

Ext.Base
view source

configClass( )private

...

Ext.util.Observable
view source

continueFireEvent( eventName, args, bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

eventName : String
\n
args : Array
\n
bubbles : Boolean
\n

Ext.data.Model
view source

copy( [id] ) : Ext.data.Model

Creates a copy (clone) of this Model instance. ...

Creates a copy (clone) of this Model instance.

Parameters

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

Returns

Ext.data.Model
\n

Ext.data.Model
view source

copyFrom( 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.

\n\n

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

Parameters

sourceRecord : Ext.data.Model
The record to copy data from.
\n

Returns

String[]
The names of the fields which changed value.
\n

Ext.util.Observable
view source

createRelayer( newName, [beginEnd] ) : Functionprivate

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.

Parameters

newName : String
The name under which to refire the passed parameters.
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice.
\n

Returns

Function
\n

Ext.data.Model
view source

destroy( options ) : Ext.data.Model

Destroys the model using the configured proxy. ...

Destroys the model using the configured proxy.

Parameters

options : Object
Options to pass to the proxy. Config object for Ext.data.Operation.
\n

Returns

Ext.data.Model
The Model instance
\n

Overrides: Ext.Base.destroy

Ext.util.Observable
view source

enableBubble( eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...

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

\n\n

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

\n\n

Example:

\n\n

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

Parameters

eventNames : String/String[]
The event name to bubble, or an Array of event names.
\n

Ext.data.Model
view source

endEdit( [silent], [modifiedFieldNames] )

Ends an edit. ...

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

Parameters

silent : Boolean (optional)
True to not notify the store of the change
\n
modifiedFieldNames : String[] (optional)
Array of field names changed during edit.
\n

Ext.util.Observable
view source

fireEvent( eventName, args ) : Boolean

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

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

\n\n

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

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

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

Ext.util.Observable
view source

fireEventArgs( eventName, args ) : Boolean

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

Fires the specified event with the passed parameter list.

\n\n

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

Parameters

eventName : String
The name of the event to fire.
\n
args : Object[]
An array of parameters which are passed to handlers.
\n

Returns

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

Ext.data.Model
view source

get( fieldName ) : Object

Returns the value of the given field ...

Returns the value of the given field

Parameters

fieldName : String
The field to fetch the value for
\n

Returns

Object
The value
\n

Ext.data.Model
view source

getAssociatedData( ) : Object

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\nUser which hasMany Orders, and each Order hasMany OrderItems, it will return an object like this:

\n\n

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

Returns

Object
The nested data set for the Model's loaded associations
\n

Ext.util.Observable
view source

getBubbleParent( ) : Ext.util.Observableprivate

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Ext.util.Observable
The bubble parent. null is returned if no bubble target exists
\n

Ext.data.Model
view source

getChanges( ) : 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.

Returns

Object
\n

Ext.Base
view source

getConfig( name )private

...

Parameters

name : Object
\n

Ext.data.Model
view source

getData( includeAssociated ) : Object

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

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

Parameters

includeAssociated : Boolean
True to also include associated data. Defaults to false.
\n

Returns

Object
An object hash containing all the values in this model
\n

Ext.data.Model
view source

getId( ) : 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.

Returns

Number/String
The id
\n

Ext.Base
view source

getInitialConfig( [name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

Ext.data.Model
view source

getModifiedFieldNames( [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

Parameters

saved : Object (optional)
The currently saved data. Defaults to\nthe dataSave property on the object.
\n

Returns

String[]
An array of modified field names
\n

Ext.data.Model
view source

getObservableId( )private

...

Ext.data.Model
view source

getProxy( ) : Ext.data.proxy.Proxy

Returns the configured Proxy for this Model. ...

Returns the configured Proxy for this Model.

Returns

Ext.data.proxy.Proxy
The proxy
\n

Ext.Base
view source

hasConfig( config )private

...

Parameters

config : Object
\n

Ext.data.Model
view source

hasId( [id] ) : Booleanprivate

Checks if this model has an id assigned ...

Checks if this model has an id assigned

Parameters

id : Object (optional)
The id, if not passed it will call getId()
\n

Returns

Boolean
True if the model has an id
\n

Ext.util.Observable
view source

hasListener( eventName ) : Boolean

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\nindicates whether the event needs firing or not.

Parameters

eventName : String
The name of the event to check for
\n

Returns

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

Ext.Base
view source

initConfig( config ) : Ext.Basechainableprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

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

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

Ext.data.Model
view source

isEqual( a, b ) : Booleanprivate

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

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

Parameters

a : Object
The first value
\n
b : Object
The second value
\n

Returns

Boolean
True if the values are equal
\n

Ext.data.Model
view source

isModified( fieldName ) : Boolean

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

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

Parameters

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

Returns

Boolean
\n

Ext.data.Model
view source

isValid( ) : Boolean

Checks if the model is valid. ...

Checks if the model is valid. See validate.

Returns

Boolean
True if the model is valid.
\n

Ext.data.Model
view source

itemNameFn( item )private

...

Parameters

item : Object
\n

Ext.data.Model
view source

join( 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.

Parameters

store : Ext.data.Store
The store to which this model has been added.
\n

Ext.data.Model
view source

markDirty( )private

...

Ext.util.Observable
view source

mon( item, ename, [fn], [scope], [options] ) : Object

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

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

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
options : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Returns

Object

Only when the destroyable option is specified.

\n\n\n\n\n

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

\n\n\n\n\n

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

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

Ext.util.Observable
view source

mun( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

Ext.util.Observable
view source

on( eventName, [fn], [scope], [options] ) : Object

Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n

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

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

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

\n\n

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

\n\n

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

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n
- 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.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Returns

Object

Only when the destroyable option is specified.

\n\n\n\n\n

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

\n\n\n\n\n

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

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

Ext.data.Model
view source

onClassExtended( cls, data, hooks )private

...

Parameters

cls : Object
\n
data : Object
\n
hooks : Object
\n

Ext.Base
view source

onConfigUpdate( names, callback, scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

Ext.data.Model
view source

prepareAssociatedData( seenKeys, depth ) : Objectprivate

This complex-looking method takes a given Model instance and returns an object containing all data from\nall of that M...

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

Parameters

seenKeys : Object
A hash of all the associations we've already seen
\n
depth : Number
The current depth
\n

Returns

Object
The nested data set for the Model's loaded associations
\n

Ext.util.Observable
view source

prepareClass( T )private

Prepares a given class for observable instances. ...

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

Parameters

T : Function
The class constructor to prepare.
\n

Ext.data.Model
view source

reject( [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\nall changes made to the model instance since either creation, or the last commit operation. Modified fields are\nreverted to their original values.

\n\n

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

Parameters

silent : Boolean (optional)
True to skip notification of the owning store of the change.\nDefaults to false.
\n

Ext.util.Observable
view source

relayEvents( origin, events, [prefix] ) : Object

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.

\n\n

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

\n\n

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

\n\n

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

Parameters

origin : Object
The Observable whose events this object is to relay.
\n
events : String[]
Array of event names to relay.
\n
prefix : String (optional)
A common prefix to prepend to the event names. For example:
\n\n
```
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
\n

Returns

Object
A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:
\n\n
```
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Can be undone by calling
\n\n
```
Ext.destroy(this.storeRelayers);\n
```
\n\n
or
\n\n
```
this.store.relayers.destroy();\n
```
\n

Ext.util.Observable
view source

removeListener( eventName, fn, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

Ext.util.Observable
view source

removeManagedListener( item, ename, [fn], [scope] )

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

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

Ext.util.Observable
view source

removeManagedListenerItem( isClear, managedListener )private

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

isClear : Boolean
True if this is being called during a clear
\n
managedListener : Object
The managed listener item\nSee removeManagedListener for other args
\n

Ext.util.Observable
view source

resumeEvent( eventName )

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

Resumes firing of the named event(s).

\n\n

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

\n\n

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

Parameters

eventName : String...
Multiple event names to resume.
\n

Ext.util.Observable
view source

resumeEvents( )

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

If events were suspended using the queueSuspended parameter, then all events fired\nduring event suspension will be sent to any listeners now.

Ext.data.Model
view source

save( [options] ) : Ext.data.Model

Saves the model instance using the configured proxy. ...

Saves the model instance using the configured proxy.

Parameters

options : Object (optional)
Options to pass to the proxy. Config object for Ext.data.Operation.
\n

Returns

Ext.data.Model
The Model instance
\n

Ext.data.Model
view source

set( 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

Parameters

fieldName : String/Object
The field to set, or an object containing key/value pairs
\n
newValue : Object
The value to set
\n

Returns

String[]
The array of modified field names or null if nothing was modified.
\n

Ext.Base
view source

setConfig( config, applyIfNotSet ) : Ext.Basechainableprivate

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Returns

Ext.Base
this
\n

Ext.data.Model
view source

setDirty( )

Marks this Record as dirty. ...

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

\n\n

Marking a record dirty causes the phantom to be returned by Ext.data.Store.getUpdatedRecords\nwhere it will have a create action composed for it during model save operations.

Ext.data.Model
view source

setId( id )

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

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

Parameters

id : Number/String
The new id
\n

Ext.data.Model
view source

setProxy( 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\nExt.createByAlias.

Parameters

proxy : String/Object/Ext.data.proxy.Proxy
The proxy
\n

Returns

Ext.data.proxy.Proxy
\n

Ext.Base
view source

statics( ) : Ext.Classprotected

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,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

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

Returns

Ext.Class
\n

Ext.util.Observable
view source

suspendEvent( eventName )

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

Suspends firing of the named event(s).

\n\n

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

\n\n

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

Parameters

eventName : String...
Multiple event names to suspend.
\n

Ext.util.Observable
view source

suspendEvents( queueSuspended )

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n

Ext.util.Observable
view source

un( eventName, fn, [scope] )

Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

Ext.data.Model
view source

unjoin( 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.

Parameters

store : Ext.data.Store
The store from which this model has been removed.
\n

Ext.data.Model
view source

validate( ) : Ext.data.Errors

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

Validates the current data against all of its configured validations.

Returns

Ext.data.Errors
The errors object
\n

Defined By

Static Methods

Ext.Base
view source

addConfig( config )privatestatic

...

Parameters

config : Object
\n

Ext.Base
view source

addInheritableStatics( members )chainableprivatestatic

...

Parameters

members : Object
\n

Ext.Base
view source

addMember( name, member )chainableprivatestatic

...

Parameters

name : Object
\n
member : Object
\n

Ext.Base
view source

addMembers( members )chainablestatic

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

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

Parameters

members : Object
\n

Ext.Base
view source

addStatics( members ) : Ext.Basechainablestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

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

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

addXtype( xtype )chainableprivatestatic

...

Parameters

xtype : Object
\n

Ext.Base
view source

borrow( fromClass, members ) : Ext.Basechainableprivatestatic

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

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

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

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

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

Ext.Base
view source

createAlias( alias, origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

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

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

Ext.Base
view source

extend( config )privatestatic

...

Parameters

config : Object
\n

Ext.data.Model
view source

getFields( ) : Ext.data.Field[]static

Returns an Array of Field definitions which define this Model's structure\n\nFields are sorted upon Model class definit...

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

\n\n

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

Returns

Ext.data.Field[]
The defined Fields for this Model.
\n

Ext.Base
view source

getName( ) : Stringstatic

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

Get the current class' name in string format.

\n\n

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

Returns

String
className
\n

Ext.data.Model
view source

getProxy( ) : Ext.data.proxy.Proxystatic

Returns the configured Proxy for this Model ...

Returns the configured Proxy for this Model

Returns

Ext.data.proxy.Proxy
The proxy
\n

Ext.data.Model
view source

id( 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\nin the passed data. The generated id will automatically be assigned to the\nrecord. The returned id takes the form: {PREFIX}-{AUTO_ID}.

\n\n

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

\n\n

Parameters

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

Returns

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

Ext.Base
view source

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

Ext.data.Model
view source

load( id, [config] )static

Asynchronously loads a model instance by id. ...

Asynchronously loads a model instance by id. Sample usage:

\n\n

Ext.define('MyApp.User', {\n    extend: 'Ext.data.Model',\n    fields: [\n        {name: 'id', type: 'int'},\n        {name: 'name', type: 'string'}\n    ]\n});\n\nMyApp.User.load(10, {\n    scope: this,\n    failure: function(record, operation) {\n        //do something if the load failed\n        //record is null\n    },\n    success: function(record, operation) {\n        //do something if the load succeeded\n    },\n    callback: function(record, operation, success) {\n        //do something whether the load succeeded or failed\n        //if operation is unsuccessful, record is null\n    }\n});\n

Parameters

id : Number/String
The id of the model to load
\n
config : Object (optional)
config object containing success, failure and callback functions, plus\noptional scope
\n

Ext.Base
view source

mixin( name, mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

Ext.Base
view source

onExtended( fn, scope )chainableprivatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

Ext.Base
view source

override( members ) : Ext.Basechainabledeprecatedstatic

Override members of this class. ...

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

\n\n

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

\n\n

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

\n\n

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

\n\n

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

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n

Ext.data.Model
view source

setFields( 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\nfields, including fields inherited from superclasses. Mainly for reconfiguring the\nmodel based on changes in meta data (called from Reader's onMetaChange method).