Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext JS 7.8.0 - Classic Toolkit


top

Summary

The default implementation for am event model. All fields are accessed via the getter/setter API to allow for custom model implementations.

Fields

The following fields are provided:

Events read / write the time stamp in UTC format. The time zone should be GMT. The timezone offset for the local computer is used when rendering the event on the calendar view. A different timezone offset can be specified using the view's timezoneOffset config option.

Sample Response

Below is a sample response from a remote source providing a single event for a source calendar with an id of 1:

[{
    "id": 1001,
    "calendarId": 1,
    "startDate": "2016-09-30T21:30:00.000Z",
    "endDate": "2016-09-30T22:30:00.000Z",
    "title": "Watch cartoons",
    "description": "Catch up with adventurers Finn and Jake"
}]

Sample response for the same source calendar with an all day event on Sept. 30th 2016

[{
    "id": 1001,
    "calendarId": 1,
    "startDate": "2016-09-30T00:00:00.000Z",
    "endDate": "2016-10-01T00:00:00.000Z",
    "allDay": true,
    "title": "Netflix Binge",
    "description": "Watch Luke Cage.  Maybe twice."
}]

Note: The "id"s for all events must be unique within a calendar store across all event stores. Duplicate "id"s even across event stores may result in unintended consequences.

Custom Data

While the Event model fields may not be set on a user-defined model, custom data can easily be accommodated by extending the Event model and modifying the associated getter / setter methods.

For example, let's assume your events server provides the description as "desc". The response from the server would look like:

[{
    "id": 1001,
    "calendarId": 1,
    "startDate": "2016-09-30T21:30:00.000Z",
    "endDate": "2016-09-30T22:30:00.000Z",
    "title": "Demo starter app",
    "desc": "Demonstrate the starter app to project management"
}]

Internally what is used to read and write the description is getDescription and setDescription. By default those will be looking for the description string to be on the description field. To have our model work with the desc data instead the derived model would look like:

Ext.define('MyApp.model.Event', {
    extend: 'Ext.calendar.model.Event',

    getDescription: function () {
        return this.data.desc;
    },
    setDescription: function (description) {
        this.set('desc', description);
    }
});

The model can then be specified on the Events store config:

Ext.create({
    xtype: 'calendar',
    renderTo: Ext.getBody(),
    height: 400,
    width: 600,
    store: {
        autoLoad: true,
        proxy: {
            type: 'ajax',
            url: 'calendars.php'
        },
        eventStoreDefaults: {
            model: 'MyApp.model.Event',
            proxy: {
                type: 'ajax',
                url: 'events.php'
            }
        }
    }
});

The calendar makes no assumptions about the structure of the data provided, only that it exists. This abstraction of data access ensures flexibility for a wide range of data structures to be used.

As an example of this concept, the default Event model has a startDate and endDate field. The method-getDuration method is calculated based on these values. Another possible implementation could be to have a startDate and duration field on the model and have the getEndDate be a calculated quantity. The API makes no distinction here, as long as the EventBase interface is fulfilled.

No members found using the current filters

configs

Optional Configs

associations : Object[]
deprecated dep

An array of Ext.data.schema.Association for this model.

For further documentation, see Ext.data.schema.Association.

Deprecated since version 6.2.0
Use `hasMany/hasOne/belongsTo`.

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

One or more Ext.data.schema.BelongsTo associations for this model.

clientIdProperty : String

The name of the property a server will use to send back a client-generated id in a create or update Ext.data.operation.Operation.

If specified, this property cannot have the same name as any other field.

For example:

 Ext.define('Person', {
     idProperty: 'id',  // this is the default value (for clarity)

     clientIdProperty: 'clientId',

     identifier: 'negative', // to generate -1, -2 etc on the client

     fields: [ 'name' ]
 });

 var person = new Person({
     // no id provided, so -1 is generated
     name: 'Clark Kent'
 });

The server is given this data during the create:

 {
     id: -1,
     name: 'Clark Kent'
 }

The server allocates a real id and responds like so:

 {
     id: 427,
     clientId: -1
 }

This property is most useful when creating multiple entities in a single call to the server in a Ext.data.operation.Create. Alternatively, the server could respond with records that correspond one-to-one to those sent in the operation.

For example the client could send a create with this data:

 [ { id: -1, name: 'Clark Kent' },
   { id: -2, name: 'Peter Parker' },
   { id: -3, name: 'Bruce Banner' } ]

And the server could respond in the same order:

 [ { id: 427 },      // updates id = -1
   { id: 428 },      // updates id = -2
   { id: 429 } ]     // updates id = -3

Or using clientIdProperty the server could respond in arbitrary order:

 [ { id: 427, clientId: -3 },
   { id: 428, clientId: -1 },
   { id: 429, clientId: -2 } ]

IMPORTANT: When upgrading from previous versions be aware that this property used to perform the role of Ext.data.writer.Writer#clientIdProperty as well as that described above. To continue send a client-generated id as other than the idProperty, set clientIdProperty on the writer. A better solution, however, is most likely a properly configured identifier as that would work better with associations.

Defaults to:

null

convertOnSet : Boolean

Set to false to prevent any converters from being called on fields specified in a set operation.

Note: Setting the config to false will only prevent the convert / calculate call when the set fieldName param matches the field's name. In the following example the calls to set salary will not execute the convert method on set while the calls to set vested will execute the convert method on the initial read as well as on set.

