X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.util.Grouper.js?ds=inline diff --git a/docs/output/Ext.util.Grouper.js b/docs/output/Ext.util.Grouper.js index c2cf820d..995c4e57 100644 --- a/docs/output/Ext.util.Grouper.js +++ b/docs/output/Ext.util.Grouper.js @@ -1,250 +1 @@ -Ext.data.JsonP.Ext_util_Grouper({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sorter.html#Ext-util-Sorter-cfg-direction", - "shortDoc": "The direction to sort by. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js", - "private": false, - "name": "direction", - "owner": "Ext.util.Sorter", - "doc": "
The direction to sort by. Defaults to ASC
\n", - "linenr": 87, - "html_filename": "Sorter.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sorter.html#Ext-util-Sorter-cfg-property", - "shortDoc": "The property to sort by. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js", - "private": false, - "name": "property", - "owner": "Ext.util.Sorter", - "doc": "The property to sort by. Required unless sorterFn is provided.\nThe property is extracted from the object directly and compared for sorting using the built in\ncomparison operators.
\n", - "linenr": 59, - "html_filename": "Sorter.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sorter.html#Ext-util-Sorter-cfg-root", - "shortDoc": "Optional root property. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js", - "private": false, - "name": "root", - "owner": "Ext.util.Sorter", - "doc": "Optional root property. This is mostly useful when sorting a Store, in which case we set the\nroot to 'data' to make the filter pull the property out of the data object of each item
\n", - "linenr": 76, - "html_filename": "Sorter.html" - }, - { - "type": "Function", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sorter.html#Ext-util-Sorter-cfg-sorterFn", - "shortDoc": "A specific sorter function to execute. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js", - "private": false, - "name": "sorterFn", - "owner": "Ext.util.Sorter", - "doc": "A specific sorter function to execute. Can be passed instead of property.\nThis sorter function allows for any kind of custom/complex comparisons.\nThe sorterFn receives two arguments, the objects being compared. The function should return:
\n\nA function that will be run on each value before\nit is compared in the sorter. The function will receive a single argument,\nthe value.
\n", - "linenr": 81, - "html_filename": "Sorter.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Grouper.html#Ext-util-Grouper-method-getGroupString", - "shortDoc": "Returns the value for grouping to be used. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Grouper.js", - "private": false, - "params": [ - { - "type": "Ext.data.Model", - "optional": false, - "doc": "The Model instance
\n", - "name": "instance" - } - ], - "name": "getGroupString", - "owner": "Ext.util.Grouper", - "doc": "Returns the value for grouping to be used.
\n", - "linenr": 19, - "return": { - "type": "String", - "doc": "The group string for this model
\n" - }, - "html_filename": "Grouper.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sorter.html#Ext-util-Sorter-method-setDirection", - "shortDoc": "Set the sorting direction for this sorter. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The direction to sort in. Should be either 'ASC' or 'DESC'.
\n", - "name": "direction" - } - ], - "name": "setDirection", - "owner": "Ext.util.Sorter", - "doc": "Set the sorting direction for this sorter.
\n", - "linenr": 152, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Sorter.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sorter.html#Ext-util-Sorter-method-toggle", - "shortDoc": "Toggles the sorting direction for this sorter. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js", - "private": false, - "params": [ - - ], - "name": "toggle", - "owner": "Ext.util.Sorter", - "doc": "Toggles the sorting direction for this sorter.
\n", - "linenr": 162, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Sorter.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sorter.html#Ext-util-Sorter-method-updateSortFunction", - "shortDoc": "Update the sort function for this sorter. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "(Optional) A new sorter function for this sorter. If not specified it will use the\ndefault sorting function.
\n", - "name": "fn" - } - ], - "name": "updateSortFunction", - "owner": "Ext.util.Sorter", - "doc": "Update the sort function for this sorter.
\n", - "linenr": 171, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Sorter.html" - } - ], - "property": [ - - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - "Ext.util.Sorter" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Grouper.html#Ext-util-Grouper", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Grouper.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.util.Grouper", - "doc": "Represents a single grouper that can be applied to a Store. The grouper works\nin the same fashion as the Ext.util.Sorter.
\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "Grouper.html", - "extends": "Ext.util.Sorter" -}); \ No newline at end of file +Ext.data.JsonP.Ext_util_Grouper({"tagname":"class","html":"Hierarchy
Ext.BaseExt.util.SorterExt.util.GrouperFiles
Represents a single grouper that can be applied to a Store. The grouper works\nin the same fashion as the Ext.util.Sorter.
\nThe property to sort by. Required unless sorterFn is provided. The property is extracted from the object\ndirectly and compared for sorting using the built in comparison operators.
\nOptional root property. This is mostly useful when sorting a Store, in which case we set the root to 'data' to\nmake the filter pull the property out of the data object of each item
\nA specific sorter function to execute. Can be passed instead of property. This sorter function allows\nfor any kind of custom/complex comparisons. The sorterFn receives two arguments, the objects being compared. The\nfunction should return:
\n\nGet 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
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
\nCall the original method that was previously overridden with override
\n\nExt.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
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.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
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nReturns the value for grouping to be used.
\nThe Model instance
\nThe group string for this model
\nInitialize configuration for this class. a typical example:
\n\nExt.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
\nmixins The mixin prototypes as key - value pairs
\nSet the sorting direction for this sorter.
\nThe direction to sort in. Should be either 'ASC' or 'DESC'.
\nGet 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
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
\nToggles the sorting direction for this sorter.
\nUpdate the sort function for this sorter.
\nA new sorter function for this sorter. If not specified it will use the default\nsorting function.
\nAdd / override static properties of this class.
\n\nExt.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
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.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
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.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
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.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
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.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
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.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
\nthis
\n