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

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