Example model definition:

Ext.define('MyApp.model.Employee', {
    extend: 'Ext.data.Model',
    fields: ['yearsOfService', {
        name: 'salary',
        convert: function (val) {
            var startingBonus = val * .1;
            return val + startingBonus;
        }
    }, {
        name: 'vested',
        convert: function (val, record) {
            return record.get('yearsOfService') >= 4;
        },
        depends: 'yearsOfService'
    }],
    convertOnSet: false
});

var tina = Ext.create('MyApp.model.Employee', {
    salary: 50000,
    yearsOfService: 3
});

console.log(tina.get('salary')); // logs 55000
console.log(tina.get('vested')); // logs false

tina.set({
    salary: 60000,
    yearsOfService: 4
});
console.log(tina.get('salary')); // logs 60000
console.log(tina.get('vested')); // logs true

Defaults to:

true

fields : Object[] / String[]

An Array of Ext.data.field.Field config objects, simply the field name, or a mix of config objects and strings. If just a name is given, the field type defaults to auto.

In a Ext.data.field.Field config object you may pass the alias of the Ext.data.field.* type using the type config option.

// two fields are set:
// - an 'auto' field with a name of 'firstName'
// - and an Ext.data.field.Integer field with a name of 'age'
fields: ['firstName', {
    type: 'int',
    name: 'age'
}]

Fields will automatically be created at read time for any for any keys in the data passed to the Model's proxy's Ext.data.reader.Reader whose name is not explicitly configured in the fields config.

Extending a Model class will inherit all the fields from the superclass / ancestor classes.

getFields Ext.data.field.Field[]

Get the fields array for this model.

Returns

:Ext.data.field.Field[]

The fields array

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

One or more Ext.data.schema.HasMany associations for this model.

hasOne : String / Object / String[] / Object[]

One or more Ext.data.schema.HasOne associations for this model.

identifier : String / Object

The id generator to use for this model. The identifier generates values for the idProperty when no value is given. Records with client-side generated values for idProperty are called phantom records since they are not yet known to the server.

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.identifier.Sequential'],
     identifier: 'sequential',
     ...
 });

The above would generate Ext.data.identifier.Sequential id's such as 1, 2, 3 etc..

Another useful id generator is Ext.data.identifier.Uuid:

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

