X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.data.Types.js diff --git a/docs/output/Ext.data.Types.js b/docs/output/Ext.data.Types.js index b0613d23..7d399a93 100644 --- a/docs/output/Ext.data.Types.js +++ b/docs/output/Ext.data.Types.js @@ -1,189 +1 @@ -Ext.data.JsonP.Ext_data_Types({ - "tagname": "class", - "name": "Ext.data.Types", - "doc": "

This is s static class containing the system-supplied data types which may be given to a Field.

\n

The properties in this class are used as type indicators in the Field class, so to\ntest whether a Field is of a certain type, compare the type property against properties\nof this class.

\n

Developers may add their own application-specific data types to this class. Definition names must be UPPERCASE.\neach type definition must contain three properties:

\n
\n

For example, to create a VELatLong field (See the Microsoft Bing Mapping API) containing the latitude/longitude value of a datapoint on a map from a JsonReader data block\nwhich contained the properties lat and long, you would define a new data type like this:

\n
// Add a new Field data type which stores a VELatLong object in the Record.\nExt.data.Types.VELATLONG = {\n    convert: function(v, data) {\n        return new VELatLong(data.lat, data.long);\n    },\n    sortType: function(v) {\n        return v.Latitude;  // When sorting, order by latitude\n    },\n    type: 'VELatLong'\n};\n
\n

Then, when declaring a Model, use \n

var types = Ext.data.Types; // allow shorthand type access\nExt.define('Unit',\n    extend: 'Ext.data.Model', \n    fields: [\n        { name: 'unitName', mapping: 'UnitName' },\n        { name: 'curSpeed', mapping: 'CurSpeed', type: types.INT },\n        { name: 'latitude', mapping: 'lat', type: types.FLOAT },\n        { name: 'latitude', mapping: 'lat', type: types.FLOAT },\n        { name: 'position', type: types.VELATLONG }\n    ]\n});\n
\n\n", - "extends": null, - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": true, - "private": false, - "cfg": [ - - ], - "method": [ - - ], - "property": [ - { - "tagname": "property", - "name": "AUTO", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that no conversion is applied to the raw data before it is placed into a Record.

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 66, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-AUTO" - }, - { - "tagname": "property", - "name": "BOOL", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that the raw data is converted into a boolean before it is placed into\na Record. The string \"true\" and the number 1 are converted to boolean true.

\n\n\n

The synonym BOOLEAN is equivalent.

\n\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 123, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-BOOL", - "shortDoc": "This data type means that the raw data is converted into a boolean before it is placed into\na Record. The string \"tru..." - }, - { - "tagname": "property", - "name": "BOOLEAN", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that the raw data is converted into a boolean before it is placed into\na Record. The string \"true\" and the number 1 are converted to boolean true.

\n\n\n

The synonym BOOL is equivalent.

\n\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 176, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-BOOLEAN", - "shortDoc": "This data type means that the raw data is converted into a boolean before it is placed into\na Record. The string \"tru..." - }, - { - "tagname": "property", - "name": "DATE", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that the raw data is converted into a Date before it is placed into a Record.\nThe date format is specified in the constructor of the Ext.data.Field to which this type is\nbeing applied.

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 141, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-DATE", - "shortDoc": "This data type means that the raw data is converted into a Date before it is placed into a Record.\nThe date format is..." - }, - { - "tagname": "property", - "name": "FLOAT", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that the raw data is converted into a number before it is placed into a Record.

\n\n

The synonym NUMBER is equivalent.

\n\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 108, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-FLOAT", - "shortDoc": "This data type means that the raw data is converted into a number before it is placed into a Record.\n\nThe synonym NUM..." - }, - { - "tagname": "property", - "name": "INT", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that the raw data is converted into an integer before it is placed into a Record.

\n\n

The synonym INTEGER is equivalent.

\n\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 93, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-INT", - "shortDoc": "This data type means that the raw data is converted into an integer before it is placed into a Record.\n\nThe synonym I..." - }, - { - "tagname": "property", - "name": "INTEGER", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that the raw data is converted into an integer before it is placed into a Record.

\n\n

The synonym INT is equivalent.

\n\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 185, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-INTEGER", - "shortDoc": "This data type means that the raw data is converted into an integer before it is placed into a Record.\n\nThe synonym I..." - }, - { - "tagname": "property", - "name": "NUMBER", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that the raw data is converted into a number before it is placed into a Record.

\n\n

The synonym FLOAT is equivalent.

\n\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 193, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-NUMBER", - "shortDoc": "This data type means that the raw data is converted into a number before it is placed into a Record.\n\nThe synonym FLO..." - }, - { - "tagname": "property", - "name": "STRING", - "member": "Ext.data.Types", - "type": "Object.", - "doc": "

This data type means that the raw data is converted into a String before it is placed into a Record.

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 79, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-STRING" - }, - { - "tagname": "property", - "name": "stripRe", - "member": "Ext.data.Types", - "type": "Regexp", - "doc": "

A regular expression for stripping non-numeric characters from a numeric value. Defaults to /[\\$,%]/g.\nThis should be overridden for localization.

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 58, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types-property-stripRe", - "shortDoc": "A regular expression for stripping non-numeric characters from a numeric value. Defaults to /[\\$,%]/g.\nThis should be..." - } - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Types.js", - "linenr": 1, - "html_filename": "Types.html", - "href": "Types.html#Ext-data-Types", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_Types({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.data.Types

Requires

Files

This is a static class containing the system-supplied data types which may be given to a Field.

\n

The properties in this class are used as type indicators in the Field class, so to\ntest whether a Field is of a certain type, compare the type property against properties\nof this class.

\n

Developers may add their own application-specific data types to this class. Definition names must be UPPERCASE.\neach type definition must contain three properties:

\n
    \n
  • convert : Function
    A function to convert raw data values from a data block into the data\nto be stored in the Field. The function is passed the collowing parameters:\n
      \n
    • v : Mixed
      The data value as read by the Reader, if undefined will use\nthe configured defaultValue.
    • \n
    • rec : Mixed
      The data object containing the row as read by the Reader.\nDepending on the Reader type, this could be an Array (ArrayReader), an object\n(JsonReader), or an XML element.
    • \n
  • \n
  • sortType : Function
    A function to convert the stored data into comparable form, as defined by Ext.data.SortTypes.
  • \n
  • type : String
    A textual data type name.
  • \n
\n

For example, to create a VELatLong field (See the Microsoft Bing Mapping API) containing the latitude/longitude value of a datapoint on a map from a JsonReader data block\nwhich contained the properties lat and long, you would define a new data type like this:

\n
// Add a new Field data type which stores a VELatLong object in the Record.\nExt.data.Types.VELATLONG = {\n    convert: function(v, data) {\n        return new VELatLong(data.lat, data.long);\n    },\n    sortType: function(v) {\n        return v.Latitude;  // When sorting, order by latitude\n    },\n    type: 'VELatLong'\n};\n
\n

Then, when declaring a Model, use: \n

var types = Ext.data.Types; // allow shorthand type access\nExt.define('Unit',\n    extend: 'Ext.data.Model',\n    fields: [\n        { name: 'unitName', mapping: 'UnitName' },\n        { name: 'curSpeed', mapping: 'CurSpeed', type: types.INT },\n        { name: 'latitude', mapping: 'lat', type: types.FLOAT },\n        { name: 'longitude', mapping: 'long', type: types.FLOAT },\n        { name: 'position', type: types.VELATLONG }\n    ]\n});\n
\n\n
Defined By

Properties

 

This data type means that no conversion is applied to the raw data before it is placed into a Record.

\n

This data type means that no conversion is applied to the raw data before it is placed into a Record.

\n
This data type means that the raw data is converted into a boolean before it is placed into\na Record. ...

This data type means that the raw data is converted into a boolean before it is placed into\na Record. The string \"true\" and the number 1 are converted to boolean true.

\n\n\n

The synonym BOOLEAN is equivalent.

\n\n
This data type means that the raw data is converted into a boolean before it is placed into\na Record. ...

This data type means that the raw data is converted into a boolean before it is placed into\na Record. The string \"true\" and the number 1 are converted to boolean true.

\n\n\n

The synonym BOOL is equivalent.

\n\n
This data type means that the raw data is converted into a Date before it is placed into a Record. ...

This data type means that the raw data is converted into a Date before it is placed into a Record.\nThe date format is specified in the constructor of the Ext.data.Field to which this type is\nbeing applied.

\n
This data type means that the raw data is converted into a number before it is placed into a Record. ...

This data type means that the raw data is converted into a number before it is placed into a Record.

\n\n

The synonym NUMBER is equivalent.

\n\n
This data type means that the raw data is converted into an integer before it is placed into a Record. ...

This data type means that the raw data is converted into an integer before it is placed into a Record.

\n\n

The synonym INTEGER is equivalent.

\n\n
This data type means that the raw data is converted into an integer before it is placed into a Record. ...

This data type means that the raw data is converted into an integer before it is placed into a Record.

\n\n

The synonym INT is equivalent.

\n\n
This data type means that the raw data is converted into a number before it is placed into a Record. ...

This data type means that the raw data is converted into a number before it is placed into a Record.

\n\n

The synonym FLOAT is equivalent.

\n\n
 

This data type means that the raw data is converted into a String before it is placed into a Record.

\n

This data type means that the raw data is converted into a String before it is placed into a Record.

\n
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
A regular expression for stripping non-numeric characters from a numeric value. ...

A regular expression for stripping non-numeric characters from a numeric value. Defaults to /[\\$,%]/g.\nThis should be overridden for localization.

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

","allMixins":[],"meta":{},"requires":["Ext.data.SortTypes"],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.data.Types"],"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.data.Types","template":null,"required":null,"protected":false,"name":"AUTO","id":"property-AUTO"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"BOOL","id":"property-BOOL"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"BOOLEAN","id":"property-BOOLEAN"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"DATE","id":"property-DATE"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"FLOAT","id":"property-FLOAT"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"INT","id":"property-INT"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"INTEGER","id":"property-INTEGER"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"NUMBER","id":"property-NUMBER"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"STRING","id":"property-STRING"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.Types","template":null,"required":null,"protected":false,"name":"stripRe","id":"property-stripRe"}],"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.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.Types","alternateClassNames":[],"id":"class-Ext.data.Types","mixedInto":[],"xtypes":{},"files":[{"href":"Types.html#Ext-data-Types","filename":"Types.js"}]}); \ No newline at end of file