[76] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
| 3 | |
---|
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 5 | <head> |
---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 7 | |
---|
| 8 | <title>GeoExt.tree.LayerLoader — GeoExt v1.0</title> |
---|
| 9 | <link rel="stylesheet" href="../../../../_static/geoext.css" type="text/css" /> |
---|
| 10 | <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
---|
| 11 | <script type="text/javascript"> |
---|
| 12 | var DOCUMENTATION_OPTIONS = { |
---|
| 13 | URL_ROOT: '../../../../', |
---|
| 14 | VERSION: '1.0', |
---|
| 15 | COLLAPSE_MODINDEX: false, |
---|
| 16 | FILE_SUFFIX: '.html', |
---|
| 17 | HAS_SOURCE: true |
---|
| 18 | }; |
---|
| 19 | </script> |
---|
| 20 | <script type="text/javascript" src="../../../../_static/jquery.js"></script> |
---|
| 21 | <script type="text/javascript" src="../../../../_static/doctools.js"></script> |
---|
| 22 | <link rel="shortcut icon" href="../../../../_static/favicon.ico"/> |
---|
| 23 | <link rel="top" title="GeoExt v1.0" href="../../../../index.html" /> |
---|
| 24 | <link rel="up" title="Widgets" href="../../widgets.html" /> |
---|
| 25 | <link rel="next" title="GeoExt.tree.LayerNode" href="LayerNode.html" /> |
---|
| 26 | <link rel="prev" title="GeoExt.tree.LayerContainer" href="LayerContainer.html" /> |
---|
| 27 | |
---|
| 28 | |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | |
---|
| 32 | |
---|
| 33 | </head> |
---|
| 34 | <body> |
---|
| 35 | <div class="header"> |
---|
| 36 | <div class="wrap"> |
---|
| 37 | <h1 id="logo"><a href="../../../../index.html">GeoExt</a></h1> |
---|
| 38 | <ul id="top-nav"> |
---|
| 39 | <li class="first"><a href="../../../../docs.html">Documentation</a></li> |
---|
| 40 | <li><a href="../../../../examples.html">Examples</a></li> |
---|
| 41 | <li><a href="../../../../downloads.html">Download</a></li> |
---|
| 42 | <li><a href="http://trac.geoext.org/">Development</a></li> |
---|
| 43 | </ul> |
---|
| 44 | <div id="searchbox"> |
---|
| 45 | <form class="search" action="../../../../search.html" method="get"> |
---|
| 46 | <input id="searchbox-query" type="text" name="q" size="25" value="Search …" tabindex="3" onblur="if(this.value=='') this.value='Search …';" onfocus="if(this.value=='Search …') this.value='';" /> |
---|
| 47 | <input id="searchbox-submit" type="image" value="Search" src="../../../../_static/img/search_icon_green.png" /> |
---|
| 48 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 49 | <input type="hidden" name="area" value="default" /> |
---|
| 50 | </form> |
---|
| 51 | </div> |
---|
| 52 | </div> |
---|
| 53 | </div> |
---|
| 54 | |
---|
| 55 | <div class="related"> |
---|
| 56 | <h3>Navigation</h3> |
---|
| 57 | <ul> |
---|
| 58 | <li><a href="../../../../index.html">GeoExt</a> »</li> |
---|
| 59 | <li><a href="../../../index.html" >API Reference</a> »</li> |
---|
| 60 | <li><a href="../../widgets.html" accesskey="U">Widgets</a> »</li> |
---|
| 61 | <li><a href="#"><tt class="docutils literal docutils literal"><span class="pre">GeoExt.tree.LayerLoader</span></tt></a></li> |
---|
| 62 | </ul> |
---|
| 63 | </div> |
---|
| 64 | |
---|
| 65 | <div class="sphinxsidebar"> |
---|
| 66 | <div class="sphinxsidebarwrapper"> |
---|
| 67 | <h3><a href="../../../../index.html">Table Of Contents</a></h3> |
---|
| 68 | <ul> |
---|
| 69 | <li><a class="reference external" href="#"><tt class="docutils literal"><span class="pre">GeoExt.tree.LayerLoader</span></tt></a><ul> |
---|
| 70 | <li><a class="reference external" href="#config-options">Config Options</a></li> |
---|
| 71 | <li><a class="reference external" href="#public-methods">Public Methods</a></li> |
---|
| 72 | <li><a class="reference external" href="#events">Events</a></li> |
---|
| 73 | </ul> |
---|
| 74 | </li> |
---|
| 75 | </ul> |
---|
| 76 | |
---|
| 77 | <h4>Previous topic</h4> |
---|
| 78 | <p class="topless"><a href="LayerContainer.html" |
---|
| 79 | title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">GeoExt.tree.LayerContainer</span></tt></a></p> |
---|
| 80 | <h4>Next topic</h4> |
---|
| 81 | <p class="topless"><a href="LayerNode.html" |
---|
| 82 | title="next chapter"><tt class="docutils literal"><span class="pre">GeoExt.tree.LayerNode</span></tt></a></p> |
---|
| 83 | </div> |
---|
| 84 | </div> |
---|
| 85 | |
---|
| 86 | |
---|
| 87 | <div class="document"> |
---|
| 88 | <div class="documentwrapper"> |
---|
| 89 | <div class="bodywrapper"> |
---|
| 90 | <div class="body"> |
---|
| 91 | |
---|
| 92 | <div class="section" id="geoext-tree-layerloader"> |
---|
| 93 | <h1><a title="GeoExt.tree.LayerLoader" class="reference internal" href="#GeoExt.tree.LayerLoader"><tt class="xref docutils literal"><span class="pre">GeoExt.tree.LayerLoader</span></tt></a><a class="headerlink" href="#geoext-tree-layerloader" title="Permalink to this headline">¶</a></h1> |
---|
| 94 | <dl class="meta docutils"> |
---|
| 95 | <dt>Extends</dt> |
---|
| 96 | <dd><ul class="first last simple"> |
---|
| 97 | <li><a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable">Ext.util.Observable</a></li> |
---|
| 98 | </ul> |
---|
| 99 | </dd> |
---|
| 100 | </dl> |
---|
| 101 | <dl class="class"> |
---|
| 102 | <dt id="GeoExt.tree.LayerLoader"> |
---|
| 103 | <em class="property">class </em><tt class="descclassname">GeoExt.tree.</tt><tt class="descname">LayerLoader</tt><a class="headerlink" href="#GeoExt.tree.LayerLoader" title="Permalink to this definition">¶</a></dt> |
---|
| 104 | <dd>A loader that will load all layers of a <a title="GeoExt.data.LayerStore" class="reference external" href="../../data/LayerStore.html#GeoExt.data.LayerStore"><tt class="xref docutils literal"><span class="pre">GeoExt.data.LayerStore</span></tt></a> |
---|
| 105 | By default, only layers that have displayInLayerSwitcher set to true |
---|
| 106 | will be included. The childrens’ iconCls defaults to |
---|
| 107 | “gx-tree-layer-icon”.</dd></dl> |
---|
| 108 | |
---|
| 109 | <div class="section" id="config-options"> |
---|
| 110 | <h2>Config Options<a class="headerlink" href="#config-options" title="Permalink to this headline">¶</a></h2> |
---|
| 111 | <p>Configuration properties in addition to |
---|
| 112 | those listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable">Ext.util.Observable</a>.</p> |
---|
| 113 | <dl class="describe"> |
---|
| 114 | <dt> |
---|
| 115 | <tt class="descname">baseAttrs</tt></dt> |
---|
| 116 | <dd>An object containing attributes to be added to all nodes created by |
---|
| 117 | this loader.</dd></dl> |
---|
| 118 | |
---|
| 119 | <dl class="describe"> |
---|
| 120 | <dt> |
---|
| 121 | <tt class="descname">filter</tt></dt> |
---|
| 122 | <dd><p><tt class="docutils literal"><span class="pre">Function</span></tt> |
---|
| 123 | A function, called in the scope of this loader, with a layer record |
---|
| 124 | as argument. Is expected to return true for layers to be loaded, false |
---|
| 125 | otherwise. By default, the filter checks for displayInLayerSwitcher:</p> |
---|
| 126 | <div class="highlight-javascript"><div class="highlight"><pre><span class="nx">filter</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">record</span><span class="p">)</span> <span class="p">{</span> |
---|
| 127 | <span class="k">return</span> <span class="nx">record</span><span class="p">.</span><span class="nx">getLayer</span><span class="p">().</span><span class="nx">displayInLayerSwitcher</span> <span class="o">==</span> <span class="kc">true</span> |
---|
| 128 | <span class="p">}</span> |
---|
| 129 | </pre></div> |
---|
| 130 | </div> |
---|
| 131 | </dd></dl> |
---|
| 132 | |
---|
| 133 | <dl class="describe"> |
---|
| 134 | <dt> |
---|
| 135 | <tt class="descname">store</tt></dt> |
---|
| 136 | <dd><a title="GeoExt.data.LayerStore" class="reference external" href="../../data/LayerStore.html#GeoExt.data.LayerStore"><tt class="xref docutils literal"><span class="pre">GeoExt.data.LayerStore</span></tt></a> |
---|
| 137 | The layer store containing layers to be added by this loader.</dd></dl> |
---|
| 138 | |
---|
| 139 | <dl class="describe"> |
---|
| 140 | <dt> |
---|
| 141 | <tt class="descname">uiProviders</tt></dt> |
---|
| 142 | <dd><tt class="docutils literal"><span class="pre">Object</span></tt> |
---|
| 143 | An optional object containing properties which specify custom |
---|
| 144 | GeoExt.tree.LayerNodeUI implementations. If the optional uiProvider |
---|
| 145 | attribute for child nodes is a string rather than a reference to a |
---|
| 146 | TreeNodeUI implementation, then that string value is used as a |
---|
| 147 | property name in the uiProviders object. If not provided, the |
---|
| 148 | uiProviders object will be taken from the ownerTree’s loader.</dd></dl> |
---|
| 149 | |
---|
| 150 | </div> |
---|
| 151 | <div class="section" id="public-methods"> |
---|
| 152 | <h2>Public Methods<a class="headerlink" href="#public-methods" title="Permalink to this headline">¶</a></h2> |
---|
| 153 | <p>Public methods in addition to those |
---|
| 154 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable">Ext.util.Observable</a>.</p> |
---|
| 155 | <dl class="method"> |
---|
| 156 | <dt id="GeoExt.tree.LayerLoader.createNode"> |
---|
| 157 | <tt class="descclassname">LayerLoader.</tt><tt class="descname">createNode</tt><big>(</big><big>)</big><a class="headerlink" href="#GeoExt.tree.LayerLoader.createNode" title="Permalink to this definition">¶</a></dt> |
---|
| 158 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 159 | <col class="field-name" /> |
---|
| 160 | <col class="field-body" /> |
---|
| 161 | <tbody valign="top"> |
---|
| 162 | <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>attr</em> – <tt class="docutils literal"><span class="pre">Object</span></tt> attributes for the new node</td> |
---|
| 163 | </tr> |
---|
| 164 | </tbody> |
---|
| 165 | </table> |
---|
| 166 | <p>Override this function for custom TreeNode node implementation, or to |
---|
| 167 | modify the attributes at creation time.</p> |
---|
| 168 | </dd></dl> |
---|
| 169 | |
---|
| 170 | </div> |
---|
| 171 | <div class="section" id="events"> |
---|
| 172 | <h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2> |
---|
| 173 | <p>Events in addition to those |
---|
| 174 | listed for <a class="reference external" href="http://dev.sencha.com/deploy/dev/docs/?class=Ext.util.Observable">Ext.util.Observable</a>.</p> |
---|
| 175 | <dl class="describe"> |
---|
| 176 | <dt> |
---|
| 177 | <tt class="descname">beforeload</tt></dt> |
---|
| 178 | <dd><p>Triggered before loading children. Return false to avoid |
---|
| 179 | loading children.</p> |
---|
| 180 | <p>Listener arguments:</p> |
---|
| 181 | <ul> |
---|
| 182 | <li><p class="first">loader - <a title="GeoExt.tree.LayerLoader" class="reference internal" href="#GeoExt.tree.LayerLoader"><tt class="xref docutils literal"><span class="pre">GeoExt.tree.LayerLoader</span></tt></a> this loader</p> |
---|
| 183 | </li> |
---|
| 184 | <li><dl class="first docutils"> |
---|
| 185 | <dt>node - <tt class="docutils literal"><span class="pre">Ex.tree.TreeNode</span></tt> the node that this loader is</dt> |
---|
| 186 | <dd><p class="first last">configured with</p> |
---|
| 187 | </dd> |
---|
| 188 | </dl> |
---|
| 189 | </li> |
---|
| 190 | </ul> |
---|
| 191 | </dd></dl> |
---|
| 192 | |
---|
| 193 | <dl class="describe"> |
---|
| 194 | <dt> |
---|
| 195 | <tt class="descname">load</tt></dt> |
---|
| 196 | <dd><p>Triggered after children wer loaded.</p> |
---|
| 197 | <p>Listener arguments:</p> |
---|
| 198 | <ul> |
---|
| 199 | <li><p class="first">loader - <a title="GeoExt.tree.LayerLoader" class="reference internal" href="#GeoExt.tree.LayerLoader"><tt class="xref docutils literal"><span class="pre">GeoExt.tree.LayerLoader</span></tt></a> this loader</p> |
---|
| 200 | </li> |
---|
| 201 | <li><dl class="first docutils"> |
---|
| 202 | <dt>node - <tt class="docutils literal"><span class="pre">Ex.tree.TreeNode</span></tt> the node that this loader is</dt> |
---|
| 203 | <dd><p class="first last">configured with</p> |
---|
| 204 | </dd> |
---|
| 205 | </dl> |
---|
| 206 | </li> |
---|
| 207 | </ul> |
---|
| 208 | </dd></dl> |
---|
| 209 | |
---|
| 210 | </div> |
---|
| 211 | </div> |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | </div> |
---|
| 215 | </div> |
---|
| 216 | </div> |
---|
| 217 | <div class="clearer"></div> |
---|
| 218 | </div> |
---|
| 219 | <div class="related"> |
---|
| 220 | <h3>Navigation</h3> |
---|
| 221 | <ul> |
---|
| 222 | <li class="right" style="margin-right: 10px"> |
---|
| 223 | <a href="../../../../genindex.html" title="General Index" |
---|
| 224 | accesskey="I">index</a></li> |
---|
| 225 | <li class="right" > |
---|
| 226 | <a href="../../../../modindex.html" title="Global Module Index" |
---|
| 227 | accesskey="M">modules</a> |</li> |
---|
| 228 | <li class="right" > |
---|
| 229 | <a href="LayerNode.html" title="GeoExt.tree.LayerNode" |
---|
| 230 | accesskey="N">next</a> |</li> |
---|
| 231 | <li class="right" > |
---|
| 232 | <a href="LayerContainer.html" title="GeoExt.tree.LayerContainer" |
---|
| 233 | accesskey="P">previous</a> |</li> |
---|
| 234 | <li><a href="../../../../index.html">GeoExt</a> »</li> |
---|
| 235 | <li><a href="../../../index.html" >API Reference</a> »</li> |
---|
| 236 | <li><a href="../../widgets.html" >Widgets</a> »</li> |
---|
| 237 | <li><a href="#"><tt class="docutils literal docutils literal"><span class="pre">GeoExt.tree.LayerLoader</span></tt></a></li> |
---|
| 238 | </ul> |
---|
| 239 | </div> |
---|
| 240 | |
---|
| 241 | <div class="footer"> |
---|
| 242 | © Copyright 2009-2010, GeoExt Community. |
---|
| 243 | </div> |
---|
| 244 | </body> |
---|
| 245 | </html> |
---|