An id generator can also be further configured:

 Ext.define('MyApp.data.MyModel', {
     extend: 'Ext.data.Model',
     identifier: {
         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',
     identifier: {
         type: 'sequential',
         id: 'xy'
     }
 });

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

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

Defaults to:

null

idProperty : String

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

If changing the idProperty in a subclass, the generated id field will replace the one generated by the superclass, for example;

 Ext.define('Super', {
     extend: 'Ext.data.Model',
     fields: ['name']
 });

 Ext.define('Sub', {
     extend: 'Super',
     idProperty: 'customId'
 });

 var fields = Super.getFields();
 // Has 2 fields, "name" & "id"
 console.log(fields[0].name, fields[1].name, fields.length);

 fields = Sub.getFields();
 // Has 2 fields, "name" & "customId", "id" is replaced
 console.log(fields[0].name, fields[1].name, fields.length);

The data values for this field must be unique or there will be id value collisions in the Ext.data.Store.

Defaults to:

'id'

getIdProperty String

Get the idProperty for this model.

Returns

:String

The idProperty

manyToMany : Object

A config object for a Ext.data.schema.ManyToMany association. See the class description for Ext.data.schema.ManyToMany for configuration examples.

Defaults to:

null

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

The Ext.data.proxy.Proxy to use for this class.

By default, the proxy is configured from the Ext.data.schema.Schema. You can ignore the schema defaults by setting schema: false on the proxy config.

 Ext.define('MyApp.data.CustomProxy', {
     extend: 'Ext.data.proxy.Ajax',
     alias: 'proxy.customproxy',

     url: 'users.json'
 });

 Ext.define('MyApp.models.CustomModel', {
     extend: 'Ext.data.Model',

     fields: ['name'],
     proxy: {
         type: 'customproxy,
         schema: false
     }
 });

With schema: false, the url of the proxy will be used instead of what has been defined on the schema.

Defaults to:

undefined

getProxy Ext.data.proxy.Proxy

Returns the configured Proxy for this Model.

Returns

:Ext.data.proxy.Proxy

The proxy

schema : String / Object

The name of the Ext.data.schema.Schema to which this entity and its associations belong. For details on custom schemas see Ext.data.schema.Schema.

Defaults to:

'default'

summary : Object

Summary fields are a special kind of field that is used to assist in creating an aggregation for this model. A new model type that extends this model will be created, accessible via getSummaryModel. This summary model will have these virtual aggregate fields in the fields collection like a normal model. Each key in the object is the field name. The value for each field should mirror the cfg-fields, excluding the name option. The summary model generated will have 2 fields, 'rate', which will aggregate using an average and maxRate, which will aggregate using the maximum value.

See Ext.data.summary.Base for more information.

 Ext.define('User', {
     extend: 'Ext.data.Model',
     fields: [{
         name: 'rate',
         summary: 'avg'
     }],

     summary: {
         maxRate: {
             field: 'rate', // calculated from rate field
             summary: 'max'
         }
     }
 });

Defaults to:

null

Available since: 6.5.0

validationSeparator : String

If specified this property is used to concatenate multiple errors for each field as reported by the validators.

Defaults to:

null

versionProperty : String

If specified, this is the name of the property that contains the entity "version". The version property is used to manage a long-running transaction and allows the detection of simultaneous modification.

The way a version property is used is that the client receives the version as it would any other entity property. When saving an entity, this property is always included in the request and the server uses the value in a "conditional update". If the current version of the entity on the server matches the version property sent by the client, the update is allowed. Otherwise, the update fails.

On successful update, both the client and server increment the version. This is done on the server in the conditional update and on the client when it receives a success on its update request.

Defaults to:

null

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of false stores config values as properties using their exact name (no prefix).

Defaults to:

true

Available since: 5.0.0

$configStrict : Boolean
private pri

The value true instructs the initConfig method to only honor values for properties declared in the config block of a class. When false, properties that are not declared in a config block will be placed on the instance.

Defaults to:

true

Available since: 5.0.0

$configTransforms : Object / Array
private pri

A prototype-chained object storing transform method names and priorities stored on the class prototype. On first instantiation, this object is converted into an array that is sorted by priority and stored on the constructor.

Defaults to:

{}

clearPropertiesOnDestroy : Boolean / "async"
protected pro

Setting this property to false will prevent nulling object references on a Class instance after destruction. Setting this to "async" will delay the clearing for approx 50ms.

Defaults to:

true

Available since: 6.2.0

clearPrototypeOnDestroy : Boolean
private pri

Setting this property to true will result in setting the object's prototype to null after the destruction sequence is fully completed. After that, most attempts at calling methods on the object instance will result in "method not defined" exception. This can be very helpful with tracking down otherwise hard to find bugs like runaway Ajax requests, timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support Object.setPrototypeOf method, and is only available in debugging mode.

Defaults to:

false

Available since: 6.2.0

crudState : "C" / "R" / "U" / "D"
readonly ro protected pro

This value is initially "R" or "C" indicating the initial CRUD state. As the record changes and the various joined parties (stores, sessions, etc.) are notified this value is updated prior to these calls. In other words, the joined parties are notified after the crudState is updated. This means that the crudState property may be briefly out of sync with underlying changes if this state is used outside of these notifications.

The possible states have these meanings:

  • "R" - The record is in a cleanly retrieved (unmodified) state.
  • "C" - The record is in a newly created (phantom) state.
  • "U" - The record is in an updated, modified (dirty) state.
  • "D" - The record is in a dropped state.

Defaults to:

'R'

Available since: 6.2.0

crudStateWas : "C" / "R" / "U" / "D"
readonly ro protected pro

This value is initially null indicating there is no previous CRUD state. As the record changes and the various joined parties (stores, sessions, etc.) are notified this value is updated for the subsequent calls. In other words, the joined parties are notified and then crudStateWas is modified for the next update.

The value of this property has the same meaning as crudState.

Defaults to:

null

Available since: 6.2.0

destroyed : Boolean

This property is set to true after the destroy method is called.

Defaults to:

false

dirty : Boolean
readonly ro

True if this record has been modified.

Defaults to:

false

dropped : Boolean
readonly ro

True if this record is pending delete on the server. This is set by the drop method and transmitted to the server by the save method.

Defaults to:

false

editing : Boolean
readonly ro

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

Defaults to:

false

entityName : String

The short name of this entity class. This name is derived from the namespace of the associated schema and this class name. By default, a class is not given a shortened name.

All entities in a given schema must have a unique entityName.

For more details see "Relative Naming" in Ext.data.schema.Schema.

erased : Boolean
readonly ro

True if this record has been erased on the server. This flag is set of the erase method.

Defaults to:

false

fieldOrdinals : Object
readonly ro private pri

This property is indexed by field name and contains the ordinal of that field. The ordinal often has meaning to servers and is derived based on the position in the fields array.

This can be used like so:

 Ext.define('MyApp.models.User', {
     extend: 'Ext.data.Model',

     fields: [
         { name: 'name' }
     ]
 });

 var nameOrdinal = MyApp.models.User.fieldOrdinals.name;

 // or, if you have an instance:

 var user = new MyApp.models.User();
 var nameOrdinal = user.fieldOrdinals.name;

fields : Ext.data.field.Field[]
readonly ro private pri

An array fields defined for this Model (including fields defined in superclasses) in ordinal order; that is in declaration order.

generation : Number
readonly ro

This property is incremented on each modification of a record.

Defaults to:

1

Available since: 5.0.0

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isEntity : Boolean
readonly ro

The value true to identify this class and its subclasses.

Defaults to:

true

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

isModel : Boolean
readonly ro

The value true to identify this class and its subclasses.

Defaults to:

true

modified : Object

A hash of field values which holds the initial values of fields before a set of edits are committed.

phantom : Boolean

True when the record does not yet exist in a server-side database. Any record which has a real database identity set as its idProperty is NOT a phantom -- it's real.

Defaults to:

false

previousValues : Object
readonly ro private pri

This object is similar to the modified object except it holds the data values as they were prior to the most recent change.

Defaults to:

undefined

schema : Ext.data.schema.Schema
readonly ro

The Ext.data.schema.Schema to which this entity and its associations belong.

Defaults to:

'default'

self : Ext.Class
protected pro

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#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'

Defaults to:

Base

session : Ext.data.Session
readonly ro

The Ext.data.Session for this record.

Defaults to:

null

store : Ext.data.Store

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

Note: If this instance is bound to multiple stores, this property will reference only the first.

Defaults to:

owner

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

_associatedReadOptions : Object
static sta private pri

The options for the proxy reader for loadData.

Defaults to:

{
    recordsOnly: true,
    asRoot: true
}

methods

Instance Methods

abort

Aborts a pending load operation. If the record is not loading, this does nothing.

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

beginEdit

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.

calculateSummary ( records )

Calculate all summary fields on this record.

Available since: 6.5.0

Parameters

records :  Ext.data.Model[]

The records to use for calculation.

callJoined ( funcName, [args] )
private pri

Helper function used by afterEdit, afterReject and afterCommit. Calls the given method on the Ext.data.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.

Parameters

funcName :  String

The name function to call on each store.

args :  Array (optional)

The arguments to pass to the method. This instance is always inserted as the first argument.

callOverridden ( args ) : Object
deprecated dep protected pro

Call the original method that was previously overridden with Ext.Base#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"

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

Deprecated since version 4.1.0
Use method-callParent instead.

callParent ( args ) : Object
protected pro

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 and private methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     // privates: {
     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',

     // privates: {
     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 method-callSuper. 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 from the current method, for example: this.callParent(arguments)

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

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', {
     extend: 'Ext.some.Class',

     method: function() {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

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

 Ext.define('App.patches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function() {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use method-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".

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

cancelEdit

Cancels all changes made in the current edit operation.

clone ( [session] ) : Ext.data.Model

Creates a clone of this record. States like dropped, phantom and dirty are all preserved in the cloned record.

Parameters

session :  Ext.data.Session (optional)

The session to which the new record belongs.

Returns

:Ext.data.Model

The cloned record.

commit ( [silent], [modifiedFieldNames] )

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#event-update event to have their code notified of commit operations.

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.

containsRange ( start, end ) : Boolean

Checks if this event fully contains a date range.

Parameters

start :  Ext.calendar.date.Range/Date

The range, or the start date.

end :  Date

The end date. This is not required if a range is passed for start.

Returns

:Boolean

true if this event contains a date range.

copy ( [newId], [session] ) : Ext.data.Model

Creates a clean copy of this record. The returned record will not consider any its fields as modified.

To generate a phantom instance with a new id pass null:

var rec = record.copy(null); // clone the record but no id (one is generated)

Parameters

newId :  String (optional)

A new id, defaults to the id of the instance being copied. See idProperty.

session :  Ext.data.Session (optional)

The session to which the new record belongs.

Returns

:Ext.data.Model

copyFrom ( sourceRecord ) : String[]
private pri

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.

Parameters

sourceRecord :  Ext.data.Model

The record to copy data from.

Returns

:String[]

The names of the fields which changed value.

destroy

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further in any way, including access to its methods and properties.

To prevent potential memory leaks, all object references will be nulled at the end of destruction sequence, unless clearPropertiesOnDestroy is set to false.

destroyMembers ( args )

Destroys member properties by name.

If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.

The property will be destroyed, and the corrected name (if the property is a config and config names are prefixed) will set to null in this object's dictionary.

Parameters

args :  String...

One or more names of the properties to destroy and remove from the object.

drop ( [cascade] )

Marks this record as dropped and waiting to be deleted on the server. When a record is dropped, it is automatically removed from all association stores and any child records associated to this record are also dropped (a "cascade delete") depending on the cascade parameter.

Available since: 5.0.0

Parameters

cascade :  Boolean (optional)

Pass false to disable the cascade to drop child records.

Defaults to: true

endEdit ( [silent], [modifiedFieldNames] )

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

Parameters

silent :  Boolean (optional)

True to not notify any stores of the change.

modifiedFieldNames :  String[] (optional)

Array of field names changed during edit.

erase ( options ) : Ext.data.operation.Destroy

Destroys the model using the configured proxy. The erase action is asynchronous. Any processing of the erased record should be done in a callback.

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

var user = new MyApp.model.User({
    name: 'Foo'
});

// pass the phantom record data to the server to be saved
user.save({
    success: function(record, operation) {
        // do something if the save succeeded
        // erase the created record
        record.erase({
            failure: function(record, operation) {
                // do something if the erase failed
            },
            success: function(record, operation) {
                // do something if the erase succeeded
            },
            callback: function(record, operation, success) {
                // do something if the erase succeeded or failed
            }
        });
    }
});

NOTE: If a phantom record is erased it will not be processed via the proxy. However, any passed success or callback functions will be called.

The options param is an Ext.data.operation.Destroy config object containing success, failure and callback functions, plus optional scope.

Parameters

options :  Object

Options to pass to the proxy.

Returns

:Ext.data.operation.Destroy

The destroy operation

get ( fieldName ) : Object

Returns the value of the given field.

Parameters

fieldName :  String

The name of the field.

Returns

:Object

The value of the specified field.

getAllDay Boolean
abstract abs

Gets whether this event is an all day event.

Returns

:Boolean

true if this is an all day event.

getAssociatedData ( [result], [options] ) : Object

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

Parameters

result :  Object (optional)

The object on to which the associations will be added. If no object is passed one is created. This object is then returned.

options :  Boolean/Object (optional)

An object containing options describing the data desired.

associated :  Boolean (optional)

Pass true to include associated data from other associated records.

Defaults to:

true

changes :  Boolean (optional)

Pass true to only include fields that have been modified. Note that field modifications are only tracked for fields that are not declared with persist set to false. In other words, only persistent fields have changes tracked so passing true for this means options.persist is redundant.

Defaults to:

false

critical :  Boolean (optional)

Pass true to include fields set as critical. This is only meaningful when options.changes is true since critical fields may not have been modified.

persist :  Boolean (optional)

Pass true to only return persistent fields. This is implied when options.changes is set to true.

serialize :  Boolean (optional)

Pass true to invoke the serialize method on the returned fields.

Defaults to:

false

Returns

:Object

The nested data set for the Model's loaded associations.

getCalendar Ext.calendar.model.Calendar

Get the calendar for this event.

Returns

:Ext.calendar.model.Calendar

The calendar, null if it does not exist.

getCalendarId Object
abstract abs

Get the id for the calendar this event belongs to.

Returns

:Object

The id.

getChanges Object

Gets an object of only the fields that have been modified since this record was created or committed. Only persistent fields are tracked in the modified set so this method will only return changes to persistent fields.

For more control over the returned data, see getData.

Returns

:Object

getColor String
abstract abs

Get a specified color for this event.

Returns

:String

The color.

getConfig ( [name], [peek], [ifInitialized] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

true to peek at the raw value without calling the getter.

Defaults to: false

ifInitialized :  Boolean (optional)

true to only return the initialized property value, not the raw config value, and not to trigger initialization. Returns undefined if the property has not yet been initialized.

Defaults to: false

Returns

:Object

The config property value.

getCriticalFields Ext.data.field.Field[]

Returns the array of fields that are declared as critical (must always send).

Returns

:Ext.data.field.Field[]

getData ( [options] ) : Object

Gets all values for each field in this model and returns an object containing the current data. This can be tuned by passing an options object with various properties describing the desired result. Passing true simply returns all fields and all associated record data.

To selectively gather some associated data, the options object can be used as follows:

 var data = order.getData({
     associated: {
         orderItems: true
     }
 });

This will include all data fields as well as an "orderItems" array with the data for each OrderItem. To include the associated Item for each OrderItem, the call would look like:

 var data = order.getData({
     associated: {
         orderItems: {
             item: true
         }
     }
 });

Parameters

options :  Boolean/Object (optional)

An object containing options describing the data desired. If true is passed it is treated as an object with associated set to true.

associated :  Boolean / Object (optional)

Pass true to recursively include all associated data. This is equivalent to pass true as the only argument. See getAssociatedData. If associated is an object, it describes the specific associations to gather.

Defaults to:

false

changes :  Boolean (optional)

Pass true to only include fields that have been modified. Note that field modifications are only tracked for fields that are not declared with persist set to false. In other words, only persistent fields have changes tracked so passing true for this means options.persist is redundant.

Defaults to:

false

critical :  Boolean (optional)

Pass true to include fields set as critical. This is only meaningful when options.changes is true since critical fields may not have been modified.

persist :  Boolean (optional)

Pass true to only return persistent fields. This is implied when options.changes is set to true.

serialize :  Boolean (optional)

Pass true to invoke the serialize method on the returned fields.

Defaults to:

false

Returns

:Object

An object containing all the values in this model.

getDescription String
abstract abs

Gets the description for this event.

Returns

:String

The description.

getDuration Number
abstract abs

Get the duration of this event in minutes.

Returns

:Number

The duration of the event in minutes.

getEndDate Date
abstract abs

Get the end date for this event (including time). The date should be UTC.

Returns

:Date

The end date.

getId Number/String

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

Returns

:Number/String

The id

getInitialConfig ( [name] ) : Object/Mixed

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

Given this example Ext.button.Button definition and instance:

Ext.define('MyApp.view.Button', {
    extend: 'Ext.button.Button',
    xtype: 'mybutton',

    scale: 'large',
    enableToggle: true
});

var btn = Ext.create({
    xtype: 'mybutton',
    renderTo: Ext.getBody(),
    text: 'Test Button'
});

Calling btn.getInitialConfig() would return an object including the config options passed to the create method:

xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'

Calling btn.getInitialConfig('text')returns 'Test Button'.

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.

getModified ( fieldName ) : Object

Returns the original value of a modified field. If there is no modified value, undefined will be return. Also see isModified.

Parameters

fieldName :  String

The name of the field for which to return the original value.

Returns

:Object

modified

getModifiedFieldNames ( [old] ) : String[]
private pri

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

Parameters

old :  Object (optional)

The saved data from beginEdit.

Returns

:String[]

The array of modified field names.

getObservableId
protected pro

Return a unique observable ID. Model is not observable but tree nodes (Ext.data.NodeInterface) are, so they must be globally unique within the observableType.

getPrevious ( fieldName ) : Object

This method returns the value of a field given its name prior to its most recent change.

Parameters

fieldName :  String

The field's name.

Returns

:Object

The value of the given field prior to its current value. undefined if there is no previous value;

getRange Ext.calendar.date.Range

Gets a range for this event,

Returns

:Ext.calendar.date.Range

The range.

getStartDate Date
abstract abs

Get the start date for this event (including time). The date should be UTC.

Returns

:Date

The start date.

getTitle String
abstract abs

Get the title for this event.

Returns

:String

The title.

getTransientFields Ext.data.field.Field[]

Returns the array of fields that are declared as non-persist or "transient".

Available since: 5.0.0

Returns

:Ext.data.field.Field[]

getValidation ( [refresh] ) : Ext.data.Validation

Returns the Ext.data.Validation record holding the results of this record's validators. This record is lazily created on first request and is then kept on this record to be updated later.

See the class description for more about validators.

Available since: 5.0.0

Parameters

refresh :  Boolean (optional)

Pass false to not call the refresh method on the validation instance prior to returning it. Pass true to force a refresh of the validation instance. By default the returned record is only refreshed if changes have been made to this record.

Returns

:Ext.data.Validation

The Validation record for this record.

hasConfig ( name )
private pri

Parameters

name :  String

hasPendingLoad Boolean
private pri

Currently this only checks the loading state, this method exists for API parity with stores.

Returns

:Boolean

true if the model is loading or has a pending load.

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

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'

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

isContainedByRange ( start, end ) : Boolean

Checks if this event is fully contained by the passed range.

Parameters

start :  Ext.calendar.date.Range/Date

The range, or the start date.

end :  Date

The end date. This is not required if a range is passed for start.

Returns

:Boolean

true if this event is fully contained by the passed range.

isDirty Boolean
private pri

Gets the dirty state of this record.

Returns

:Boolean

The dirty state.

isEditable
abstract abs

Checks if this event is editable. This means that it can be removed or modified via the UI.

isEqual ( lhs, rhs, [field] ) : Boolean
private pri

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

Parameters

lhs :  Object

The first value.

rhs :  Object

The second value.

field :  String/Ext.data.field.Field (optional)

The field name or instance.

Returns

:Boolean

True if the values are equal.

isLoading Boolean

Checks whether this model is loading data from the proxy.

Returns

:Boolean

true if in a loading state.

isModified ( fieldName ) : Boolean

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

Parameters

fieldName :  String

The field's name.

Returns

:Boolean

isPhantom Boolean
private pri

Gets the phantom state of this record.

Returns

:Boolean

The phantom state.

isSpan Boolean

Checks whether this event spans a full day or more.

Returns

:Boolean

true if the event is an all day event or spans over 24 hours or more.

isValid Boolean

Checks if the model is valid. See getValidation.

Returns

:Boolean

True if the model is valid.

join ( owner )

Tells this model instance that an observer is looking at it.

Parameters

owner :  Ext.data.Store

The store or other owner object to which this model has been added.

load ( [options] ) : Ext.data.operation.Read

Loads the model instance using the configured proxy. The load action is asynchronous. Any processing of the loaded record should be done in a callback.

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

var user = new MyApp.model.User();
user.load({
    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, success) {
        // do something whether the load succeeded or failed
    }
});

The options param is an Ext.data.operation.Read config object containing success, failure and callback functions, plus optional scope.

Parameters

options :  Object (optional)

Options to pass to the proxy.

success :  Function

A function to be called when the model is processed by the proxy successfully. The callback is passed the following parameters:

record :  Ext.data.Model

The record.

operation :  Ext.data.operation.Operation

The operation.

failure :  Function

A function to be called when the model is unable to be processed by the server. The callback is passed the following parameters:

record :  Ext.data.Model

The record.

operation :  Ext.data.operation.Operation

The operation.

callback :  Function

A function to be called whether the proxy transaction was successful or not. The callback is passed the following parameters:

record :  Ext.data.Model

The record.

operation :  Ext.data.operation.Operation

The operation.

success :  Boolean

true if the operation was successful.

scope :  Object

The scope in which to execute the callback functions. Defaults to the model instance.

Returns

:Ext.data.operation.Read

The read operation.

mergeData ( data )
protected pro

Merge incoming data from the server when this record exists in an active session. This method is not called if this record is loaded directly via load. The default behaviour is to use incoming data if the record is not dirty, otherwise the data is discarded. This method should be overridden in subclasses to provide a different behavior.

Available since: 6.5.0

Parameters

data :  Object

The model data retrieved from the server.

occursInRange ( start, end ) : Boolean

Checks if any part of this event occurs within the specified date range.

Parameters

start :  Ext.calendar.date.Range/Date

The range, or the start date.

end :  Date

The end date. This is not required if a range is passed for start.

Returns

:Boolean

true if any part of this events occurs in the range.

onAssociatedRecordSet ( record, role )
private pri

Called when an associated record instance has been set.

Parameters

record :  Ext.data.Model

The record.

role :  Ext.data.schema.Role

The role.

onIdChanged ( id, oldId )

Called when the model id is changed.

Parameters

id :  Object

The new id.

oldId :  Object

The old id.

onLoad
template tpl protected pro

This method is called by the Ext.data.reader.Reader after loading a model from the server. This is after processing any inline associations that are available.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

reject ( [silent] )

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#event-update event to have their code notified of reject operations.

Parameters

silent :  Boolean (optional)

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

Defaults to: false

save ( options ) : Ext.data.operation.Create/Ext.data.operation.Update/Ext.data.operation.Destroy

Saves the model instance using the configured proxy. The save action is asynchronous. Any processing of the saved record should be done in a callback.

Create example:

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

var user = new MyApp.model.User({
    name: 'Foo'
});

// pass the phantom record data to the server to be saved
user.save({
    failure: function(record, operation) {
        // do something if the save failed
    },
    success: function(record, operation) {
        // do something if the save succeeded
    },
    callback: function(record, operation, success) {
        // do something whether the save succeeded or failed
    }
});

The response from a create operation should include the ID for the newly created record:

// sample response
{
    success: true,
    id: 1
}

// the id may be nested if the proxy's reader has a rootProperty config
Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    proxy: {
        type: 'ajax',
        url: 'server.url',
        reader: {
            type: 'ajax',
            rootProperty: 'data'
        }
    }
});

// sample nested response
{
    success: true,
    data: {
        id: 1
    }
}

(Create + ) Update example:

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

var user = new MyApp.model.User({
    name: 'Foo'
});
user.save({
    success: function(record, operation) {
        record.set('name', 'Bar');
        // updates the remote record via the proxy
        record.save();
    }
});

(Create + ) Destroy example - see also erase:

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

var user = new MyApp.model.User({
    name: 'Foo'
});
user.save({
    success: function(record, operation) {
        record.drop();
        // destroys the remote record via the proxy
        record.save();
    }
});

NOTE: If a phantom record is dropped and subsequently saved it will not be processed via the proxy. However, any passed success or callback functions will be called.

The options param is an Operation config object containing success, failure and callback functions, plus optional scope. The type of Operation depends on the state of the model being saved.

Parameters

options :  Object

Options to pass to the proxy.

Returns

:Ext.data.operation.Create/Ext.data.operation.Update/Ext.data.operation.Destroy

The operation instance for saving this model. The type of operation returned depends on the model state at the time of the action.

set ( fieldName, newValue, [options] ) : String[]

Sets the given field to the given value. For example:

 record.set('name', 'value');

This method can also be passed an object containing multiple values to set at once. For example:

 record.set({
     name: 'value',
     age: 42
 });

The following store events are fired when the modified record belongs to a store:

Parameters

fieldName :  String/Object

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

newValue :  Object

The value for the field (if fieldName is a string).

options :  Object (optional)

Options for governing this update.

convert :  Boolean (optional)

Set to false to prevent any converters from being called during the set operation. This may be useful when setting a large bunch of raw values.

Defaults to:

true

dirty :  Boolean (optional)

Pass false if the field values are to be understood as non-dirty (fresh from the server). When true, this change will be reflected in the modified collection.

Defaults to:

true

commit :  Boolean (optional)

Pass true to call the commit method after setting fields. If this option is passed, the usual after change processing will be bypassed. Commit will be called even if there are no field changes.

Defaults to:

false

silent :  Boolean (optional)

Pass true to suppress notification of any changes made by this call. Use with caution.

Defaults to:

false

Returns

:String[]

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

setAllDay ( allDay )
abstract abs

Sets the allDay state of this event.

Parameters

allDay :  Boolean

The allDay value

setCalendar ( calendar, [dirty] )

Sets the calendar of this event. Also sets the underlying calendar id.

Parameters

calendar :  Ext.calendar.model.Calendar

The calendar.

dirty :  Boolean (optional)

false to not mark this record as dirty. Useful for inferring a calendar id when doing nested loading.

Defaults to: true

setCalendarId ( calendarId, [dirty] )
abstract abs

Sets the calendar id for this event.

Parameters

calendarId :  Object

The calendar id.

dirty :  Boolean (optional)

false to not mark this record as dirty. Useful for inferring a calendar id when doing nested loading.

Defaults to: true

setColor ( color )
abstract abs

Sets the color for this event.

Parameters

color :  String

The color.

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

name :  String/Object

The name of the property to set, or a set of key value pairs to set.

value :  Object (optional)

The value to set for the name parameter.

Returns

:Ext.Base

this

setData ( A )
abstract abs

Sets the data for this event in bulk.

Parameters

A :  Object

set of key value pairs for this event, matching to the property names, eg:

 {
     color: '#FFF',
     startDate: new Date(),
     descrption: 'Foo',
     title: 'Bar'
 }

setDescription ( The )
abstract abs

Sets the description for this event.

Parameters

The :  String

description.

setDuration ( duration )
abstract abs

Sets the duration for this event. Leaves the getStartDate unmodified.

Parameters

duration :  Number

The duration in minutes.

setId ( id, [options] )

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

Parameters

id :  Number/String

The new id.

options :  Object (optional)

See set.

setRange ( range, end )
abstract abs

Sets the start and end date for this event.

Parameters

range :  Ext.calendar.date.Range/Date

The range, or the start date.

end :  Date

The end date (if the first parameter was not the range).

setSession ( session )
private pri

Set the session for this record.

Parameters

session :  Ext.data.Session

The session

setTitle ( title )
abstract abs

Sets the title for this event.

Parameters

title :  String

The title.

statics Ext.Class
protected pro

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#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();

        // always equals to 'Cat' no matter what 'this' refers to
        // equivalent to: My.Cat.speciesName
        alert(statics.speciesName);


        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self();   // dependent on 'this'

        // equivalent to: My.Cat.speciesName
        cloned.groupName = this.statics().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

Returns

:Ext.Class

toUrl String

Returns a url-suitable string for this model instance. By default this just returns the name of the Model class followed by the instance ID - for example an instance of MyApp.model.User with ID 123 will return 'user/123'.

Returns

:String

The url string for this model instance.

unjoin ( owner )

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

Parameters

owner :  Ext.data.Store

The store or other owner object from which this model has been removed.

validate Ext.data.ErrorCollection
deprecated dep

Validates the current data against all of its configured validators. The returned collection holds an object for each reported problem from a validator.

Returns

:Ext.data.ErrorCollection

The errors collection.

Deprecated since version 5.0
Use getValidation instead.

watchConfig ( name, fn, scope )
private pri

Watches config properties.

 instance.watchConfig({
     title: 'onTitleChange',
     scope: me
 });

Available since: 6.7.0

Parameters

name :  Object

fn :  Object

scope :  Object

Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addFields ( newFields )
static sta protected pro

This method adds the given set of fields to this model class.

Available since: 5.0.0

Parameters

newFields :  String[]/Object[]

The new fields to add. Based on the name of a field this may replace a previous field definition.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member, privacy ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

privacy :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

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

Parameters

members :  Object

The members to add to this class.

isStatic :  Boolean (optional)

Pass true if the members are static.

Defaults to: false

privacy :  Boolean (optional)

Pass true if the members are private. This only has meaning in debug mode and only for methods.

Defaults to: false

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

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() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base

this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

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

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

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.

Returns

:Object

the created instance.

createAlias ( alias, origin )
static sta

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

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

createWithId ( id, data, session )
static sta private pri

Parameters

id :  Object

data :  Object

session :  Object

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getField ( name )
static sta private pri

Parameters

name :  Object

getFields
static sta private pri

getFieldsMap
static sta private pri

getIdFromData ( data )
static sta private pri

Parameters

data :  Object

getName String
static sta

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'

Returns

:String

className

getProxy Ext.data.proxy.Proxy
static sta

Returns the configured Proxy for this Model.

Returns

:Ext.data.proxy.Proxy

The proxy

getSummaryModel Ext.Class
static sta

Get the summary model type. If summary is specified, it is a new type that extends from this type. If not, then it is the same model type.

Available since: 6.5.0

Returns

:Ext.Class

The summary model type.

load ( id, [options], [session] ) : Ext.data.Model
static sta

Asynchronously loads a model instance by id. Any processing of the loaded record should be done in a callback.

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, success) {
        //do something whether the load succeeded or failed
    }
});

