X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..HEAD:/docs/output/Ext.data.JsonP.js diff --git a/docs/output/Ext.data.JsonP.js b/docs/output/Ext.data.JsonP.js index 5850908e..059e9400 100644 --- a/docs/output/Ext.data.JsonP.js +++ b/docs/output/Ext.data.JsonP.js @@ -1,154 +1 @@ -Ext.data.JsonP.Ext_data_JsonP({ - "tagname": "class", - "name": "Ext.data.JsonP", - "doc": "

This class is used to create JSONP requests. JSONP is a mechanism that allows for making\nrequests for data cross domain. More information is available here:\nhttp://en.wikipedia.org/wiki/JSONP

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

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

\n", - "params": [ - { - "type": "Object/String", - "name": "request", - "doc": "

(Optional) The request to abort

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

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

\n" - }, - { - "tagname": "method", - "name": "request", - "member": "Ext.data.JsonP", - "doc": "

Makes a JSONP request.

\n", - "params": [ - { - "type": "Object", - "name": "options", - "doc": "

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

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

request An object containing the request details.

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js", - "linenr": 52, - "html_filename": "JsonP.html", - "href": "JsonP.html#Ext-data-JsonP-method-request", - "shortDoc": "

Makes a JSONP request.

\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "callbackKey", - "member": "Ext.data.JsonP", - "type": "String", - "doc": "

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

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js", - "linenr": 43, - "html_filename": "JsonP.html", - "href": "JsonP.html#Ext-data-JsonP-property-callbackKey", - "shortDoc": "Specifies the GET parameter that will be sent to the server containing the function name to be executed when\nthe requ..." - }, - { - "tagname": "property", - "name": "disableCaching", - "member": "Ext.data.JsonP", - "type": "Boolean", - "doc": "

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

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js", - "linenr": 29, - "html_filename": "JsonP.html", - "href": "JsonP.html#Ext-data-JsonP-property-disableCaching" - }, - { - "tagname": "property", - "name": "disableCachingParam", - "member": "Ext.data.JsonP", - "type": "String", - "doc": "

Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc'.

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js", - "linenr": 36, - "html_filename": "JsonP.html", - "href": "JsonP.html#Ext-data-JsonP-property-disableCachingParam" - }, - { - "tagname": "property", - "name": "timeout", - "member": "Ext.data.JsonP", - "type": "Number", - "doc": "

A default timeout for any JsonP requests. If the request has not completed in this time the\nfailure callback will be fired. The timeout is in ms. Defaults to 30000.

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js", - "linenr": 21, - "html_filename": "JsonP.html", - "href": "JsonP.html#Ext-data-JsonP-property-timeout", - "shortDoc": "A default timeout for any JsonP requests. If the request has not completed in this time the\nfailure callback will be ..." - } - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js", - "linenr": 1, - "html_filename": "JsonP.html", - "href": "JsonP.html#Ext-data-JsonP", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_JsonP({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.data.JsonP

Files

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

\n
Defined By

Properties

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

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

\n
True to add a unique cache-buster param to requests. ...

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

\n
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'.

\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 default timeout for any JsonP requests. ...

A default timeout for any JsonP requests. If the request has not completed in this time the\nfailure callback will be fired. The timeout is in ms. Defaults to 30000.

\n
Defined By

Methods

Abort a request. ...

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

\n

Parameters

( 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
Makes a JSONP request. ...

Makes a JSONP request.

\n

Parameters

  • options : Object

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

    \n\n
      \n
    • url : String
      The URL to request.
    • \n
    • params : Object (Optional)
      An object containing a series of\nkey value pairs that will be sent along with the request.
    • \n
    • timeout : Number (Optional)
    • \n
    • callbackKey : String (Optional)
    • \n
    • callbackName : String (Optional)
      The function name to use for this request.\nBy default this name will be auto-generated: Ext.data.JsonP.callback1, Ext.data.JsonP.callback2, etc.\nSetting this option to \"my_name\" will force the function name to be Ext.data.JsonP.my_name.\nUse this if you want deterministic behavior, but be careful - the callbackName should be different\nin each JsonP request that you make.
    • \n
    • disableCaching : Boolean (Optional)
    • \n
    • disableCachingParam : String (Optional)
    • \n
    • success : Function (Optional)
      A function to execute if the request succeeds.
    • \n
    • failure : Function (Optional)
      A function to execute if the request fails.
    • \n
    • callback : Function (Optional)
      A function to execute when the request\ncompletes, whether it is a success or failure.
    • \n
    • scope : Object (Optional)
      The scope in\nwhich to execute the callbacks: The \"this\" object for the callback function. Defaults to the browser window.
    • \n
    \n\n

Returns

  • Object

    request An object containing the request details.

    \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.data.JsonP"],"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.JsonP","template":null,"required":null,"protected":false,"name":"callbackKey","id":"property-callbackKey"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.JsonP","template":null,"required":null,"protected":false,"name":"disableCaching","id":"property-disableCaching"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.data.JsonP","template":null,"required":null,"protected":false,"name":"disableCachingParam","id":"property-disableCachingParam"},{"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.JsonP","template":null,"required":null,"protected":false,"name":"timeout","id":"property-timeout"}],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.JsonP","template":false,"required":null,"protected":false,"name":"abort","id":"method-abort"},{"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.data.JsonP","template":false,"required":null,"protected":false,"name":"request","id":"method-request"},{"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.JsonP","alternateClassNames":[],"id":"class-Ext.data.JsonP","mixedInto":[],"xtypes":{},"files":[{"href":"JsonP.html#Ext-data-JsonP","filename":"JsonP.js"}]}); \ No newline at end of file