Ext.data.JsonP.Ext_data_reader_Json({"alternateClassNames":["Ext.data.JsonReader"],"aliases":{"reader":["json"]},"enum":null,"parentMixins":["Ext.util.Observable"],"tagname":"class","subclasses":["Ext.data.amf.Reader","Ext.data.reader.Array"],"extends":"Ext.data.reader.Reader","uses":[],"html":"

Alternate names

Ext.data.JsonReader

Hierarchy

Ext.Base
Ext.data.reader.Reader
Ext.data.reader.Json

Inherited mixins

Subclasses

Files

The JSON Reader is used by a Proxy to read a server response that is sent back in JSON format. This usually\nhappens as a result of loading a Store - for example we might create something like this:

\n\n
Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['id', 'name', 'email']\n});\n\nvar store = Ext.create('Ext.data.Store', {\n    model: 'User',\n    proxy: {\n        type: 'ajax',\n        url : 'users.json',\n        reader: {\n            type: 'json'\n        }\n    }\n});\n
\n\n

The example above creates a 'User' model. Models are explained in the Model docs if you're\nnot already familiar with them.

\n\n

We created the simplest type of JSON Reader possible by simply telling our Store's\nProxy that we want a JSON Reader. The Store automatically passes the configured model to the\nStore, so it is as if we passed this instead:

\n\n
reader: {\n    type : 'json',\n    model: 'User'\n}\n
\n\n

The reader we set up is ready to read data from our server - at the moment it will accept a response like this:

\n\n
[\n    {\n        \"id\": 1,\n        \"name\": \"Ed Spencer\",\n        \"email\": \"ed@sencha.com\"\n    },\n    {\n        \"id\": 2,\n        \"name\": \"Abe Elias\",\n        \"email\": \"abe@sencha.com\"\n    }\n]\n
\n\n

Reading other JSON formats

\n\n

If you already have your JSON format defined and it doesn't look quite like what we have above, you can usually\npass JsonReader a couple of configuration options to make it parse your format. For example, we can use the\nroot configuration to parse data that comes back like this:

\n\n
{\n    \"users\": [\n       {\n           \"id\": 1,\n           \"name\": \"Ed Spencer\",\n           \"email\": \"ed@sencha.com\"\n       },\n       {\n           \"id\": 2,\n           \"name\": \"Abe Elias\",\n           \"email\": \"abe@sencha.com\"\n       }\n    ]\n}\n
\n\n

To parse this we just pass in a root configuration that matches the 'users' above:

\n\n
reader: {\n    type: 'json',\n    root: 'users'\n}\n
\n\n

Sometimes the JSON structure is even more complicated. Document databases like CouchDB often provide metadata\naround each record inside a nested structure like this:

\n\n
{\n    \"total\": 122,\n    \"offset\": 0,\n    \"users\": [\n        {\n            \"id\": \"ed-spencer-1\",\n            \"value\": 1,\n            \"user\": {\n                \"id\": 1,\n                \"name\": \"Ed Spencer\",\n                \"email\": \"ed@sencha.com\"\n            }\n        }\n    ]\n}\n
\n\n

In the case above the record data is nested an additional level inside the \"users\" array as each \"user\" item has\nadditional metadata surrounding it ('id' and 'value' in this case). To parse data out of each \"user\" item in the\nJSON above we need to specify the record configuration like this:

\n\n
reader: {\n    type  : 'json',\n    root  : 'users',\n    record: 'user'\n}\n
\n\n

Response MetaData

\n\n

The server can return metadata in its response, in addition to the record data, that describe attributes\nof the data set itself or are used to reconfigure the Reader. To pass metadata in the response you simply\nadd a metaData attribute to the root of the response data. The metaData attribute can contain anything,\nbut supports a specific set of properties that are handled by the Reader if they are present:

\n\n\n\n\n

An initial Reader configuration containing all of these properties might look like this (\"fields\" would be\nincluded in the Model definition, not shown):

\n\n
reader: {\n    type : 'json',\n    root : 'root',\n    idProperty     : 'id',\n    totalProperty  : 'total',\n    successProperty: 'success',\n    messageProperty: 'message'\n}\n
\n\n

If you were to pass a response object containing attributes different from those initially defined above, you could\nuse the metaData attribute to reconifgure the Reader on the fly. For example:

\n\n
{\n    \"count\": 1,\n    \"ok\": true,\n    \"msg\": \"Users found\",\n    \"users\": [{\n        \"userId\": 123,\n        \"name\": \"Ed Spencer\",\n        \"email\": \"ed@sencha.com\"\n    }],\n    \"metaData\": {\n        \"root\": \"users\",\n        \"idProperty\": 'userId',\n        \"totalProperty\": 'count',\n        \"successProperty\": 'ok',\n        \"messageProperty\": 'msg'\n    }\n}\n
\n\n

You can also place any other arbitrary data you need into the metaData attribute which will be ignored by the Reader,\nbut will be accessible via the Reader's metaData property (which is also passed to listeners via the Proxy's\nmetachange event (also relayed by the store). Application code can then process the passed metadata in any way it chooses.

\n\n

A simple example for how this can be used would be customizing the fields for a Model that is bound to a grid. By passing\nthe fields property the Model will be automatically updated by the Reader internally, but that change will not be\nreflected automatically in the grid unless you also update the column configuration. You could do this manually, or you\ncould simply pass a standard grid column config object as part of the metaData attribute\nand then pass that along to the grid. Here's a very simple example for how that could be accomplished:

\n\n
// response format:\n{\n    ...\n    \"metaData\": {\n        \"fields\": [\n            { \"name\": \"userId\", \"type\": \"int\" },\n            { \"name\": \"name\", \"type\": \"string\" },\n            { \"name\": \"birthday\", \"type\": \"date\", \"dateFormat\": \"Y-j-m\" },\n        ],\n        \"columns\": [\n            { \"text\": \"User ID\", \"dataIndex\": \"userId\", \"width\": 40 },\n            { \"text\": \"User Name\", \"dataIndex\": \"name\", \"flex\": 1 },\n            { \"text\": \"Birthday\", \"dataIndex\": \"birthday\", \"flex\": 1, \"format\": 'Y-j-m', \"xtype\": \"datecolumn\" }\n        ]\n    }\n}\n
\n\n

The Reader will automatically read the meta fields config and rebuild the Model based on the new fields, but to handle\nthe new column configuration you would need to handle the metadata within the application code. This is done simply enough\nby handling the metachange event on either the store or the proxy, e.g.:

\n\n
var store = Ext.create('Ext.data.Store', {\n    ...\n    listeners: {\n        'metachange': function(store, meta) {\n            myGrid.reconfigure(store, meta.columns);\n        }\n    }\n});\n
\n
Defined By

Config options

Name of the property within a row object that contains a record identifier value. ...

Name of the property within a row object that contains a record identifier value. Defaults to the id of the\nmodel. If an idProperty is explicitly specified it will take precedence over idProperty defined on the model.

\n
True to automatically parse models nested within other models in a response object. ...

True to automatically parse models nested within other models in a response object. See the\nExt.data.reader.Reader intro docs for full explanation.

\n

Defaults to: true

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
\n
The name of the property which contains a response message. ...

The name of the property which contains a response message. This property is optional.

\n
Ext.data.reader.Json
view source
: String
Name of the property from which to retrieve the metaData attribute. ...

Name of the property from which to retrieve the metaData attribute. See metaData.

\n

Defaults to: "metaData"

True to extract the records from a data packet even if the successProperty returns false. ...

True to extract the records from a data packet even if the successProperty returns false.

\n

Defaults to: true

Ext.data.reader.Json
view source
: String
The optional location within the JSON response that the record data itself can be found at. ...

The optional location within the JSON response that the record data itself can be found at.\nSee the JsonReader intro docs for more details. This is not often needed.

\n
Ext.data.reader.Json
view source
: String
The name of the property which contains the data items corresponding to the Model(s) for which this\nReader is configu...

The name of the property which contains the data items corresponding to the Model(s) for which this\nReader is configured. For JSON reader it's a property name (or a dot-separated list of property names\nif the root is nested). For XML reader it's a CSS selector. For Array reader the root is not applicable\nsince the data is assumed to be a single-level array of arrays.

\n\n

By default the natural root of the data will be used: the root JSON array, the root XML element, or the array.

\n\n

The data packet value for this property should be an empty array to clear the data or show no data.

\n

Defaults to: ''

Overrides: Ext.data.reader.Reader.root

Name of the property from which to retrieve the success attribute, the value of which indicates\nwhether a given reque...

Name of the property from which to retrieve the success attribute, the value of which indicates\nwhether a given request succeeded or failed (typically a boolean or 'true'|'false'). See\nExt.data.proxy.Server.exception for additional information.

\n

Defaults to: "success"

Name of the property from which to retrieve the total number of records in the dataset. ...

Name of the property from which to retrieve the total number of records in the dataset. This is only needed if\nthe whole dataset is not passed in one go, but is being paged from the remote server.

\n

Defaults to: "total"

True to ensure that field names/mappings are treated as literals when\nreading values. ...

True to ensure that field names/mappings are treated as literals when\nreading values.

\n\n

For example, by default, using the mapping \"foo.bar.baz\" will try and read a property foo from the root, then a property bar\nfrom foo, then a property baz from bar. Setting the simple accessors to true will read the property with the name\n\"foo.bar.baz\" direct from the root object.

\n

Defaults to: false

Properties

Defined By

Instance Properties

...
\n

Defaults to: 'Ext.Base'

Private flag to the generated convertRecordData function to indicate whether to apply Field default\nvalues to fields ...

Private flag to the generated convertRecordData function to indicate whether to apply Field default\nvalues to fields for which no value is present in the raw data.\nThis is set to false by a Server Proxy which is reading the response from a \"create\" or \"update\" operation.

\n

Defaults to: true

...
\n

Defaults to: {}

Initial suspended call count. ...

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

\n

Defaults to: 0

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

This object holds a key for any event that has a listener. The listener may be set\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
\n
...
\n

Defaults to: []

...
\n

Defaults to: {}

...
\n

Defaults to: true

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.

\n

Defaults to: true

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

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

\n

Defaults to: true

Ext.data.reader.Json
view source
: Objectdeprecated
A copy of this.rawData. ...

A copy of this.rawData.

\n
\n

This property has been deprecated

\n

Will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead.

\n\n
\n
The raw meta data that was most recently read, if any. ...

The raw meta data that was most recently read, if any. Meta data can include existing\nReader config options like idProperty, totalProperty, etc. that get\nautomatically applied to the Reader, and those can still be accessed directly from the Reader\nif needed. However, meta data is also often used to pass other custom data to be processed\nby application code. For example, it is common when reconfiguring the data model of a grid to\nalso pass a corresponding column model config to be applied to the grid. Any such data will\nnot get applied to the Reader directly (it just gets passed through and is ignored by Ext).\nThis metaData property gives you access to all meta data that was passed, including any such\ncustom data ignored by the reader.

\n\n

This is a read-only property, and it will get replaced each time a new meta data object is\npassed to the reader. Note that typically you would handle proxy's\nmetachange event which passes this exact same meta\nobject to listeners. However this property is available if it's more convenient to access it\nvia the reader directly in certain cases.

\n
The raw data object that was last passed to readRecords. ...

The raw data object that was last passed to readRecords. Stored for further processing if needed.

\n
...
\n

Defaults to: ['var me = this\\n', ' ,fields = me.model.prototype.fields\\n', ' ,value\\n', ' ,internalId\\n', '<tpl for="fields">', ' ,__field{#} = fields.map["{name}"]\\n', '</tpl>', ';\\n', 'return function(dest, source, record) {\\n', '<tpl for="fields">', '{% var fieldAccessExpression = this.createFieldAccessExpression(values, "__field" + xindex, "source");', ' if (fieldAccessExpression) { %}', ' value = {[ this.createFieldAccessExpression(values, "__field" + xindex, "source") ]};\\n', '<tpl if="hasCustomConvert">', ' dest["{name}"] = value === undefined ? __field{#}.convert(__field{#}.defaultValue, record) : __field{#}.convert(value, record);\\n', '<tpl elseif="defaultValue !== undefined">', ' if (value === undefined) {\\n', ' if (me.applyDefaults) {\\n', '<tpl if="convert">', ' dest["{name}"] = __field{#}.convert(__field{#}.defaultValue, record);\\n', '<tpl else>', ' dest["{name}"] = __field{#}.defaultValue\\n', '</tpl>', ' };\\n', ' } else {\\n', '<tpl if="convert">', ' dest["{name}"] = __field{#}.convert(value, record);\\n', '<tpl else>', ' dest["{name}"] = value;\\n', '</tpl>', ' };\\n', '<tpl else>', ' if (value !== undefined) {\\n', '<tpl if="convert">', ' dest["{name}"] = __field{#}.convert(value, record);\\n', '<tpl else>', ' dest["{name}"] = value;\\n', '</tpl>', ' }\\n', '</tpl>', '{% } else { %}', '<tpl if="defaultValue !== undefined">', '<tpl if="convert">', ' dest["{name}"] = __field{#}.convert(__field{#}.defaultValue, record);\\n', '<tpl else>', ' dest["{name}"] = __field{#}.defaultValue\\n', '</tpl>', '</tpl>', '{% } %}', '</tpl>', '<tpl if="clientIdProp">', ' if (record && (internalId = {[ this.createFieldAccessExpression(\\{mapping: values.clientIdProp\\}, null, "source") ]})) {\\n', ' record.{["internalId"]} = internalId;\\n', ' }\\n', '</tpl>', '};']

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
\n
Defined By

Static Properties

...
\n

Defaults to: []

Methods

Defined By

Instance Methods

Creates new Reader. ...

Creates new Reader.

\n

Parameters

  • config : Object (optional)

    Config object.

    \n

Returns

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.

\n

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

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
( 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.

\n

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

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
Ext.data.reader.Json
view source
( [force] )private
inherit docs\n\nThis builds optimized functions for retrieving record data and meta data from an object. ...

inherit docs

\n\n

This builds optimized functions for retrieving record data and meta data from an object.\nSubclasses may need to implement their own getRoot function.

\n

Parameters

  • force : Boolean (optional)

    True to automatically remove existing extractor functions first

    \n

    Defaults to: false

Overrides: Ext.data.reader.Reader.buildExtractors

Return a function which will read a raw row object in the format this Reader accepts, and populates\na record's data o...

Return a function which will read a raw row object in the format this Reader accepts, and populates\na record's data object with converted data values.

\n\n

The returned function must be passed the following parameters:

\n\n
    \n
  • dest A record's empty data object into which the new field value properties are injected.
  • \n
  • source A raw row data object of whatever type this Reader consumes
  • \n
  • record The record which is being populated.
  • \n
\n\n
( 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
\n
\n

This method has been deprecated

\n

as of 4.1. Use callParent instead.

\n\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
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.

\n

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
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\".

\n

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
...
\n

Parameters

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

Removes all listeners for this object including the managed listeners

\n
Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

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

Continue to fire event.

\n

Parameters

Ext.data.reader.Json
view source
( )private
Returns an accessor function for the given property string. ...

Returns an accessor function for the given property string. Gives support for properties such as the following:

\n\n
    \n
  • 'someProperty'
  • \n
  • 'some.property'
  • \n
  • '[\"someProperty\"]'
  • \n
  • 'values[0]'
  • \n
\n\n\n

This is used by buildExtractors to create optimized extractor functions for properties that are looked\nup directly on the source object (e.g. successProperty, messageProperty, etc.).

\n
Ext.data.reader.Json
view source
( )private
Returns an accessor expression for the passed Field. ...

Returns an accessor expression for the passed Field. Gives support for properties such as the following:

\n\n
    \n
  • 'someProperty'
  • \n
  • 'some.property'
  • \n
  • '[\"someProperty\"]'
  • \n
  • 'values[0]'
  • \n
\n\n\n

This is used by buildRecordDataExtractor to create optimized extractor expressions when converting raw\ndata into model instances. This method is used at the field level to dynamically map values to model fields.

\n
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.

\n

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

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
\n

Parameters

  • eventNames : String/String[]

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

    \n
Ext.data.reader.Json
view source
( root ) : Ext.data.Model[]private
We're just preparing the data for the superclass by pulling out the record objects we want. ...

We're just preparing the data for the superclass by pulling out the record objects we want. If a record\nwas specified we have to pull those out of the larger JSON object, which is most of what this function is doing

\n

Parameters

  • root : Object

    The JSON root node

    \n

Returns

Overrides: Ext.data.reader.Reader.extractData

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.

\n

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

\n

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
Used internally by readAssociated. ...

Used internally by readAssociated. Given a data object (which could be json, xml etc) for a specific\nrecord, this should return the relevant part of that data for the given association name. If a complex\nmapping, this will traverse arrays and objects to resolve the data.

\n

Parameters

  • data : Object

    The raw data object

    \n
  • associationName : String

    The name of the association to get data for (uses associationKey if present)

    \n

Returns

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

\n

Returns

...
\n

Parameters

By default this function just returns what is passed to it. ...

By default this function just returns what is passed to it. It can be overridden in a subclass\nto return something else. See XmlReader for an example.

\n

Parameters

  • data : Object

    The data object

    \n

Returns

  • Object

    The normalized data object

    \n
Get the idProperty to use for extracting data ...

Get the idProperty to use for extracting data

\n

Returns

  • String

    The id property if any

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

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

\n

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.reader.Json
view source
( response ) : Ext.data.ResultSet
inherit docs\n\nTakes a raw response object (as passed to the read method) and returns the useful data\nsegment from it. ...

inherit docs

\n\n

Takes a raw response object (as passed to the read method) and returns the useful data\nsegment from it. This must be implemented by each subclass.

\n

Parameters

  • response : Object

    The response object

    \n

Returns

Overrides: Ext.data.reader.Reader.getResponseData

This will usually need to be implemented in a subclass. ...

This will usually need to be implemented in a subclass. Given a generic data object (the type depends on the type\nof data we are reading), this function should return the object as configured by the Reader's 'root' meta data config.\nSee XmlReader's getRoot implementation for an example. By default the same data object will simply be returned.

\n

Parameters

  • data : Object

    The data object

    \n

Returns

...
\n

Parameters

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.

\n

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
( 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
\n

Parameters

Returns

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

\n

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

    or

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

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n

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

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
( names, callback, scope )private
...
\n

Parameters

Reconfigures the meta data tied to this Reader ...

Reconfigures the meta data tied to this Reader

\n

Parameters

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.

\n

Parameters

  • T : Function

    The class constructor to prepare.

    \n
Reads the given response object. ...

Reads the given response object. This method normalizes the different types of response object that may be passed to it.\nIf it's an XMLHttpRequest object, hand off to the subclass' getResponseData method.\nElse, hand off the reading of records to the readRecords method.

\n

Parameters

  • response : Object

    The response object. This may be either an XMLHttpRequest object or a plain JS object

    \n

Returns

Loads a record's associations from the data object. ...

Loads a record's associations from the data object. This prepopulates hasMany and belongsTo associations\non the record provided.

\n

Parameters

Returns

  • String

    Return value description

    \n
Ext.data.reader.Json
view source
( data ) : Ext.data.ResultSet
Reads a JSON object and returns a ResultSet. ...

Reads a JSON object and returns a ResultSet. Uses the internal getTotal and getSuccess extractors to\nretrieve meta data from the response, and extractData to turn the JSON data into model instances.

\n

Parameters

  • data : Object

    The raw JSON data

    \n

Returns

  • Ext.data.ResultSet

    A ResultSet containing model instances and meta data about the results

    \n

Overrides: Ext.data.reader.Reader.readRecords

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.

\n

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
Removes an event handler. ...

Removes an event handler.

\n

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
Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

\n

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
Remove a single managed listener item ...

Remove a single managed listener item

\n

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

\n

Parameters

  • eventName : String...

    Multiple event names to resume.

    \n
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.

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

Parameters

Returns

( model, setOnProxy )private
Sets a new model for the reader. ...

Sets a new model for the reader.

\n

Parameters

  • model : Object

    The model to set.

    \n
  • setOnProxy : Boolean

    True to also set on the Proxy, if one is configured

    \n
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
\n

Returns

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.

\n

Parameters

  • eventName : String...

    Multiple event names to suspend.

    \n
Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

\n

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
( eventName, fn, [scope] )
Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

\n

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
Defined By

Static Methods

( config )privatestatic
...
\n

Parameters

( members )chainableprivatestatic
...
\n

Parameters

( name, member )chainableprivatestatic
...
\n

Parameters

( 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
\n

Parameters

( 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
\n

Parameters

Returns

( xtype )chainableprivatestatic
...
\n

Parameters

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

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

\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
\n

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : Array/String

    The names of the members to borrow

    \n

Returns

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.

\n

Returns

( 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
\n

Parameters

( config )privatestatic
...
\n

Parameters

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
\n

Returns

( )deprecatedstatic
Adds members to class. ...

Adds members to class.

\n
\n

This method has been deprecated since 4.1

\n

Use addMembers instead.

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

Used internally by the mixins pre-processor

\n

Parameters

( fn, scope )chainableprivatestatic
...
\n

Parameters

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

\n
\n

This method has been deprecated since 4.1.0

\n

Use Ext.define instead

\n\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

Defined By

Events

( reader, response, error, eOpts )
Fires when the reader receives improperly encoded data from the server ...

Fires when the reader receives improperly encoded data from the server

\n

Parameters

","superclasses":["Ext.Base","Ext.data.reader.Reader"],"meta":{"author":["Ed Spencer"]},"code_type":"ext_define","requires":[],"html_meta":{"author":null},"statics":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"$onExtended","id":"static-property-S-onExtended"}],"cfg":[],"css_var":[],"method":[{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"addConfig","id":"static-method-addConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addInheritableStatics","id":"static-method-addInheritableStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addMember","id":"static-method-addMember"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addMembers","id":"static-method-addMembers"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addXtype","id":"static-method-addXtype"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"borrow","id":"static-method-borrow"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"create","id":"static-method-create"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"extend","id":"static-method-extend"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"getName","id":"static-method-getName"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"deprecated":{"text":"Use {@link #addMembers} instead.","version":"4.1"}},"name":"implement","id":"static-method-implement"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"mixin","id":"static-method-mixin"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"onExtended","id":"static-method-onExtended"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"markdown":true,"deprecated":{"text":"Use {@link Ext#define Ext.define} instead","version":"4.1.0"}},"name":"override","id":"static-method-override"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"triggerExtended","id":"static-method-triggerExtended"}],"event":[],"css_mixin":[]},"files":[{"href":"Json2.html#Ext-data-reader-Json","filename":"Json.js"}],"linenr":1,"members":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"$className","id":"property-S-className"},{"tagname":"property","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"applyDefaults","id":"property-applyDefaults"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"configMap","id":"property-configMap"},{"tagname":"property","owner":"Ext.util.Observable","meta":{"private":true},"name":"eventsSuspended","id":"property-eventsSuspended"},{"tagname":"property","owner":"Ext.util.Observable","meta":{"readonly":true},"name":"hasListeners","id":"property-hasListeners"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigList","id":"property-initConfigList"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigMap","id":"property-initConfigMap"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"isInstance","id":"property-isInstance"},{"tagname":"property","owner":"Ext.util.Observable","meta":{},"name":"isObservable","id":"property-isObservable"},{"tagname":"property","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"isReader","id":"property-isReader"},{"tagname":"property","owner":"Ext.data.reader.Json","meta":{"deprecated":{"text":"Will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead."}},"name":"jsonData","id":"property-jsonData"},{"tagname":"property","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"lastFieldGeneration","id":"property-lastFieldGeneration"},{"tagname":"property","owner":"Ext.data.reader.Reader","meta":{"readonly":true},"name":"metaData","id":"property-metaData"},{"tagname":"property","owner":"Ext.data.reader.Reader","meta":{},"name":"rawData","id":"property-rawData"},{"tagname":"property","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"recordDataExtractorTemplate","id":"property-recordDataExtractorTemplate"},{"tagname":"property","owner":"Ext.Base","meta":{"protected":true},"name":"self","id":"property-self"}],"cfg":[{"tagname":"cfg","owner":"Ext.data.reader.Reader","meta":{},"name":"idProperty","id":"cfg-idProperty"},{"tagname":"cfg","owner":"Ext.data.reader.Reader","meta":{},"name":"implicitIncludes","id":"cfg-implicitIncludes"},{"tagname":"cfg","owner":"Ext.util.Observable","meta":{},"name":"listeners","id":"cfg-listeners"},{"tagname":"cfg","owner":"Ext.data.reader.Reader","meta":{},"name":"messageProperty","id":"cfg-messageProperty"},{"tagname":"cfg","owner":"Ext.data.reader.Json","meta":{},"name":"metaProperty","id":"cfg-metaProperty"},{"tagname":"cfg","owner":"Ext.data.reader.Reader","meta":{},"name":"readRecordsOnFailure","id":"cfg-readRecordsOnFailure"},{"tagname":"cfg","owner":"Ext.data.reader.Json","meta":{},"name":"record","id":"cfg-record"},{"tagname":"cfg","owner":"Ext.data.reader.Json","meta":{},"name":"root","id":"cfg-root"},{"tagname":"cfg","owner":"Ext.data.reader.Reader","meta":{},"name":"successProperty","id":"cfg-successProperty"},{"tagname":"cfg","owner":"Ext.data.reader.Reader","meta":{},"name":"totalProperty","id":"cfg-totalProperty"},{"tagname":"cfg","owner":"Ext.data.reader.Json","meta":{},"name":"useSimpleAccessors","id":"cfg-useSimpleAccessors"}],"css_var":[],"method":[{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{},"name":"constructor","id":"method-constructor"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addEvents","id":"method-addEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addListener","id":"method-addListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addManagedListener","id":"method-addManagedListener"},{"tagname":"method","owner":"Ext.data.reader.Json","meta":{"private":true},"name":"buildExtractors","id":"method-buildExtractors"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"buildRecordDataExtractor","id":"method-buildRecordDataExtractor"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true,"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."}},"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callParent","id":"method-callParent"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callSuper","id":"method-callSuper"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"captureArgs","id":"method-captureArgs"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"clearListeners","id":"method-clearListeners"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"clearManagedListeners","id":"method-clearManagedListeners"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"configClass","id":"method-configClass"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"continueFireEvent","id":"method-continueFireEvent"},{"tagname":"method","owner":"Ext.data.reader.Json","meta":{"private":true},"name":"createAccessor","id":"method-createAccessor"},{"tagname":"method","owner":"Ext.data.reader.Json","meta":{"private":true},"name":"createFieldAccessExpression","id":"method-createFieldAccessExpression"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"createRelayer","id":"method-createRelayer"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"destroy","id":"method-destroy"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"destroyReader","id":"method-destroyReader"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"enableBubble","id":"method-enableBubble"},{"tagname":"method","owner":"Ext.data.reader.Json","meta":{"private":true},"name":"extractData","id":"method-extractData"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEvent","id":"method-fireEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEventArgs","id":"method-fireEventArgs"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"getAssociatedDataRoot","id":"method-getAssociatedDataRoot"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"getBubbleParent","id":"method-getBubbleParent"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"getConfig","id":"method-getConfig"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"getData","id":"method-getData"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"getFields","id":"method-getFields"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"getIdProperty","id":"method-getIdProperty"},{"tagname":"method","owner":"Ext.Base","meta":{},"name":"getInitialConfig","id":"method-getInitialConfig"},{"tagname":"method","owner":"Ext.data.reader.Json","meta":{},"name":"getResponseData","id":"method-getResponseData"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"getRoot","id":"method-getRoot"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"hasConfig","id":"method-hasConfig"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"hasListener","id":"method-hasListener"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"protected":true},"name":"initConfig","id":"method-initConfig"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"mon","id":"method-mon"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"mun","id":"method-mun"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"on","id":"method-on"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"onConfigUpdate","id":"method-onConfigUpdate"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"onMetaChange","id":"method-onMetaChange"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"prepareClass","id":"method-prepareClass"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{},"name":"read","id":"method-read"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"readAssociated","id":"method-readAssociated"},{"tagname":"method","owner":"Ext.data.reader.Json","meta":{},"name":"readRecords","id":"method-readRecords"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeListener","id":"method-removeListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeManagedListener","id":"method-removeManagedListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"removeManagedListenerItem","id":"method-removeManagedListenerItem"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvent","id":"method-resumeEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvents","id":"method-resumeEvents"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"private":true},"name":"setConfig","id":"method-setConfig"},{"tagname":"method","owner":"Ext.data.reader.Reader","meta":{"private":true},"name":"setModel","id":"method-setModel"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"statics","id":"method-statics"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvent","id":"method-suspendEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvents","id":"method-suspendEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"un","id":"method-un"}],"event":[{"tagname":"event","owner":"Ext.data.reader.Reader","meta":{},"name":"exception","id":"event-exception"}],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.data.reader.Json","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.data.reader.Json","mixins":[],"mixedInto":[]});