Parameters

id :  Number/String

The ID of the model to load. NOTE: The model returned must have an ID matching the param in the load request.

options :  Object (optional)

The options param is an Ext.data.operation.Read config object containing success, failure and callback functions, plus optional scope.

success :  Function

A function to be called when the model is processed by the proxy successfully. The callback is passed the following parameters:

record :  Ext.data.Model

The record.

operation :  Ext.data.operation.Operation

The operation.

failure :  Function

A function to be called when the model is unable to be processed by the server. The callback is passed the following parameters:

record :  Ext.data.Model

The record.

operation :  Ext.data.operation.Operation

The operation.

callback :  Function

A function to be called whether the proxy transaction was successful or not. The callback is passed the following parameters:

record :  Ext.data.Model

The record.

operation :  Ext.data.operation.Operation

The operation.

success :  Boolean

true if the operation was successful.

scope :  Object

The scope in which to execute the callback functions. Defaults to the model instance.

session :  Ext.data.Session (optional)

The session for this record.

Returns

:Ext.data.Model

The newly created model. Note that the model will (probably) still be loading once it is returned from this method. To do any post-processing on the data, the appropriate place to do see is in the callback.

loadData ( data, [session] ) : Ext.data.Model
static sta

Create a model while also parsing any data for associations.

Available since: 6.5.0

