git.roojs.org Git - roojs1/blob - docs/symbols/Roo.tree.TreeFilter.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.tree.TreeFilter</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo.tree.TreeFilter-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.tree.TreeFilter-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.tree.TreeFilter-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.tree.TreeFilter-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.tree.TreeFilter
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.tree</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_tree_TreeFilter.js.html">Roo/tree/TreeFilter.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">TreeFilter</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  78 <div class="comments">
  79         <b>Class Comments / Notes</B> =>
  80         <u onclick="parent.CommentDialog.showCommentId = 'Roo.tree.TreeFilter';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo.tree" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.tree.TreeFilter.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.tree.TreeFilter-configs"></a>
  95
  96
  97
  98      <table cellspacing="0" class="member-table">
  99       <caption class="Empty">Config Options - Has None</caption>
 100      </table>
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113   <!-- ============================== public properties ==================== -->
 114
 115
 116
 117     <a id="Roo.tree.TreeFilter-props"></a>
 118
 119
 120
 121
 122
 123      <table cellspacing="0" class="member-table">
 124       <caption class="Empty">Public Properties - Has None</caption>
 125      </table>
 126
 127
 128
 129
 130   <!-- ============================== methods summary / details ======================== -->
 131
 132
 133   <a id="Roo.tree.TreeFilter-methods"></a>
 134         <!-- constructor?? -->
 135
 136         <!-- static's first
 137
 138
 139         -->
 140
 141         <!-- then dynamics first -->
 142
 143
 144
 145
 146
 147
 148       <table cellspacing="0" class="member-table">
 149       <caption>Public Methods</caption>
 150         <tr>
 151             <th class="sig-header" colspan="2">Method</th>
 152             <th class="msource-header">Defined By</th>
 153
 154         </tr>
 155
 156
 157
 158
 159
 160
 161
 162           <tr class="method-row config-row-alt0 expandable notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 167                 <a id="Roo.tree-method-TreeFilter"   name=".TreeFilter"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">TreeFilter</b>
 170
 171                                  (TreePanel <B><i>tree</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 172
 173
 174
 175                 </div>
 176                 <div class="mdesc">
 177
 178
 179                         <div class="short">Create a new Roo.tree.TreeFilter</div>
 180
 181
 182                     <div class="long">
 183
 184
 185
 186                                 Create a new Roo.tree.TreeFilter
 187
 188
 189                                 <dl class="detailList">
 190                                 <dt class="heading">Parameters:</dt>
 191
 192                                         <dt>
 193                                                 <span class="fixedFont">TreePanel</span>  <b>tree</b>
 194
 195                                         </dt>
 196                                         <dd></dd>
 197
 198                                         <dt>
 199                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 200
 201                                         </dt>
 202                                         <dd>(optional)</dd>
 203
 204                                 </dl>
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216                     </div>
 217                 </div>
 218
 219             </td>
 220             <td class="msource">
 221                 &nbsp;
 222             </td>
 223         </tr>
 224
 225
 226           <tr class="method-row config-row-alt1 expandable notInherited">
 227             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 228
 229
 230             <td class="sig">
 231                 <a id="Roo.tree.TreeFilter-method-clear"   name=".clear"></a>
 232                 <div class="fixedFont">
 233                         <span class="attributes"></span><b class="itemname">clear</b>
 234
 235                                  ()
 236
 237
 238
 239                 </div>
 240                 <div class="mdesc">
 241
 242                    <div class="short">Clears the current filter.</div>
 243
 244
 245
 246                     <div class="long">
 247
 248                                 Clears the current filter. Note: with the "remove" option<br/>set a filter cannot be cleared.
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265                     </div>
 266                 </div>
 267
 268             </td>
 269             <td class="msource">
 270
 271                         Roo.tree.TreeFilter
 272                 &nbsp;
 273             </td>
 274         </tr>
 275
 276
 277           <tr class="method-row config-row-alt0 expandable notInherited">
 278             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279
 280
 281             <td class="sig">
 282                 <a id="Roo.tree.TreeFilter-method-filter"   name=".filter"></a>
 283                 <div class="fixedFont">
 284                         <span class="attributes"></span><b class="itemname">filter</b>
 285
 286                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp <B><i>value</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>attr</i></B>, TreeNode <B><i>startNode</i></B>)
 287
 288
 289
 290                 </div>
 291                 <div class="mdesc">
 292
 293                    <div class="short">Filter the data by a specific attribute.</div>
 294
 295
 296
 297                     <div class="long">
 298
 299                                 Filter the data by a specific attribute.
 300
 301
 302
 303
 304
 305
 306                                 <dl class="detailList">
 307                                 <dt class="heading">Parameters:</dt>
 308
 309                                         <dt>
 310                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span>  <b>value</b>
 311
 312                                         </dt>
 313                                         <dd>Either string that the attribute value<br/>should start with or a RegExp to test against the attribute</dd>
 314
 315                                         <dt>
 316                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>attr</b>
 317
 318                                         </dt>
 319                                         <dd>(optional) The attribute passed in your node's attributes collection. Defaults to "text".</dd>
 320
 321                                         <dt>
 322                                                 <span class="fixedFont">TreeNode</span>  <b>startNode</b>
 323
 324                                         </dt>
 325                                         <dd>(optional) The node to start the filter at.</dd>
 326
 327                                 </dl>
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339                     </div>
 340                 </div>
 341
 342             </td>
 343             <td class="msource">
 344
 345                         Roo.tree.TreeFilter
 346                 &nbsp;
 347             </td>
 348         </tr>
 349
 350
 351           <tr class="method-row config-row-alt1 expandable notInherited">
 352             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 353
 354
 355             <td class="sig">
 356                 <a id="Roo.tree.TreeFilter-method-filterBy"   name=".filterBy"></a>
 357                 <div class="fixedFont">
 358                         <span class="attributes"></span><b class="itemname">filterBy</b>
 359
 360                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
 361
 362
 363
 364                 </div>
 365                 <div class="mdesc">
 366
 367                    <div class="short">Filter by a function.</div>
 368
 369
 370
 371                     <div class="long">
 372
 373                                 Filter by a function. The passed function will be called with each<br/>node in the tree (or from the startNode). If the function returns true, the node is kept<br/>otherwise it is filtered. If a node is filtered, its children are also filtered.
 374
 375
 376
 377
 378
 379
 380                                 <dl class="detailList">
 381                                 <dt class="heading">Parameters:</dt>
 382
 383                                         <dt>
 384                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 385
 386                                         </dt>
 387                                         <dd>The filter function</dd>
 388
 389                                         <dt>
 390                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 391
 392                                         </dt>
 393                                         <dd>(optional) The scope of the function (defaults to the current node)</dd>
 394
 395                                 </dl>
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407                     </div>
 408                 </div>
 409
 410             </td>
 411             <td class="msource">
 412
 413                         Roo.tree.TreeFilter
 414                 &nbsp;
 415             </td>
 416         </tr>
 417
 418
 419     </table>
 420
 421
 422   <!-- ============================== events summary / details ======================== -->
 423
 424
 425   <a id="Roo.tree.TreeFilter-events"></a>
 426
 427
 428
 429
 430
 431      <table cellspacing="0" class="member-table">
 432       <caption class="Empty">Events - Has None</caption>
 433      </table>
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443 <!-- ============================== footer ================================= -->
 444                 <div class="fineprint" style="clear:both">
 445
 446                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:09 GMT+0800 (HKT)
 447                         Based on
 448                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 449                 </div>
 450         </body>
 451 </html>