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

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