docs/output/Ext.tree.TreeFilter.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.tree.TreeFilter-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.tree.TreeFilter-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.tree.TreeFilter-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                         <a class="bookmark" href="../docs/?class=Ext.tree.TreeFilter"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   7         </div>
   8                 <h1>Class Ext.tree.TreeFilter</h1>
   9         <table cellspacing="0">
  10             <tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr>
  11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/TreeFilter.js" target="_blank">TreeFilter.js</a></td></tr>
  12             <tr><td class="label">Class:</td><td class="hd-info">TreeFilter</td></tr>
  13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  14                     </table>
  15         <div class="description">
  16             *
  17 Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes        </div>
  18
  19         <div class="hr"></div>
  20                 <a id="Ext.tree.TreeFilter-props"></a>
  21         <h2>Public Properties</h2>
  22         <div class="no-members">This class has no public properties.</div>        <a id="Ext.tree.TreeFilter-methods"></a>
  23         <h2>Public Methods</h2>
  24                 <table cellspacing="0" class="member-table">
  25             <tr>
  26                 <th class="sig-header" colspan="2">Method</th>
  27                 <th class="msource-header">Defined By</th>
  28             </tr>
  29                 <tr class="method-row expandable">\r
  30         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  31         <td class="sig">\r
  32         <a id="Ext.tree.TreeFilter-clear"></a>\r
  33             <b>clear</b>() : void            <div class="mdesc">\r
  34                         <div class="short">Clears the current filter. Note: with the "remove" option
  35 set a filter cannot be cleared.</div>\r
  36             <div class="long">\r
  37                 Clears the current filter. Note: with the "remove" option
  38 set a filter cannot be cleared.    <div class="mdetail-params">\r
  39         <strong>Parameters:</strong>\r
  40         <ul><li>None.</li>        </ul>\r
  41         <strong>Returns:</strong>\r
  42         <ul>\r
  43             <li><code>void</code></li>\r
  44         </ul>\r
  45     </div>\r
  46                 </div>\r
  47                         </div>\r
  48         </td>\r
  49         <td class="msource">TreeFilter</td>\r
  50     </tr>\r
  51         <tr class="method-row alt expandable">\r
  52         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  53         <td class="sig">\r
  54         <a id="Ext.tree.TreeFilter-filter"></a>\r
  55             <b>filter</b>(&nbsp;<code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>String attr</code>]</span>, <span class="optional" title="Optional">[<code>TreeNode startNode</code>]</span>&nbsp;) : void            <div class="mdesc">\r
  56                         <div class="short">Filter the data by a specific attribute.</div>\r
  57             <div class="long">\r
  58                 Filter the data by a specific attribute.    <div class="mdetail-params">\r
  59         <strong>Parameters:</strong>\r
  60         <ul><li><code>value</code> : String/RegExp<div class="sub-desc">Either string that the attribute value
  61 should start with or a RegExp to test against the attribute</div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute passed in your node's attributes collection. Defaults to "text".</div></li><li><code>startNode</code> : TreeNode<div class="sub-desc">(optional) The node to start the filter at.</div></li>        </ul>\r
  62         <strong>Returns:</strong>\r
  63         <ul>\r
  64             <li><code>void</code></li>\r
  65         </ul>\r
  66     </div>\r
  67                 </div>\r
  68                         </div>\r
  69         </td>\r
  70         <td class="msource">TreeFilter</td>\r
  71     </tr>\r
  72         <tr class="method-row expandable">\r
  73         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  74         <td class="sig">\r
  75         <a id="Ext.tree.TreeFilter-filterBy"></a>\r
  76             <b>filterBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
  77                         <div class="short">Filter by a function. The passed function will be called with each
  78 node in the tree (or from the startNode). If the ...</div>\r
  79             <div class="long">\r
  80                 Filter by a function. The passed function will be called with each
  81 node in the tree (or from the startNode). If the function returns true, the node is kept
  82 otherwise it is filtered. If a node is filtered, its children are also filtered.    <div class="mdetail-params">\r
  83         <strong>Parameters:</strong>\r
  84         <ul><li><code>fn</code> : Function<div class="sub-desc">The filter function</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to the current node)</div></li>        </ul>\r
  85         <strong>Returns:</strong>\r
  86         <ul>\r
  87             <li><code>void</code></li>\r
  88         </ul>\r
  89     </div>\r
  90                 </div>\r
  91                         </div>\r
  92         </td>\r
  93         <td class="msource">TreeFilter</td>\r
  94     </tr>\r
  95             </table>
  96                 <a id="Ext.tree.TreeFilter-events"></a>
  97         <h2>Public Events</h2>
  98         <div class="no-members">This class has no public events.</div>
  99         </div>