1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.tree.TreeFilter</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
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>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
50 Class Roo.tree.TreeFilter
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.tree</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_tree_TreeFilter.js.html">Roo/tree/TreeFilter.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">TreeFilter</td></tr>
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
76 <!-- ============================== Class comment block... ========================== -->
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>
82 <iframe frameborder="0" id="comments-Roo.tree" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.tree.TreeFilter.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.tree.TreeFilter-configs"></a>
98 <table cellspacing="0" class="member-table">
99 <caption class="Empty">Config Options - Has None</caption>
113 <!-- ============================== public properties ==================== -->
117 <a id="Roo.tree.TreeFilter-props"></a>
123 <table cellspacing="0" class="member-table">
124 <caption class="Empty">Public Properties - Has None</caption>
130 <!-- ============================== methods summary / details ======================== -->
133 <a id="Roo.tree.TreeFilter-methods"></a>
134 <!-- constructor?? -->
141 <!-- then dynamics first -->
148 <table cellspacing="0" class="member-table">
149 <caption>Public Methods</caption>
151 <th class="sig-header" colspan="2">Method</th>
152 <th class="msource-header">Defined By</th>
162 <tr class="method-row config-row-alt0 expandable notInherited">
163 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
179 <div class="short">Create a new Roo.tree.TreeFilter</div>
186 Create a new Roo.tree.TreeFilter
189 <dl class="detailList">
190 <dt class="heading">Parameters:</dt>
193 <span class="fixedFont">TreePanel</span> <b>tree</b>
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>
226 <tr class="method-row config-row-alt1 expandable notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
242 <div class="short">Clears the current filter.</div>
248 Clears the current filter. Note: with the "remove" option<br/>set a filter cannot be cleared.
277 <tr class="method-row config-row-alt0 expandable notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
293 <div class="short">Filter the data by a specific attribute.</div>
299 Filter the data by a specific attribute.
306 <dl class="detailList">
307 <dt class="heading">Parameters:</dt>
310 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span> <b>value</b>
313 <dd>Either string that the attribute value<br/>should start with or a RegExp to test against the attribute</dd>
316 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>attr</b>
319 <dd>(optional) The attribute passed in your node's attributes collection. Defaults to "text".</dd>
322 <span class="fixedFont">TreeNode</span> <b>startNode</b>
325 <dd>(optional) The node to start the filter at.</dd>
351 <tr class="method-row config-row-alt1 expandable notInherited">
352 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
367 <div class="short">Filter by a function.</div>
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.
380 <dl class="detailList">
381 <dt class="heading">Parameters:</dt>
384 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
387 <dd>The filter function</dd>
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>
393 <dd>(optional) The scope of the function (defaults to the current node)</dd>
422 <!-- ============================== events summary / details ======================== -->
425 <a id="Roo.tree.TreeFilter-events"></a>
431 <table cellspacing="0" class="member-table">
432 <caption class="Empty">Events - Has None</caption>
443 <!-- ============================== footer ================================= -->
444 <div class="fineprint" style="clear:both">
446 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Mar 03 2016 16:15:37 GMT+0800 (HKT)
448 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>