source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.tree.TreeFilter.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 5.7 KB
Line 
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            *
17Note 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">
30        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
31        <td class="sig">
32        <a id="Ext.tree.TreeFilter-clear"></a>
33            <b>clear</b>() : void            <div class="mdesc">
34                        <div class="short">Clears the current filter. Note: with the "remove" option
35set a filter cannot be cleared.</div>
36            <div class="long">
37                Clears the current filter. Note: with the "remove" option
38set a filter cannot be cleared.    <div class="mdetail-params">
39        <strong>Parameters:</strong>
40        <ul><li>None.</li>        </ul>
41        <strong>Returns:</strong>
42        <ul>
43            <li><code>void</code></li>
44        </ul>
45    </div>
46                </div>
47                        </div>
48        </td>
49        <td class="msource">TreeFilter</td>
50    </tr>
51        <tr class="method-row alt expandable">
52        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
53        <td class="sig">
54        <a id="Ext.tree.TreeFilter-filter"></a>
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">
56                        <div class="short">Filter the data by a specific attribute.</div>
57            <div class="long">
58                Filter the data by a specific attribute.    <div class="mdetail-params">
59        <strong>Parameters:</strong>
60        <ul><li><code>value</code> : String/RegExp<div class="sub-desc">Either string that the attribute value
61should 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>
62        <strong>Returns:</strong>
63        <ul>
64            <li><code>void</code></li>
65        </ul>
66    </div>
67                </div>
68                        </div>
69        </td>
70        <td class="msource">TreeFilter</td>
71    </tr>
72        <tr class="method-row expandable">
73        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
74        <td class="sig">
75        <a id="Ext.tree.TreeFilter-filterBy"></a>
76            <b>filterBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
77                        <div class="short">Filter by a function. The passed function will be called with each
78node in the tree (or from the startNode). If the ...</div>
79            <div class="long">
80                Filter by a function. The passed function will be called with each
81node in the tree (or from the startNode). If the function returns true, the node is kept
82otherwise it is filtered. If a node is filtered, its children are also filtered.    <div class="mdetail-params">
83        <strong>Parameters:</strong>
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>
85        <strong>Returns:</strong>
86        <ul>
87            <li><code>void</code></li>
88        </ul>
89    </div>
90                </div>
91                        </div>
92        </td>
93        <td class="msource">TreeFilter</td>
94    </tr>
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>
Note: See TracBrowser for help on using the repository browser.