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

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