X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.data.ResultSet.js diff --git a/docs/output/Ext.data.ResultSet.js b/docs/output/Ext.data.ResultSet.js index 1ba5d2f3..067fa0db 100644 --- a/docs/output/Ext.data.ResultSet.js +++ b/docs/output/Ext.data.ResultSet.js @@ -1,186 +1 @@ -Ext.data.JsonP.Ext_data_ResultSet({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "ResultSet.html#Ext-data-ResultSet-cfg-count", - "shortDoc": "The number of records in this ResultSet. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/ResultSet.js", - "private": false, - "name": "count", - "owner": "Ext.data.ResultSet", - "doc": "

The number of records in this ResultSet. Note that total may differ from this number

\n", - "linenr": 16, - "html_filename": "ResultSet.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "ResultSet.html#Ext-data-ResultSet-cfg-loaded", - "shortDoc": "True if the records have already been loaded. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/ResultSet.js", - "private": false, - "name": "loaded", - "owner": "Ext.data.ResultSet", - "doc": "

True if the records have already been loaded. This is only meaningful when dealing with\nSQL-backed proxies

\n", - "linenr": 9, - "html_filename": "ResultSet.html" - }, - { - "type": "Array", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "ResultSet.html#Ext-data-ResultSet-cfg-records", - "shortDoc": "The array of record instances. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/ResultSet.js", - "private": false, - "name": "records", - "owner": "Ext.data.ResultSet", - "doc": "

The array of record instances. Required

\n", - "linenr": 35, - "html_filename": "ResultSet.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "ResultSet.html#Ext-data-ResultSet-cfg-success", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/ResultSet.js", - "private": false, - "name": "success", - "owner": "Ext.data.ResultSet", - "doc": "

True if the ResultSet loaded successfully, false if any errors were encountered

\n", - "linenr": 29, - "html_filename": "ResultSet.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "ResultSet.html#Ext-data-ResultSet-cfg-total", - "shortDoc": "The total number of records reported by the data source. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/ResultSet.js", - "private": false, - "name": "total", - "owner": "Ext.data.ResultSet", - "doc": "

The total number of records reported by the data source. This ResultSet may form a subset of\nthose records (see count)

\n", - "linenr": 22, - "html_filename": "ResultSet.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "href": "ResultSet.html#Ext-data-ResultSet-method-constructor", - "tagname": "method", - "protected": false, - "shortDoc": "Creates the resultSet ...", - "static": false, - "params": [ - { - "type": "Object", - "optional": true, - "doc": "

(optional) Config object.

\n", - "name": "config" - } - ], - "private": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/ResultSet.js", - "doc": "

Creates the resultSet

\n", - "owner": "Ext.data.ResultSet", - "name": "ResultSet", - "html_filename": "ResultSet.html", - "return": { - "type": "Object", - "doc": "\n" - }, - "linenr": 39 - } - ], - "property": [ - { - "type": "Mixed", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "ResultSet.html#Ext-data-ResultSet-property-totalRecords", - "shortDoc": "DEPRECATED - will be removed in Ext JS 5.0. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/ResultSet.js", - "private": false, - "name": "totalRecords", - "owner": "Ext.data.ResultSet", - "doc": "

DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.total - use that instead

\n", - "linenr": 46, - "html_filename": "ResultSet.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "ResultSet.html#Ext-data-ResultSet", - "subclasses": [ - - ], - "static": false, - "author": "Ed Spencer", - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/ResultSet.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.data.ResultSet", - "doc": "

Simple wrapper class that represents a set of records returned by a Proxy.

\n\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "ResultSet.html", - "extends": "Object" -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_ResultSet({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.data.ResultSet

Files

Simple wrapper class that represents a set of records returned by a Proxy.

\n
Defined By

Config options

The number of records in this ResultSet. ...

The number of records in this ResultSet. Note that total may differ from this number.

\n

Defaults to: 0

True if the records have already been loaded. ...

True if the records have already been loaded. This is only meaningful when dealing with\nSQL-backed proxies.

\n

Defaults to: true

 

The array of record instances.

\n

The array of record instances.

\n
True if the ResultSet loaded successfully, false if any errors were encountered. ...

True if the ResultSet loaded successfully, false if any errors were encountered.

\n

Defaults to: false

The total number of records reported by the data source. ...

The total number of records reported by the data source. This ResultSet may form a subset of\nthose records (see count).

\n

Defaults to: 0

Defined By

Properties

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        return 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
Copy of this.total. ...

Copy of this.total.

\n

This property has been deprecated

Will be removed in Ext JS 5.0. Use total instead.

\n

Methods

Defined By

Instance Methods

Creates the resultSet ...

Creates the resultSet

\n

Parameters

  • config : Object (optional)

    Config object.

    \n

Returns

( Array/Arguments args ) : Objectprotected
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        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\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

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

    \n

Returns

  • Object

    Returns the result after calling the overridden method

    \n
( Array/Arguments args ) : Objectprotected
Call the parent's overridden method. ...

Call the parent's overridden method. For example:

\n\n
Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n
\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 from the superclass' method

    \n
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        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

    \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        return this;\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

Defined By

Static Methods

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

( Ext.Base fromClass, String/String[] members ) : Ext.Basestatic
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 : String/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

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

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

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.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\n

Parameters

Override prototype members of this class. ...

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

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\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

Parameters

Returns

","allMixins":[],"meta":{"author":["Ed Spencer"]},"requires":[],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.data.ResultSet"],"singleton":false,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"borrow","id":"static-method-borrow"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"create","id":"static-method-create"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"getName","id":"static-method-getName"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"implement","id":"static-method-implement"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"override","id":"static-method-override"}],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"},{"tagname":"property","deprecated":{"doc":null,"tagname":"deprecated","text":"

Will be removed in Ext JS 5.0. Use total instead.

\n","version":null},"static":false,"owner":"Ext.data.ResultSet","template":null,"required":null,"protected":false,"name":"totalRecords","id":"property-totalRecords"}],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.ResultSet","template":null,"required":false,"protected":false,"name":"count","id":"cfg-count"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.ResultSet","template":null,"required":false,"protected":false,"name":"loaded","id":"cfg-loaded"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.ResultSet","template":null,"required":true,"protected":false,"name":"records","id":"cfg-records"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.ResultSet","template":null,"required":false,"protected":false,"name":"success","id":"cfg-success"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.data.ResultSet","template":null,"required":false,"protected":false,"name":"total","id":"cfg-total"}],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.ResultSet","template":false,"required":null,"protected":false,"name":"constructor","id":"method-constructor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callParent","id":"method-callParent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"}],"event":[]},"private":false,"component":false,"name":"Ext.data.ResultSet","alternateClassNames":[],"id":"class-Ext.data.ResultSet","mixedInto":[],"xtypes":{},"files":[{"href":"ResultSet.html#Ext-data-ResultSet","filename":"ResultSet.js"}]}); \ No newline at end of file