X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.util.Inflector.js diff --git a/docs/output/Ext.util.Inflector.js b/docs/output/Ext.util.Inflector.js index ce819818..5eee3b61 100644 --- a/docs/output/Ext.util.Inflector.js +++ b/docs/output/Ext.util.Inflector.js @@ -1,278 +1 @@ -Ext.data.JsonP.Ext_util_Inflector({ - "tagname": "class", - "name": "Ext.util.Inflector", - "doc": "

General purpose inflector class that pluralizes, singularizes and \nordinalizes words. Sample usage:

\n\n\n\n\n
//turning singular words into plurals\nExt.util.Inflector.pluralize('word'); //'words'\nExt.util.Inflector.pluralize('person'); //'people'\nExt.util.Inflector.pluralize('sheep'); //'sheep'\n\n//turning plurals into singulars\nExt.util.Inflector.singularize('words'); //'word'\nExt.util.Inflector.singularize('people'); //'person'\nExt.util.Inflector.singularize('sheep'); //'sheep'\n\n//ordinalizing numbers\nExt.util.Inflector.ordinalize(11); //\"11th\"\nExt.util.Inflector.ordinalize(21); //\"21th\"\nExt.util.Inflector.ordinalize(1043); //\"1043rd\"\n
\n\n\n\n\n

Customization

\n\n\n\n\n

The Inflector comes with a default set of US English pluralization rules. These can be augmented with additional\nrules if the default rules do not meet your application's requirements, or swapped out entirely for other languages.\nHere is how we might add a rule that pluralizes \"ox\" to \"oxen\":

\n\n\n\n\n
Ext.util.Inflector.plural(/^(ox)$/i, \"$1en\");\n
\n\n\n\n\n

Each rule consists of two items - a regular expression that matches one or more rules, and a replacement string.\nIn this case, the regular expression will only match the string \"ox\", and will replace that match with \"oxen\". \nHere's how we could add the inverse rule:

\n\n\n\n\n
Ext.util.Inflector.singular(/^(ox)en$/i, \"$1\");\n
\n\n\n\n\n

Note that the ox/oxen rules are present by default.

\n\n", - "extends": "Object", - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": true, - "private": false, - "cfg": [ - - ], - "method": [ - { - "tagname": "method", - "name": "classify", - "member": "Ext.util.Inflector", - "doc": "

Returns the correct Model name for a given string. Mostly used internally by the data\npackage

\n", - "params": [ - { - "type": "String", - "name": "word", - "doc": "

The word to classify

\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "

The classified version of the word

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 237, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-classify", - "shortDoc": "

Returns the correct Model name for a given string. Mostly used internally by the data\npackage

\n" - }, - { - "tagname": "method", - "name": "clearPlurals", - "member": "Ext.util.Inflector", - "doc": "

Removes all registered pluralization rules

\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 169, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-clearPlurals", - "shortDoc": "

Removes all registered pluralization rules

\n" - }, - { - "tagname": "method", - "name": "clearSingulars", - "member": "Ext.util.Inflector", - "doc": "

Removes all registered singularization rules

\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 162, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-clearSingulars", - "shortDoc": "

Removes all registered singularization rules

\n" - }, - { - "tagname": "method", - "name": "isTransnumeral", - "member": "Ext.util.Inflector", - "doc": "

Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. sheep, fish)

\n", - "params": [ - { - "type": "String", - "name": "word", - "doc": "

The word to test

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

True if the word is transnumeral

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 176, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-isTransnumeral", - "shortDoc": "

Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. sheep, fish)

\n" - }, - { - "tagname": "method", - "name": "ordinalize", - "member": "Ext.util.Inflector", - "doc": "

Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the\nnumber. 21 -> 21st, 22 -> 22nd, 23 -> 23rd, 24 -> 24th etc

\n", - "params": [ - { - "type": "Number", - "name": "number", - "doc": "

The number to ordinalize

\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "

The ordinalized number

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 247, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-ordinalize", - "shortDoc": "Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the\nnumber...." - }, - { - "tagname": "method", - "name": "plural", - "member": "Ext.util.Inflector", - "doc": "

Adds a new pluralization rule to the Inflector. See the intro docs for more information

\n", - "params": [ - { - "type": "RegExp", - "name": "matcher", - "doc": "

The matcher regex

\n", - "optional": false - }, - { - "type": "String", - "name": "replacer", - "doc": "

The replacement string, which can reference matches from the matcher argument

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 153, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-plural", - "shortDoc": "

Adds a new pluralization rule to the Inflector. See the intro docs for more information

\n" - }, - { - "tagname": "method", - "name": "pluralize", - "member": "Ext.util.Inflector", - "doc": "

Returns the pluralized form of a word (e.g. Ext.util.Inflector.pluralize('word') returns 'words')

\n", - "params": [ - { - "type": "String", - "name": "word", - "doc": "

The word to pluralize

\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "

The pluralized form of the word

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 185, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-pluralize", - "shortDoc": "

Returns the pluralized form of a word (e.g. Ext.util.Inflector.pluralize('word') returns 'words')

\n" - }, - { - "tagname": "method", - "name": "singular", - "member": "Ext.util.Inflector", - "doc": "

Adds a new singularization rule to the Inflector. See the intro docs for more information

\n", - "params": [ - { - "type": "RegExp", - "name": "matcher", - "doc": "

The matcher regex

\n", - "optional": false - }, - { - "type": "String", - "name": "replacer", - "doc": "

The replacement string, which can reference matches from the matcher argument

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 144, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-singular", - "shortDoc": "

Adds a new singularization rule to the Inflector. See the intro docs for more information

\n" - }, - { - "tagname": "method", - "name": "singularize", - "member": "Ext.util.Inflector", - "doc": "

Returns the singularized form of a word (e.g. Ext.util.Inflector.singularize('words') returns 'word')

\n", - "params": [ - { - "type": "String", - "name": "word", - "doc": "

The word to singularize

\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "

The singularized form of the word

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 211, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector-method-singularize", - "shortDoc": "

Returns the singularized form of a word (e.g. Ext.util.Inflector.singularize('words') returns 'word')

\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Inflector.js", - "linenr": 1, - "html_filename": "Inflector.html", - "href": "Inflector.html#Ext-util-Inflector", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_util_Inflector({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.util.Inflector

Files

General purpose inflector class that pluralizes, singularizes and\nordinalizes words. Sample usage:

\n\n
//turning singular words into plurals\nExt.util.Inflector.pluralize('word'); //'words'\nExt.util.Inflector.pluralize('person'); //'people'\nExt.util.Inflector.pluralize('sheep'); //'sheep'\n\n//turning plurals into singulars\nExt.util.Inflector.singularize('words'); //'word'\nExt.util.Inflector.singularize('people'); //'person'\nExt.util.Inflector.singularize('sheep'); //'sheep'\n\n//ordinalizing numbers\nExt.util.Inflector.ordinalize(11); //\"11th\"\nExt.util.Inflector.ordinalize(21); //\"21th\"\nExt.util.Inflector.ordinalize(1043); //\"1043rd\"\n
\n\n

Customization

\n\n

The Inflector comes with a default set of US English pluralization rules. These can be augmented with additional\nrules if the default rules do not meet your application's requirements, or swapped out entirely for other languages.\nHere is how we might add a rule that pluralizes \"ox\" to \"oxen\":

\n\n
Ext.util.Inflector.plural(/^(ox)$/i, \"$1en\");\n
\n\n

Each rule consists of two items - a regular expression that matches one or more rules, and a replacement string. In\nthis case, the regular expression will only match the string \"ox\", and will replace that match with \"oxen\". Here's\nhow we could add the inverse rule:

\n\n
Ext.util.Inflector.singular(/^(ox)en$/i, \"$1\");\n
\n\n

Note that the ox/oxen rules are present by default.

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

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 correct Model name for a given string. ...

Returns the correct Model name for a given string. Mostly used internally by the data\npackage

\n

Parameters

  • word : String

    The word to classify

    \n

Returns

  • String

    The classified version of the word

    \n
Removes all registered pluralization rules ...

Removes all registered pluralization rules

\n
Removes all registered singularization rules ...

Removes all registered singularization rules

\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
Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. ...

Returns true if the given word is transnumeral (the word is its own singular and plural form - e.g. sheep, fish)

\n

Parameters

  • word : String

    The word to test

    \n

Returns

  • Boolean

    True if the word is transnumeral

    \n
Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the\nnumber. ...

Ordinalizes a given number by adding a prefix such as 'st', 'nd', 'rd' or 'th' based on the last digit of the\nnumber. 21 -> 21st, 22 -> 22nd, 23 -> 23rd, 24 -> 24th etc

\n

Parameters

  • number : Number

    The number to ordinalize

    \n

Returns

  • String

    The ordinalized number

    \n
Adds a new pluralization rule to the Inflector. ...

Adds a new pluralization rule to the Inflector. See the intro docs for more information

\n

Parameters

  • matcher : RegExp

    The matcher regex

    \n
  • replacer : String

    The replacement string, which can reference matches from the matcher argument

    \n
Returns the pluralized form of a word (e.g. ...

Returns the pluralized form of a word (e.g. Ext.util.Inflector.pluralize('word') returns 'words')

\n

Parameters

  • word : String

    The word to pluralize

    \n

Returns

  • String

    The pluralized form of the word

    \n
Adds a new singularization rule to the Inflector. ...

Adds a new singularization rule to the Inflector. See the intro docs for more information

\n

Parameters

  • matcher : RegExp

    The matcher regex

    \n
  • replacer : String

    The replacement string, which can reference matches from the matcher argument

    \n
Returns the singularized form of a word (e.g. ...

Returns the singularized form of a word (e.g. Ext.util.Inflector.singularize('words') returns 'word')

\n

Parameters

  • word : String

    The word to singularize

    \n

Returns

  • String

    The singularized form of the word

    \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

","allMixins":[],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.util.Inflector"],"singleton":true,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"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":[],"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.Inflector","template":false,"required":null,"protected":false,"name":"classify","id":"method-classify"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Inflector","template":false,"required":null,"protected":false,"name":"clearPlurals","id":"method-clearPlurals"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Inflector","template":false,"required":null,"protected":false,"name":"clearSingulars","id":"method-clearSingulars"},{"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.Inflector","template":false,"required":null,"protected":false,"name":"isTransnumeral","id":"method-isTransnumeral"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Inflector","template":false,"required":null,"protected":false,"name":"ordinalize","id":"method-ordinalize"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Inflector","template":false,"required":null,"protected":false,"name":"plural","id":"method-plural"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Inflector","template":false,"required":null,"protected":false,"name":"pluralize","id":"method-pluralize"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Inflector","template":false,"required":null,"protected":false,"name":"singular","id":"method-singular"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Inflector","template":false,"required":null,"protected":false,"name":"singularize","id":"method-singularize"},{"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.util.Inflector","alternateClassNames":[],"id":"class-Ext.util.Inflector","mixedInto":[],"xtypes":{},"files":[{"href":"Inflector.html#Ext-util-Inflector","filename":"Inflector.js"}]}); \ No newline at end of file