git.roojs.org Git - roojs1/blob - docs/symbols/Roo.tree.TreeFilter.json

   1 {
   2   "name" : "Roo.tree.TreeFilter",
   3   "augments" : [],
   4   "desc" : "Note this class is experimental and doesn't update the indent (lines) or expand collapse icons of the nodes",
   5   "isSingleton" : false,
   6   "isStatic" : false,
   7   "isBuiltin" : false,
   8   "memberOf" : "TreeFilter",
   9   "example" : "",
  10   "deprecated" : "",
  11   "since" : "",
  12   "see" : "",
  13   "params" : [
  14     {
  15       "name" : "tree",
  16       "type" : "TreePanel",
  17       "desc" : "",
  18       "isOptional" : false
  19     },
  20     {
  21       "name" : "config",
  22       "type" : "Object",
  23       "desc" : "(optional)",
  24       "isOptional" : false
  25     }
  26   ],
  27   "returns" : [],
  28   "throws" : "",
  29   "requires" : "",
  30   "config" : [],
  31   "methods" : [
  32     {
  33       "name" : "clear",
  34       "type" : "function",
  35       "desc" : "Clears the current filter. Note: with the \"remove\" option\nset a filter cannot be cleared.",
  36       "sig" : "()\n{\n\n}",
  37       "static" : false,
  38       "memberOf" : "",
  39       "isStatic" : false,
  40       "isConstructor" : false,
  41       "isPrivate" : false,
  42       "example" : "",
  43       "deprecated" : "",
  44       "since" : "",
  45       "see" : "",
  46       "exceptions" : "",
  47       "requires" : "",
  48       "params" : [],
  49       "returns" : []
  50     },
  51     {
  52       "name" : "filter",
  53       "type" : "function",
  54       "desc" : "Filter the data by a specific attribute.",
  55       "sig" : "(value, attr, startNode)",
  56       "static" : false,
  57       "memberOf" : "",
  58       "isStatic" : false,
  59       "isConstructor" : false,
  60       "isPrivate" : false,
  61       "example" : "",
  62       "deprecated" : "",
  63       "since" : "",
  64       "see" : "",
  65       "exceptions" : "",
  66       "requires" : "",
  67       "params" : [
  68         {
  69           "name" : "value",
  70           "type" : "String/RegExp",
  71           "desc" : "Either string that the attribute value\nshould start with or a RegExp to test against the attribute",
  72           "isOptional" : false
  73         },
  74         {
  75           "name" : "attr",
  76           "type" : "String",
  77           "desc" : "(optional) The attribute passed in your node's attributes collection. Defaults to \"text\".",
  78           "isOptional" : false
  79         },
  80         {
  81           "name" : "startNode",
  82           "type" : "TreeNode",
  83           "desc" : "(optional) The node to start the filter at.",
  84           "isOptional" : false
  85         }
  86       ],
  87       "returns" : []
  88     },
  89     {
  90       "name" : "filterBy",
  91       "type" : "function",
  92       "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.",
  93       "sig" : "(fn, scope)",
  94       "static" : false,
  95       "memberOf" : "",
  96       "isStatic" : false,
  97       "isConstructor" : false,
  98       "isPrivate" : false,
  99       "example" : "",
 100       "deprecated" : "",
 101       "since" : "",
 102       "see" : "",
 103       "exceptions" : "",
 104       "requires" : "",
 105       "params" : [
 106         {
 107           "name" : "fn",
 108           "type" : "Function",
 109           "desc" : "The filter function",
 110           "isOptional" : false
 111         },
 112         {
 113           "name" : "scope",
 114           "type" : "Object",
 115           "desc" : "(optional) The scope of the function (defaults to the current node)",
 116           "isOptional" : false
 117         }
 118       ],
 119       "returns" : []
 120     }
 121   ],
 122   "events" : []
 123 }