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   "config" : [],
  29   "methods" : [
  30     {
  31       "name" : "clear",
  32       "desc" : "Clears the current filter. Note: with the \"remove\" option\nset a filter cannot be cleared.",
  33       "isStatic" : false,
  34       "isConstructor" : false,
  35       "isPrivate" : false,
  36       "memberOf" : "Roo.tree.TreeFilter",
  37       "example" : "",
  38       "deprecated" : "",
  39       "since" : "",
  40       "see" : "",
  41       "params" : [],
  42       "returns" : []
  43     },
  44     {
  45       "name" : "filter",
  46       "desc" : "Filter the data by a specific attribute.",
  47       "isStatic" : false,
  48       "isConstructor" : false,
  49       "isPrivate" : false,
  50       "memberOf" : "Roo.tree.TreeFilter",
  51       "example" : "",
  52       "deprecated" : "",
  53       "since" : "",
  54       "see" : "",
  55       "params" : [
  56         {
  57           "name" : "value",
  58           "type" : "String/RegExp",
  59           "desc" : "Either string that the attribute value\nshould start with or a RegExp to test against the attribute",
  60           "isOptional" : false
  61         },
  62         {
  63           "name" : "attr",
  64           "type" : "String",
  65           "desc" : "(optional) The attribute passed in your node's attributes collection. Defaults to \"text\".",
  66           "isOptional" : false
  67         },
  68         {
  69           "name" : "startNode",
  70           "type" : "TreeNode",
  71           "desc" : "(optional) The node to start the filter at.",
  72           "isOptional" : false
  73         }
  74       ],
  75       "returns" : []
  76     },
  77     {
  78       "name" : "filterBy",
  79       "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.",
  80       "isStatic" : false,
  81       "isConstructor" : false,
  82       "isPrivate" : false,
  83       "memberOf" : "Roo.tree.TreeFilter",
  84       "example" : "",
  85       "deprecated" : "",
  86       "since" : "",
  87       "see" : "",
  88       "params" : [
  89         {
  90           "name" : "fn",
  91           "type" : "Function",
  92           "desc" : "The filter function",
  93           "isOptional" : false
  94         },
  95         {
  96           "name" : "scope",
  97           "type" : "Object",
  98           "desc" : "(optional) The scope of the function (defaults to the current node)",
  99           "isOptional" : false
 100         }
 101       ],
 102       "returns" : []
 103     }
 104   ],
 105   "events" : []
 106 }