1 <html><head><title>Roo/tree/TreeFilter.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
13 * @class Roo.tree.TreeFilter
14 * Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes
15 * @param {TreePanel} tree
16 * @param {Object} config (optional)
18 </span><span class="jsdoc-var">Roo.tree.TreeFilter </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">tree</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
19 </span><span class="jsdoc-var">this.tree </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">tree</span><span class="jsdoc-syntax">;
20 </span><span class="jsdoc-var">this.filtered </span><span class="jsdoc-syntax">= {};
21 </span><span class="jsdoc-var">Roo.apply</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
24 </span><span class="jsdoc-var">Roo.tree.TreeFilter.prototype </span><span class="jsdoc-syntax">= {
25 </span><span class="jsdoc-var">clearBlank</span><span class="jsdoc-syntax">:</span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
26 </span><span class="jsdoc-var">reverse</span><span class="jsdoc-syntax">:</span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
27 </span><span class="jsdoc-var">autoClear</span><span class="jsdoc-syntax">:</span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
28 </span><span class="jsdoc-var">remove</span><span class="jsdoc-syntax">:</span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
30 </span><span class="jsdoc-comment">/**
31 * Filter the data by a specific attribute.
32 * @param {String/RegExp} value Either string that the attribute value
33 * should start with or a RegExp to test against the attribute
34 * @param {String} attr (optional) The attribute passed in your node's attributes collection. Defaults to "text".
35 * @param {TreeNode} startNode (optional) The node to start the filter at.
37 </span><span class="jsdoc-var">filter </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">value</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">attr</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">startNode</span><span class="jsdoc-syntax">){
38 </span><span class="jsdoc-var">attr </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">attr </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-string">"text"</span><span class="jsdoc-syntax">;
39 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">f</span><span class="jsdoc-syntax">;
40 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">value </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">"string"</span><span class="jsdoc-syntax">){
41 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">vlen </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">value.length</span><span class="jsdoc-syntax">;
42 </span><span class="jsdoc-comment">// auto clear empty filter
43 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">vlen </span><span class="jsdoc-syntax">== 0 && </span><span class="jsdoc-var">this.clearBlank</span><span class="jsdoc-syntax">){
44 </span><span class="jsdoc-var">this.clear</span><span class="jsdoc-syntax">();
45 </span><span class="jsdoc-keyword">return</span><span class="jsdoc-syntax">;
47 </span><span class="jsdoc-var">value </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">value.toLowerCase</span><span class="jsdoc-syntax">();
48 </span><span class="jsdoc-var">f </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">){
49 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">n.attributes</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">attr</span><span class="jsdoc-syntax">]</span><span class="jsdoc-var">.substr</span><span class="jsdoc-syntax">(0, </span><span class="jsdoc-var">vlen</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.toLowerCase</span><span class="jsdoc-syntax">() == </span><span class="jsdoc-var">value</span><span class="jsdoc-syntax">;
51 }</span><span class="jsdoc-keyword">else if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">value.exec</span><span class="jsdoc-syntax">){ </span><span class="jsdoc-comment">// regex?
52 </span><span class="jsdoc-var">f </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">){
53 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">value.test</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">n.attributes</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">attr</span><span class="jsdoc-syntax">]);
55 }</span><span class="jsdoc-keyword">else</span><span class="jsdoc-syntax">{
56 </span><span class="jsdoc-keyword">throw </span><span class="jsdoc-string">'Illegal filter type, must be string or regex'</span><span class="jsdoc-syntax">;
58 </span><span class="jsdoc-var">this.filterBy</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">f</span><span class="jsdoc-syntax">, </span><span class="jsdoc-keyword">null</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">startNode</span><span class="jsdoc-syntax">);
61 </span><span class="jsdoc-comment">/**
62 * Filter by a function. The passed function will be called with each
63 * node in the tree (or from the startNode). If the function returns true, the node is kept
64 * otherwise it is filtered. If a node is filtered, its children are also filtered.
65 * @param {Function} fn The filter function
66 * @param {Object} scope (optional) The scope of the function (defaults to the current node)
68 </span><span class="jsdoc-var">filterBy </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">fn</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">scope</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">startNode</span><span class="jsdoc-syntax">){
69 </span><span class="jsdoc-var">startNode </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">startNode </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">this.tree.root</span><span class="jsdoc-syntax">;
70 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.autoClear</span><span class="jsdoc-syntax">){
71 </span><span class="jsdoc-var">this.clear</span><span class="jsdoc-syntax">();
73 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">af </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.filtered</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">rv </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.reverse</span><span class="jsdoc-syntax">;
74 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">f </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">){
75 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">n </span><span class="jsdoc-syntax">== </span><span class="jsdoc-var">startNode</span><span class="jsdoc-syntax">){
76 </span><span class="jsdoc-keyword">return true</span><span class="jsdoc-syntax">;
78 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">af</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">n.id</span><span class="jsdoc-syntax">]){
79 </span><span class="jsdoc-keyword">return false</span><span class="jsdoc-syntax">;
81 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">m </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">fn.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">scope </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">);
82 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(!</span><span class="jsdoc-var">m </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">rv</span><span class="jsdoc-syntax">){
83 </span><span class="jsdoc-var">af</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">n.id</span><span class="jsdoc-syntax">] = </span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">;
84 </span><span class="jsdoc-var">n.ui.hide</span><span class="jsdoc-syntax">();
85 </span><span class="jsdoc-keyword">return false</span><span class="jsdoc-syntax">;
87 </span><span class="jsdoc-keyword">return true</span><span class="jsdoc-syntax">;
89 </span><span class="jsdoc-var">startNode.cascade</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">f</span><span class="jsdoc-syntax">);
90 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.remove</span><span class="jsdoc-syntax">){
91 </span><span class="jsdoc-keyword">for</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">id </span><span class="jsdoc-keyword">in </span><span class="jsdoc-var">af</span><span class="jsdoc-syntax">){
92 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">"function"</span><span class="jsdoc-syntax">){
93 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">n </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">af</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">];
94 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">n </span><span class="jsdoc-syntax">&& </span><span class="jsdoc-var">n.parentNode</span><span class="jsdoc-syntax">){
95 </span><span class="jsdoc-var">n.parentNode.removeChild</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">);
102 </span><span class="jsdoc-comment">/**
103 * Clears the current filter. Note: with the "remove" option
104 * set a filter cannot be cleared.
106 </span><span class="jsdoc-var">clear </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
107 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">t </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.tree</span><span class="jsdoc-syntax">;
108 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">af </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.filtered</span><span class="jsdoc-syntax">;
109 </span><span class="jsdoc-keyword">for</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">id </span><span class="jsdoc-keyword">in </span><span class="jsdoc-var">af</span><span class="jsdoc-syntax">){
110 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">typeof </span><span class="jsdoc-var">id </span><span class="jsdoc-syntax">!= </span><span class="jsdoc-string">"function"</span><span class="jsdoc-syntax">){
111 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">n </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">af</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">id</span><span class="jsdoc-syntax">];
112 </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">n</span><span class="jsdoc-syntax">){
113 </span><span class="jsdoc-var">n.ui.show</span><span class="jsdoc-syntax">();
117 </span><span class="jsdoc-var">this.filtered </span><span class="jsdoc-syntax">= {};
120 </span></code></body></html>