Parameters

data :  Object

The model data, including any associated data if required. The type of data should correspond to what the configured data reader would expect.

session :  Ext.data.Session (optional)

The session.

Returns

:Ext.data.Model

The model.

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch static sta

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"

Direct use of this method should be rare. 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).

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

this class

removeFields ( removeFields )
static sta protected pro

Removes the given set of fields from this model.

Available since: 5.0.0

Parameters

removeFields :  Boolean/String[]

The names of fields to remove or true to remove all existing fields. Removes are processed first followed by adds so if a field name appears in newFields as well that field will effectively be added (however, in that case there is no need to include the field in this array).

replaceFields ( newFields, removeFields )
static sta protected pro

This method replaces the specified set of fields with a given set of new fields. Fields should normally be considered immutable, but if the timing is right (that is, before derived classes are declared), it is permissible to change the fields collection.

Available since: 5.0.0

Parameters

newFields :  String[]/Object[]

The new fields to add. Based on the name of a field this may replace a previous field definition.

removeFields :  Boolean/String[]

The names of fields to remove or true to remove all existing fields. Removes are processed first followed by adds so if a field name appears in newFields as well that field will effectively be added (however, in that case there is no need to include the field in this array).

setProxy ( proxy ) : Ext.data.proxy.Proxy
static sta

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

Parameters

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

The proxy

Returns

:Ext.data.proxy.Proxy

setSummaryField ( name, summary )
static sta

Add a new summary field to the model

Parameters

name :  String

Name of the field

summary :  Ext.data.summary.Base

Name of the summary function

triggerExtended
static sta private pri

Ext JS 7.8.0 - Classic Toolkit