Touch 2.0.2 Sencha Docs

Ext.data.Types

Hierarchy

Ext.Base
Ext.data.Types

Requires

Files

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

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

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

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

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 which contained the properties lat and long, you would define a new data type like this:

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

Then, when declaring a Model, use

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

Available since: 1.1.1

Properties

Defined By

Instance properties

Ext.data.Types
view source
: Object

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

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

Available since: 1.1.1

Ext.data.Types
view source
: Object
This data type means that the raw data is converted into a boolean before it is placed into a Record. ...

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

The synonym BOOLEAN is equivalent.

Available since: 1.1.1

Ext.data.Types
view source
: Object
This data type means that the raw data is converted into a boolean before it is placed into a Record. ...

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

The synonym BOOL is equivalent.

Available since: 1.1.1

Ext.data.Types
view source
: Object
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. The date format is specified in the constructor of the Ext.data.Field to which this type is being applied.

Available since: 1.1.1

Ext.data.Types
view source
: Object
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.

The synonym NUMBER is equivalent.

Available since: 1.1.1

Ext.data.Types
view source
: Object
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.

The synonym INTEGER is equivalent.

Available since: 1.1.1

Ext.data.Types
view source
: Object
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.

The synonym INT is equivalent.

Available since: 1.1.1

Ext.data.Types
view source
: Object
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.

The synonym FLOAT is equivalent.

Available since: 1.1.1

Ext.data.Types
view source
: Object

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

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

Available since: 1.1.1

Ext.data.Types
view source
: RegExpprivate
...

Defaults to: /-/g

Available since: 2.0.0

Ext.data.Types
view source
: RegExpprivate
...

Defaults to: /[- :T\.Z\+]/

Available since: 2.0.0

Ext.data.Types
view source
: RegExpprivate
...

Defaults to: /\d\dT\d\d/

Available since: 2.0.0

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, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); / dependentOL on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 2.0.0

Ext.data.Types
view source
: RegExp
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. This should be overridden for localization.

Defaults to: /[$,%]/g

Available since: 1.1.1

Defined By

Static properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance methods

Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Available since: 2.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

  • Object

    Returns the result of calling the overridden method

