X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/src/ComponentLoader.js diff --git a/src/ComponentLoader.js b/src/ComponentLoader.js index 5092cd35..1f30271c 100644 --- a/src/ComponentLoader.js +++ b/src/ComponentLoader.js @@ -15,35 +15,35 @@ If you are unsure which license is appropriate for your use, please contact the /** * @class Ext.ComponentLoader * @extends Ext.ElementLoader - * - * This class is used to load content via Ajax into a {@link Ext.Component}. In general + * + * This class is used to load content via Ajax into a {@link Ext.Component}. In general * this class will not be instanced directly, rather a loader configuration will be passed to the * constructor of the {@link Ext.Component}. - * + * * ## HTML Renderer * By default, the content loaded will be processed as raw html. The response text * from the request is taken and added to the component. This can be used in * conjunction with the {@link #scripts} option to execute any inline scripts in * the resulting content. Using this renderer has the same effect as passing the * {@link Ext.Component#html} configuration option. - * + * * ## Data Renderer * This renderer allows content to be added by using JSON data and a {@link Ext.XTemplate}. * The content received from the response is passed to the {@link Ext.Component#update} method. * This content is run through the attached {@link Ext.Component#tpl} and the data is added to * the Component. Using this renderer has the same effect as using the {@link Ext.Component#data} * configuration in conjunction with a {@link Ext.Component#tpl}. - * + * * ## Component Renderer * This renderer can only be used with a {@link Ext.container.Container} and subclasses. It allows for * Components to be loaded remotely into a Container. The response is expected to be a single/series of * {@link Ext.Component} configuration objects. When the response is received, the data is decoded * and then passed to {@link Ext.container.Container#add}. Using this renderer has the same effect as specifying - * the {@link Ext.container.Container#items} configuration on a Container. - * + * the {@link Ext.container.Container#items} configuration on a Container. + * * ## Custom Renderer * A custom function can be passed to handle any other special case, see the {@link #renderer} option. - * + * * ## Example Usage * new Ext.Component({ * tpl: '{firstName} - {lastName}', @@ -59,7 +59,7 @@ If you are unsure which license is appropriate for your use, please contact the Ext.define('Ext.ComponentLoader', { /* Begin Definitions */ - + extend: 'Ext.ElementLoader', statics: { @@ -108,16 +108,16 @@ Ext.define('Ext.ComponentLoader', { /* End Definitions */ /** - * @cfg {Ext.Component/String} target The target {@link Ext.Component} for the loader. Defaults to null. + * @cfg {Ext.Component/String} target The target {@link Ext.Component} for the loader. * If a string is passed it will be looked up via the id. */ target: null, /** - * @cfg {Mixed} loadMask True or a {@link Ext.LoadMask} configuration to enable masking during loading. Defaults to false. + * @cfg {Boolean/Object} loadMask True or a {@link Ext.LoadMask} configuration to enable masking during loading. */ loadMask: false, - + /** * @cfg {Boolean} scripts True to parse any inline script tags in the response. This only used when using the html * {@link #renderer}. @@ -132,8 +132,6 @@ The type of content that is to be loaded into, which can be one of 3 types: + **data** : Loads raw html content, see {@link Ext.Component#data} + **component** : Loads child {Ext.Component} instances. This option is only valid when used with a Container. -Defaults to `html`. - Alternatively, you can pass a function which is called with the following parameters. + loader - Loader instance @@ -152,7 +150,6 @@ The function must return false is loading is not successful. Below is a sample o } } }); - * @markdown */ renderer: 'html', @@ -164,7 +161,7 @@ The function must return false is loading is not successful. Below is a sample o */ setTarget: function(target){ var me = this; - + if (Ext.isString(target)) { target = Ext.getCmp(target); } @@ -174,16 +171,16 @@ The function must return false is loading is not successful. Below is a sample o } me.target = target; }, - + // inherit docs removeMask: function(){ this.target.setLoading(false); }, - + /** * Add the mask on the target * @private - * @param {Mixed} mask The mask configuration + * @param {Boolean/Object} mask The mask configuration */ addMask: function(mask){ this.target.setLoading(mask); @@ -193,7 +190,7 @@ The function must return false is loading is not successful. Below is a sample o * Get the target of this loader. * @return {Ext.Component} target The target, null if none exists. */ - + setOptions: function(active, options){ active.removeAll = Ext.isDefined(options.removeAll) ? options.removeAll : this.removeAll; },