X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.tree.TreeFilter.json;fp=docs%2Fsymbols%2FRoo.tree.TreeFilter.json;h=2abe6e295ce5ac20a9cc2c4c26fe5e66da43bc66;hb=9ff8ded6bbbd258ecd646184ba26020874e2c085;hp=0000000000000000000000000000000000000000;hpb=2542b67d1a0768025056f2f330bfe50b64d1ad38;p=roojs1 diff --git a/docs/symbols/Roo.tree.TreeFilter.json b/docs/symbols/Roo.tree.TreeFilter.json new file mode 100644 index 0000000000..2abe6e295c --- /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