X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.util.Grouper.js 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\n\n\n", - "linenr": 65, - "html_filename": "Sorter.html" - }, - { - "type": "Function", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sorter.html#Ext-util-Sorter-cfg-transform", - "shortDoc": "A function that will be run on each value before\nit is compared in the sorter. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sorter.js", - "private": false, - "name": "transform", - "owner": "Ext.util.Sorter", - "doc": "

A 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.Base
Ext.util.Sorter
Ext.util.Grouper

Files

Represents a single grouper that can be applied to a Store. The grouper works\nin the same fashion as the Ext.util.Sorter.

\n
Defined By

Config options

The direction to sort by. ...

The direction to sort by.

\n

Defaults to: "ASC"

The property to sort by. ...

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

\n
Optional root property. ...

Optional 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

\n
A specific sorter function to execute. ...

A 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\n
    \n
  • -1 if o1 is \"less than\" o2
  • \n
  • 0 if o1 is \"equal\" to o2
  • \n
  • 1 if o1 is \"greater than\" o2
  • \n
\n\n
A function that will be run on each value before it is compared in the sorter. ...

A function that will be run on each value before it is compared in the sorter. The function will receive a single\nargument, the value.

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

Methods

Defined By

Instance Methods

( 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
Returns the value for grouping to be used. ...

Returns the value for grouping to be used.

\n

Parameters

Returns

  • String

    The group string for this model

    \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
Set the sorting direction for this sorter. ...

Set the sorting direction for this sorter.

\n

Parameters

  • direction : String

    The direction to sort in. Should be either 'ASC' or 'DESC'.

    \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

Toggles the sorting direction for this sorter. ...

Toggles the sorting direction for this sorter.

\n
Update the sort function for this sorter. ...

Update the sort function for this sorter.

\n

Parameters

  • fn : Function (optional)

    A new sorter function for this sorter. If not specified it will use the default\nsorting function.

    \n
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":{},"requires":[],"deprecated":null,"extends":"Ext.util.Sorter","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.util.Sorter","Ext.util.Grouper"],"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"}],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.util.Sorter","template":null,"required":false,"protected":false,"name":"direction","id":"cfg-direction"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.util.Sorter","template":null,"required":false,"protected":false,"name":"property","id":"cfg-property"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.util.Sorter","template":null,"required":false,"protected":false,"name":"root","id":"cfg-root"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.util.Sorter","template":null,"required":false,"protected":false,"name":"sorterFn","id":"cfg-sorterFn"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.util.Sorter","template":null,"required":false,"protected":false,"name":"transform","id":"cfg-transform"}],"method":[{"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.util.Grouper","template":false,"required":null,"protected":false,"name":"getGroupString","id":"method-getGroupString"},{"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.util.Sorter","template":false,"required":null,"protected":false,"name":"setDirection","id":"method-setDirection"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Sorter","template":false,"required":null,"protected":false,"name":"toggle","id":"method-toggle"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Sorter","template":false,"required":null,"protected":false,"name":"updateSortFunction","id":"method-updateSortFunction"}],"event":[]},"private":false,"component":false,"name":"Ext.util.Grouper","alternateClassNames":[],"id":"class-Ext.util.Grouper","mixedInto":[],"xtypes":{},"files":[{"href":"Grouper.html#Ext-util-Grouper","filename":"Grouper.js"}]}); \ No newline at end of file