<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
- <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
- <script type="text/javascript" src="../prettify/prettify.js"></script>
+ <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+ <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-ElementLoader'>/**
-</span> * @class Ext.ElementLoader
- * A class used to load remote content to an Element. Sample usage:
- * <pre><code>
-Ext.get('el').load({
- url: 'myPage.php',
- scripts: true,
- params: {
- id: 1
- }
-});
- * </code></pre>
- * <p>
- * In general this class will not be instanced directly, rather the {@link Ext.core.Element#load} method
+</span> * A class used to load remote content to an Element. Sample usage:
+ *
+ * Ext.get('el').load({
+ * url: 'myPage.php',
+ * scripts: true,
+ * params: {
+ * id: 1
+ * }
+ * });
+ *
+ * In general this class will not be instanced directly, rather the {@link Ext.Element#load} method
* will be used.
- * </p>
*/
Ext.define('Ext.ElementLoader', {
'Ext.data.Connection',
'Ext.Ajax'
],
-
+
statics: {
Renderer: {
Html: function(loader, response, active){
loader.getTarget().update(response.responseText, active.scripts === true);
return true;
}
- }
+ }
},
/* End Definitions */
<span id='Ext-ElementLoader-cfg-url'> /**
-</span> * @cfg {String} url The url to retrieve the content from. Defaults to <tt>null</tt>.
+</span> * @cfg {String} url
+ * The url to retrieve the content from.
*/
url: null,
<span id='Ext-ElementLoader-cfg-params'> /**
-</span> * @cfg {Object} params Any params to be attached to the Ajax request. These parameters will
- * be overridden by any params in the load options. Defaults to <tt>null</tt>.
+</span> * @cfg {Object} params
+ * Any params to be attached to the Ajax request. These parameters will
+ * be overridden by any params in the load options.
*/
params: null,
<span id='Ext-ElementLoader-cfg-baseParams'> /**
</span> * @cfg {Object} baseParams Params that will be attached to every request. These parameters
- * will not be overridden by any params in the load options. Defaults to <tt>null</tt>.
+ * will not be overridden by any params in the load options.
*/
baseParams: null,
<span id='Ext-ElementLoader-cfg-autoLoad'> /**
-</span> * @cfg {Boolean/Object} autoLoad True to have the loader make a request as soon as it is created. Defaults to <tt>false</tt>.
+</span> * @cfg {Boolean/Object} autoLoad
+ * True to have the loader make a request as soon as it is created.
* This argument can also be a set of options that will be passed to {@link #load} is called.
*/
autoLoad: false,
<span id='Ext-ElementLoader-cfg-target'> /**
-</span> * @cfg {Mixed} target The target element for the loader. It can be the DOM element, the id or an Ext.Element.
+</span> * @cfg {HTMLElement/Ext.Element/String} target
+ * The target element for the loader. It can be the DOM element, the id or an {@link Ext.Element}.
*/
target: null,
<span id='Ext-ElementLoader-cfg-loadMask'> /**
-</span> * @cfg {Mixed} loadMask True or a string to show when the element is loading.
+</span> * @cfg {Boolean/String} loadMask
+ * True or a string to show when the element is loading.
*/
loadMask: false,
<span id='Ext-ElementLoader-cfg-ajaxOptions'> /**
-</span> * @cfg {Object} ajaxOptions Any additional options to be passed to the request, for example timeout or headers. Defaults to <tt>null</tt>.
+</span> * @cfg {Object} ajaxOptions
+ * Any additional options to be passed to the request, for example timeout or headers.
*/
ajaxOptions: null,
-
+
<span id='Ext-ElementLoader-cfg-scripts'> /**
-</span> * @cfg {Boolean} scripts True to parse any inline script tags in the response.
+</span> * @cfg {Boolean} scripts
+ * True to parse any inline script tags in the response.
*/
scripts: false,
<span id='Ext-ElementLoader-cfg-success'> /**
-</span> * @cfg {Function} success A function to be called when a load request is successful.
+</span> * @cfg {Function} success
+ * A function to be called when a load request is successful.
+ * Will be called with the following config parameters:
+ *
+ * - this - The ElementLoader instance.
+ * - response - The response object.
+ * - options - Ajax options.
*/
<span id='Ext-ElementLoader-cfg-failure'> /**
</span> * @cfg {Function} failure A function to be called when a load request fails.
+ * Will be called with the following config parameters:
+ *
+ * - this - The ElementLoader instance.
+ * - response - The response object.
+ * - options - Ajax options.
+ */
+
+<span id='Ext-ElementLoader-cfg-callback'> /**
+</span> * @cfg {Function} callback A function to be called when a load request finishes.
+ * Will be called with the following config parameters:
+ *
+ * - this - The ElementLoader instance.
+ * - success - True if successful request.
+ * - response - The response object.
+ * - options - Ajax options.
*/
<span id='Ext-ElementLoader-cfg-scope'> /**
-</span> * @cfg {Object} scope The scope to execute the {@link #success} and {@link #failure} functions in.
+</span> * @cfg {Object} scope
+ * The scope to execute the {@link #success} and {@link #failure} functions in.
*/
-
+
<span id='Ext-ElementLoader-cfg-renderer'> /**
-</span> * @cfg {Function} renderer A custom function to render the content to the element. The passed parameters
- * are
- * <ul>
- * <li>The loader</li>
- * <li>The response</li>
- * <li>The active request</li>
- * </ul>
+</span> * @cfg {Function} renderer
+ * A custom function to render the content to the element. The passed parameters are:
+ *
+ * - The loader
+ * - The response
+ * - The active request
*/
isLoader: true,
constructor: function(config) {
var me = this,
autoLoad;
-
+
config = config || {};
Ext.apply(me, config);
me.setTarget(me.target);
*/
'exception',
-<span id='Ext-ElementLoader-event-exception'> /**
-</span> * @event exception
+<span id='Ext-ElementLoader-event-load'> /**
+</span> * @event load
* Fires after a successful load.
* @param {Ext.ElementLoader} this
* @param {Object} response The response from the server
},
<span id='Ext-ElementLoader-method-setTarget'> /**
-</span> * Set an {Ext.Element} as the target of this loader. Note that if the target is changed,
- * any active requests will be aborted.
- * @param {Mixed} target The element
+</span> * Sets an {@link Ext.Element} as the target of this loader.
+ * Note that if the target is changed, any active requests will be aborted.
+ * @param {String/HTMLElement/Ext.Element} target The element or its ID.
*/
setTarget: function(target){
var me = this;
},
<span id='Ext-ElementLoader-method-getTarget'> /**
-</span> * Get the target of this loader.
- * @return {Ext.Component} target The target, null if none exists.
+</span> * Returns the target of this loader.
+ * @return {Ext.Component} The target or null if none exists.
*/
getTarget: function(){
return this.target || null;
delete this.active;
}
},
-
+
<span id='Ext-ElementLoader-method-removeMask'> /**
-</span> * Remove the mask on the target
+</span> * Removes the mask on the target
* @private
*/
removeMask: function(){
this.target.unmask();
},
-
+
<span id='Ext-ElementLoader-method-addMask'> /**
-</span> * Add the mask on the target
+</span> * Adds the mask on the target
* @private
- * @param {Mixed} mask The mask configuration
+ * @param {Boolean/Object} mask The mask configuration
*/
addMask: function(mask){
this.target.mask(mask === true ? null : mask);
},
<span id='Ext-ElementLoader-method-load'> /**
-</span> * Load new data from the server.
+</span> * Loads new data from the server.
* @param {Object} options The options for the request. They can be any configuration option that can be specified for
* the class, with the exception of the target option. Note that any options passed to the method will override any
* class defaults.
};
me.setOptions(me.active, options);
},
-
+
<span id='Ext-ElementLoader-property-setOptions'> /**
-</span> * Set any additional options on the active request
+</span> * Sets any additional options on the active request
* @private
* @param {Object} active The active request
* @param {Object} options The initial options
setOptions: Ext.emptyFn,
<span id='Ext-ElementLoader-method-onComplete'> /**
-</span> * Parse the response after the request completes
+</span> * Parses the response after the request completes
* @private
* @param {Object} options Ajax options
* @param {Boolean} success Success status of the request
}
return this.statics().Renderer.Html;
},
-
+
<span id='Ext-ElementLoader-method-startAutoRefresh'> /**
</span> * Automatically refreshes the content over a specified period.
* @param {Number} interval The interval to refresh in ms.
me.load(options);
}, interval);
},
-
+
<span id='Ext-ElementLoader-method-stopAutoRefresh'> /**
</span> * Clears any auto refresh. See {@link #startAutoRefresh}.
*/
clearInterval(this.autoRefresh);
delete this.autoRefresh;
},
-
+
<span id='Ext-ElementLoader-method-isAutoRefreshing'> /**
</span> * Checks whether the loader is automatically refreshing. See {@link #startAutoRefresh}.
* @return {Boolean} True if the loader is automatically refreshing
git.ithinksw.org / extjs.git / blobdiff