Call the "parent" method of the current method. ...

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10);     // alerts 10
 alert(My.Derived2.method(10); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

Available since: 2.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

  • Object

    Returns the result of calling the parent method

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Returns the initial configuration passed to constructor. ...

Returns the initial configuration passed to constructor.

Available since: 2.0.0

Parameters

  • name : String (optional)

    When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

...

Available since: 2.0.0

Parameters

( instanceConfig ) : Objectchainableprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Available since: 2.0.0

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

Fires

    ( names, callback, scope )private
    ...

    Available since: 2.0.0

    Parameters

    ( config, applyIfNotSet ) : Ext.Basechainableprivate
    ...

    Available since: 2.0.0

    Parameters

    Returns

    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, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

    Ext.define('My.Cat', {
        statics: {
            totalCreated: 0,
            speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
        },
    
        constructor: function() {
            var statics = this.statics();
    
            alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                            // equivalent to: My.Cat.speciesName
    
            alert(this.self.speciesName);   // dependent on 'this'
    
            statics.totalCreated++;
        },
    
        clone: function() {
            var cloned = new this.self;                      // dependent on 'this'
    
            cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
    
            return cloned;
        }
    });
    
    
    Ext.define('My.SnowLeopard', {
        extend: 'My.Cat',
    
        statics: {
            speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
        },
    
        constructor: function() {
            this.callParent();
        }
    });
    
    var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
    
    var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
    
    var clone = snowLeopard.clone();
    alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
    alert(clone.groupName);                 // alerts 'Cat'
    
    alert(My.Cat.totalCreated);             // alerts 3
    

    Available since: 2.0.0

    Returns

    Defined By

    Static methods

    ( config, fullMerge )privatestatic
    ...

    Available since: 2.0.0

    Parameters

    ( members )chainableprivatestatic
    ...

    Available since: 2.0.0

    Parameters

    ( name, member )chainableprivatestatic
    ...

    Available since: 2.0.0

    Parameters

    ( members )chainablestatic
    Add methods / properties to the prototype of this class. ...

    Add methods / properties to the prototype of this class.

    Ext.define('My.awesome.Cat', {
        constructor: function() {
            ...
        }
    });
    
     My.awesome.Cat.implement({
         meow: function() {
            alert('Meowww...');
         }
     });
    
     var kitty = new My.awesome.Cat;
     kitty.meow();
    

    Available since: 2.0.0

    Parameters

    ( members ) : Ext.Basechainablestatic
    Add / override static properties of this class. ...

    Add / override static properties of this class.

    Ext.define('My.cool.Class', {
        ...
    });
    
    My.cool.Class.addStatics({
        someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
        method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
        method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
    });
    

    Available since: 2.0.0

    Parameters

    Returns

    ( xtype )chainableprivatestatic
    ...

    Available since: 2.0.0

    Parameters

    ( fromClass, members ) : Ext.Basechainableprivatestatic
    Borrow another class' members to the prototype of this class. ...

    Borrow another class' members to the prototype of this class.

    Ext.define('Bank', {
        money: '$$$',
        printMoney: function() {
            alert('$$$$$$$');
        }
    });
    
    Ext.define('Thief', {
        ...
    });
    
    Thief.borrow(Bank, ['money', 'printMoney']);
    
    var steve = new Thief();
    
    alert(steve.money); // alerts '$$$'
    steve.printMoney(); // alerts '$$$$$$$'
    

    Available since: 2.0.0

    Parameters

    • fromClass : Ext.Base

      The class to borrow members from

    • members : Array/String

      The names of the members to borrow

    Returns

    ( args )privatestatic
    ...

    Available since: 2.0.0

    Parameters

    Create a new instance of this Class. ...

    Create a new instance of this Class.

    Ext.define('My.cool.Class', {
        ...
    });
    
    My.cool.Class.create({
        someConfig: true
    });
    

    All parameters are passed to the constructor of the class.

    Available since: 2.0.0

    Returns

    ( alias, origin )static
    Create aliases for existing prototype methods. ...

    Create aliases for existing prototype methods. Example:

    Ext.define('My.cool.Class', {
        method1: function() { ... },
        method2: function() { ... }
    });
    
    var test = new My.cool.Class();
    
    My.cool.Class.createAlias({
        method3: 'method1',
        method4: 'method2'
    });
    
    test.method3(); // test.method1()
    
    My.cool.Class.createAlias('method5', 'method3');
    
    test.method5(); // test.method3() -> test.method1()
    

    Available since: 2.0.0

    Parameters

    ( parent )privatestatic
    ...

    Available since: 2.0.0

    Parameters

    Get the current class' name in string format. ...

    Get the current class' name in string format.

    Ext.define('My.cool.Class', {
        constructor: function() {
            alert(this.self.getName()); // alerts 'My.cool.Class'
        }
    });
    
    My.cool.Class.getName(); // 'My.cool.Class'
    

    Available since: 2.0.0

    Returns

    ...

    Available since: 2.0.0

    ( name, mixinClass )privatestatic
    Used internally by the mixins pre-processor ...

    Used internally by the mixins pre-processor

    Available since: 2.0.0

    Parameters

    ( fn, scope )chainableprivatestatic
    ...

    Available since: 2.0.0

    Parameters

    ( members ) : Ext.Basechainabledeprecatedstatic
    Override members of this class. ...

    Override members of this class. Overridden methods can be invoked via callParent.

    Ext.define('My.Cat', {
        constructor: function() {
            alert("I'm a cat!");
        }
    });
    
    My.Cat.override({
        constructor: function() {
            alert("I'm going to be a cat!");
    
            var instance = this.callParent(arguments);
    
            alert("Meeeeoooowwww");
    
            return instance;
        }
    });
    
    var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                              // alerts "I'm a cat!"
                              // alerts "Meeeeoooowwww"
    

    As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

    Ext.define('My.CatOverride', {
        override: 'My.Cat',
        constructor: function() {
            alert("I'm going to be a cat!");
    
            var instance = this.callParent(arguments);
    
            alert("Meeeeoooowwww");
    
            return instance;
        }
    });
    

    The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

    Available since: 2.0.0

    This method has been deprecated since 4.1.0

    Please use Ext.define instead

    Parameters

    • members : Object

      The properties to add to this class. This should be specified as an object literal containing one or more properties.

    Returns

    ...

    Available since: 2.0.0