Touch 2.1.1 Sencha Docs

Ext.data.JsonP

Alternate names

Ext.util.JSONP

Hierarchy

Ext.Base
Ext.data.JsonP

Files

This class is used to create JsonP requests. JsonP is a mechanism that allows for making requests for data cross domain. More information is available here.

Example

Ext.Viewport.add({
    xtype: 'button',
    text: 'Make JsonP Request',
    centered: true,
    handler: function(button) {
        // Mask the viewport
        Ext.Viewport.mask();

        // Remove the button
        button.destroy();

        // Make the JsonP request
        Ext.data.JsonP.request({
            url: 'http://free.worldweatheronline.com/feed/weather.ashx',
            callbackKey: 'callback',
            params: {
                key: '23f6a0ab24185952101705',
                q: '94301', // Palo Alto
                format: 'json',
                num_of_days: 5
            },
            success: function(result, request) {
                // Unmask the viewport
                Ext.Viewport.unmask();

                // Get the weather data from the json object result
                var weather = result.data.weather;
                if (weather) {
                    // Style the viewport html, and set the html of the max temperature
                    Ext.Viewport.setStyleHtmlContent(true);
                    Ext.Viewport.setHtml('The temperature in Palo Alto is <b>' + weather[0].tempMaxF + '° F</b>');
                }
            }
        });
    }
});

See the request method for more details on making a JsonP request.

Available since: 1.1.0

Properties

Defined By

Instance properties

Specifies the GET parameter that will be sent to the server containing the function name to be executed when the requ...

Specifies the GET parameter that will be sent to the server containing the function name to be executed when the request completes. Thus, a common request will be in the form of: url?callback=Ext.data.JsonP.callback1

Defaults to: 'callback'

Available since: 2.0.0

true to add a unique cache-buster param to requests. ...

true to add a unique cache-buster param to requests.

Defaults to: true

Available since: 2.0.0

Change the parameter which is sent went disabling caching through a cache buster. ...

Change the parameter which is sent went disabling caching through a cache buster.

Defaults to: '_dc'

Available since: 2.0.0

Ext.data.JsonP
view source
: Numberprivate
Number of requests done so far. ...

Number of requests done so far.

Defaults to: 0

Available since: 2.0.2

Ext.data.JsonP
view source
: Objectprivate
Hash of pending requests. ...

Hash of pending requests.

Defaults to: {}

Available since: 2.0.2

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); // dependent 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.JsonP
view source
: Number
A default timeout (in milliseconds) for any JsonP requests. ...

A default timeout (in milliseconds) for any JsonP requests. If the request has not completed in this time the failure callback will be fired.

Defaults to: 30000

Available since: 2.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance methods

Ext.data.JsonP
view source
( request )
Abort a request. ...

Abort a request. If the request parameter is not specified all open requests will be aborted.

Available since: 2.0.0

Parameters

Fires

    ( args ) : Objectdeprecatedprotected
    Call the original method that was previously overridden with override, This method is deprecated as callParent does ...

    Call the original method that was previously overridden with override,

    This method is deprecated as callParent does the same thing.

    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

    This method has been deprecated

    Use callParent instead

    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
    

    To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

    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

    This method is used by an override to call the superclass method but bypass any overridden method. ...

    This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

    Consider:

     Ext.define('Ext.some.Class', {
         method: function () {
             console.log('Good');
         }
     });
    
     Ext.define('Ext.some.DerivedClass', {
         method: function () {
             console.log('Bad');
    
             // ... logic but with a bug ...
    
             this.callParent();
         }
     });
    

    To patch the bug in DerivedClass.method, the typical solution is to create an override:

     Ext.define('App.paches.DerivedClass', {
         override: 'Ext.some.DerivedClass',
    
         method: function () {
             console.log('Fixed');
    
             // ... logic but with bug fixed ...
    
             this.callSuper();
         }
     });
    

    The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

    Available since: 2.1.0

    Parameters

    • args : Array/Arguments

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

    Returns

    • Object

      Returns the result of calling the superclass method

    Ext.data.JsonP
    view source
    ( request )private
    Cleans up any script handling errors. ...

    Cleans up any script handling errors.

    Available since: 2.0.0

    Parameters

    Ext.data.JsonP
    view source
    ( url, params, options )private
    Create the script tag given the specified url, params and options. ...

    Create the script tag given the specified url, params and options. The options parameter is passed to allow an override to access it.

    Available since: 2.0.0

    Parameters

    ...

    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

    Ext.data.JsonP
    view source
    ( request )private
    Handles any aborts when loading the script. ...

    Handles any aborts when loading the script.

    Available since: 2.0.0

    Parameters

    Fires

      Ext.data.JsonP
      view source
      ( request )private
      Handles any script errors when loading the script. ...

      Handles any script errors when loading the script.

      Available since: 2.0.0

      Parameters

      Fires

        Ext.data.JsonP
        view source
        ( result, request )private
        Handle a successful response ...

        Handle a successful response

        Available since: 2.0.0

        Parameters

        • result : Object

          The result from the request

        • request : Object

          The request

        Fires

          Ext.data.JsonP
          view source
          ( request )private
          Handle any script timeouts. ...

          Handle any script timeouts.

          Available since: 2.0.0

          Parameters

          Fires

            ...

            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

              Ext.data.JsonP
              view source
              ( request )private
              Loads the script for the given request by appending it to the HEAD element. ...

              Loads the script for the given request by appending it to the HEAD element. This is its own method so that users can override it (as well as createScript).

              Available since: 2.0.0

              Parameters

              • request : Object

                The request object.

              ( names, callback, scope )private
              ...

              Available since: 2.0.0

              Parameters

              Ext.data.JsonP
              view source
              ( options ) : Object
              Makes a JSONP request. ...

              Makes a JSONP request.

              Available since: 1.1.0

              Parameters

              • options : Object

                An object which may contain the following properties. Note that options will take priority over any defaults that are specified in the class.

                • url : String

                  The URL to request.

                • params : Object (optional)

                  An object containing a series of key value pairs that will be sent along with the request.

                • timeout : Number (optional)

                  See timeout

                • callbackKey : String (optional)
                • callbackName : String (optional)

                  See callbackKey The function name to use for this request. By default this name will be auto-generated: Ext.data.JsonP.callback1, Ext.data.JsonP.callback2, etc. Setting this option to "my_name" will force the function name to be Ext.data.JsonP.my_name. Use this if you want deterministic behavior, but be careful - the callbackName should be different in each JsonP request that you make.

                • disableCaching : Boolean (optional)
                • disableCachingParam : String (optional)
                • success : Function (optional)

                  A function to execute if the request succeeds.

                • failure : Function (optional)

                  A function to execute if the request fails.

                • callback : Function (optional)

                  A function to execute when the request completes, whether it is a success or failure.

                • scope : Object (optional)

                  The scope in which to execute the callbacks: The "this" object for the callback function. Defaults to the browser window.

              Returns

              • Object

                request An object containing the request details.

              Fires

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

                Available since: 2.0.0

                Parameters

                Returns

                Ext.data.JsonP
                view source
                ( request )private
                Sets up error handling for the script. ...

                Sets up error handling for the script.

                Available since: 2.0.0

                Parameters

                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.addMembers({
                     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', {
                    // this.se
                });
                
                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 )protectedstatic
                ...

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