Fix #5654 - roojspacker - get it working as a doc tool...

[roojs1] / docs / symbols / Roo.tree.TreeFilter.json

diff --git a/docs/symbols/Roo.tree.TreeFilter.json b/docs/symbols/Roo.tree.TreeFilter.json
new file mode 100644 (file)
index 0000000..2abe6e2
--- /dev/null
+++ b/docs/symbols/Roo.tree.TreeFilter.json
@@ -0,0 +1,114 @@
+{
+  "name" : "Roo.tree.TreeFilter",
+  "augments" : [
+  ],
+  "desc" : "Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes",
+  "isSingleton" : false,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "TreeFilter",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+    {
+      "name" : "tree",
+      "type" : "TreePanel",
+      "desc" : "",
+      "isOptional" : false
+    },
+    {
+      "name" : "config",
+      "type" : "Object",
+      "desc" : "(optional)",
+      "isOptional" : false
+    }
+  ],
+  "returns" : [
+  ],
+  "config" : [
+  ],
+  "methods" : [
+    {
+      "name" : "clear",
+      "desc" : "Clears the current filter. Note: with the \"remove\" option\nset a filter cannot be cleared.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.tree.TreeFilter",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "filter",
+      "desc" : "Filter the data by a specific attribute.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.tree.TreeFilter",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "value",
+          "type" : "String/RegExp",
+          "desc" : "Either string that the attribute value\nshould start with or a RegExp to test against the attribute",
+          "isOptional" : false
+        },
+        {
+          "name" : "attr",
+          "type" : "String",
+          "desc" : "(optional) The attribute passed in your node's attributes collection. Defaults to \"text\".",
+          "isOptional" : false
+        },
+        {
+          "name" : "startNode",
+          "type" : "TreeNode",
+          "desc" : "(optional) The node to start the filter at.",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "filterBy",
+      "desc" : "Filter by a function. The passed function will be called with each\nnode in the tree (or from the startNode). If the function returns true, the node is kept\notherwise it is filtered. If a node is filtered, its children are also filtered.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.tree.TreeFilter",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "fn",
+          "type" : "Function",
+          "desc" : "The filter function",
+          "isOptional" : false
+        },
+        {
+          "name" : "scope",
+          "type" : "Object",
+          "desc" : "(optional) The scope of the function (defaults to the current node)",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file