Touch 2.0.2 Sencha Docs

Ext.util.Format

Hierarchy

Ext.Base
Ext.util.Format

Requires

Files

Reusable data formatting functions

Available since: 1.1.0

Properties

Defined By

Instance properties

Ext.util.Format
view source
: RegExpprivate
...

Defaults to: /-/g

Available since: 2.0.0

The global default date format. ...

The global default date format.

Defaults to: 'm/d/Y'

Available since: 1.1.0

Ext.util.Format
view source
: RegExpprivate
...

Defaults to: /('|\)/g

Available since: 1.1.0

Ext.util.Format
view source
: RegExpprivate
...

Defaults to: /([-.*+?^${}()|[\]\/\])/g

Available since: 1.1.0

Ext.util.Format
view source
: RegExpprivate
...

Defaults to: /\{(\d+)\}/g

Available since: 1.1.0

Ext.util.Format
view source
: RegExpprivate
...

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

Available since: 2.0.0

Ext.util.Format
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.util.Format
view source
: RegExpprivate
...

Defaults to: /^[\x09\x0a\x0b\x0c\x0d\x20\xa0\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000]+|[\x09\x0a\x0b\x0c\x0d\x20\xa0\u1680\u180e\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000]+$/g

Available since: 1.1.0

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

Ext.util.Format
view source
( value, [format] ) : String
Parse a value into a formatted date using the specified format pattern. ...

Parse a value into a formatted date using the specified format pattern.

Available since: 1.1.0

Parameters

  • value : String/Date

    The value to format (Strings must conform to the format expected by the javascript Date object's parse() method)

  • format : String (optional)

    Any valid date format string (defaults to 'm/d/Y')

Returns

  • String

    The formatted date string

Ext.util.Format
view source
( value, length, word ) : String
Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length ...

Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length

Available since: 1.1.0

Parameters

  • value : String

    The string to truncate

  • length : Number

    The maximum length to allow before truncating

  • word : Boolean

    True to try to find a common word break

Returns

Ext.util.Format
view source
( string ) : String
Escapes the passed string for ' and \ ...

Escapes the passed string for ' and \

Available since: 1.1.1

Parameters

  • string : String

    The string to escape

Returns

Ext.util.Format
view source
( str ) : String
Escapes the passed string for use in a regular expression ...

Escapes the passed string for use in a regular expression

Available since: 1.1.0

Parameters

Returns

Ext.util.Format
view source
( string, values ) : String
Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. ...

Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each token must be unique, and must increment in the format {0}, {1}, etc. Example usage:

var cls = 'my-class', text = 'Some text';
var s = Ext.util.Format.format('<div class="{0}">{1}</div>', cls, text);
// s now contains the string: '<div class="my-class">Some text</div>'
       

Available since: 1.1.1

Parameters

  • string : String

    The tokenized string to be formatted

  • values : String...

    The values to replace token {0}, {1}, etc

Returns

...

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

Ext.util.Format
view source
( value ) : String
Convert certain characters (&, <, >, and ') from their HTML character equivalents. ...

Convert certain characters (&, <, >, and ') from their HTML character equivalents.

Available since: 1.1.0

Parameters

  • value : String

    The string to decode

Returns

Ext.util.Format
view source
( value ) : String
Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. ...

Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.

Available since: 1.1.0

Parameters

  • value : String

    The string to encode

Returns

( 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

    Ext.util.Format
    view source
    ( string, size, [char] ) : String
    Pads the left side of a string with a specified character. ...

    Pads the left side of a string with a specified character. This is especially useful for normalizing number and date strings. Example usage:

    var s = Ext.util.Format.leftPad('123', 5, '0');
    // s now contains the string: '00123'
           

    Available since: 1.1.1

    Parameters

    • string : String

      The original string

    • size : Number

      The total length of the output string

    • char : String (optional)

      The character with which to pad the original string (defaults to empty string " ")

    Returns

    ( 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

    Ext.util.Format
    view source
    ( string, value, other ) : String
    Utility function that allows you to easily switch a string between two alternating values. ...

    Utility function that allows you to easily switch a string between two alternating values. The passed value is compared to the current string, and if they are equal, the other value that was passed in is returned. If they are already different, the first value passed in is returned. Note that this method returns the new value but does not change the current string.

        // alternate sort directions
        sort = Ext.util.Format.toggle(sort, 'ASC', 'DESC');
    
        // instead of conditional logic:
        sort = (sort == 'ASC' ? 'DESC' : 'ASC');
           

    Available since: 1.1.0

    Parameters

    • string : String

      The current string

    • value : String

      The value to compare to the current string

    • other : String

      The new value to use if the string already equals the first value passed in

    Returns

    Ext.util.Format
    view source
    ( string ) : String
    Trims whitespace from either end of a string, leaving spaces within the string intact. ...

    Trims whitespace from either end of a string, leaving spaces within the string intact. Example:

        var s = '  foo bar  ';
        alert('-' + s + '-');         //alerts "- foo bar -"
        alert('-' + Ext.util.Format.trim(s) + '-');  //alerts "-foo bar-"
           

    Available since: 1.1.0

    Parameters

    • string : String

      The string to escape

    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