2 |
aperonnet |
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="../source/widgets/tree/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 |
Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes </div>
|
|
|
17 |
|
|
|
18 |
<div class="hr"></div>
|
|
|
19 |
<a id="Ext.tree.TreeFilter-props"></a>
|
|
|
20 |
<h2>Public Properties</h2>
|
|
|
21 |
<div class="no-members">This class has no public properties.</div> <a id="Ext.tree.TreeFilter-methods"></a>
|
|
|
22 |
<h2>Public Methods</h2>
|
|
|
23 |
<table cellspacing="0" class="member-table">
|
|
|
24 |
<tr>
|
|
|
25 |
<th class="sig-header" colspan="2">Method</th>
|
|
|
26 |
<th class="msource-header">Defined By</th>
|
|
|
27 |
</tr>
|
|
|
28 |
<tr class="method-row expandable">
|
|
|
29 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
30 |
<td class="sig">
|
|
|
31 |
<a id="Ext.tree.TreeFilter-clear"></a>
|
|
|
32 |
<b>clear</b>() : void <div class="mdesc">
|
|
|
33 |
<div class="short">Clears the current filter. Note: with the "remove" option
|
|
|
34 |
set a filter cannot be cleared.</div>
|
|
|
35 |
<div class="long">
|
|
|
36 |
Clears the current filter. Note: with the "remove" option
|
|
|
37 |
set a filter cannot be cleared. <div class="mdetail-params">
|
|
|
38 |
<strong>Parameters:</strong>
|
|
|
39 |
<ul><li>None.</li> </ul>
|
|
|
40 |
<strong>Returns:</strong>
|
|
|
41 |
<ul>
|
|
|
42 |
<li><code>void</code></li>
|
|
|
43 |
</ul>
|
|
|
44 |
</div>
|
|
|
45 |
</div>
|
|
|
46 |
</div>
|
|
|
47 |
</td>
|
|
|
48 |
<td class="msource">TreeFilter</td>
|
|
|
49 |
</tr>
|
|
|
50 |
<tr class="method-row alt expandable">
|
|
|
51 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
52 |
<td class="sig">
|
|
|
53 |
<a id="Ext.tree.TreeFilter-filter"></a>
|
|
|
54 |
<b>filter</b>( <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> ) : void <div class="mdesc">
|
|
|
55 |
<div class="short">Filter the data by a specific attribute.</div>
|
|
|
56 |
<div class="long">
|
|
|
57 |
Filter the data by a specific attribute. <div class="mdetail-params">
|
|
|
58 |
<strong>Parameters:</strong>
|
|
|
59 |
<ul><li><code>value</code> : String/RegExp<div class="sub-desc">Either string that the attribute value
|
|
|
60 |
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>
|
|
|
61 |
<strong>Returns:</strong>
|
|
|
62 |
<ul>
|
|
|
63 |
<li><code>void</code></li>
|
|
|
64 |
</ul>
|
|
|
65 |
</div>
|
|
|
66 |
</div>
|
|
|
67 |
</div>
|
|
|
68 |
</td>
|
|
|
69 |
<td class="msource">TreeFilter</td>
|
|
|
70 |
</tr>
|
|
|
71 |
<tr class="method-row expandable">
|
|
|
72 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
73 |
<td class="sig">
|
|
|
74 |
<a id="Ext.tree.TreeFilter-filterBy"></a>
|
|
|
75 |
<b>filterBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
|
|
|
76 |
<div class="short">Filter by a function. The passed function will be called with each
|
|
|
77 |
node in the tree (or from the startNode). If the ...</div>
|
|
|
78 |
<div class="long">
|
|
|
79 |
Filter by a function. The passed function will be called with each
|
|
|
80 |
node in the tree (or from the startNode). If the function returns true, the node is kept
|
|
|
81 |
otherwise it is filtered. If a node is filtered, its children are also filtered. <div class="mdetail-params">
|
|
|
82 |
<strong>Parameters:</strong>
|
|
|
83 |
<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>
|
|
|
84 |
<strong>Returns:</strong>
|
|
|
85 |
<ul>
|
|
|
86 |
<li><code>void</code></li>
|
|
|
87 |
</ul>
|
|
|
88 |
</div>
|
|
|
89 |
</div>
|
|
|
90 |
</div>
|
|
|
91 |
</td>
|
|
|
92 |
<td class="msource">TreeFilter</td>
|
|
|
93 |
</tr>
|
|
|
94 |
</table>
|
|
|
95 |
<a id="Ext.tree.TreeFilter-events"></a>
|
|
|
96 |
<h2>Public Events</h2>
|
|
|
97 |
<div class="no-members">This class has no public events.</div>
|
|
|
98 |
</div>
|