git.roojs.org Git - roojs1/blob - docs2/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" : true,
   8   "isBuiltin" : false,
   9   "config" : [
  10   ],
  11   "methods" : [
  12     {
  13       "name" : "clear",
  14       "desc" : "Clears the current filter. Note: with the \"remove\" option\nset a filter cannot be cleared.",
  15       "isStatic" : false,
  16       "isConstructor" : false,
  17       "isPrivate" : false,
  18       "memberOf" : "Roo.tree.TreeFilter",
  19       "example" : "",
  20       "deprecated" : "",
  21       "since" : "",
  22       "see" : "",
  23       "params" : [
  24       ],
  25       "returns" : [
  26       ]
  27     },
  28     {
  29       "name" : "filter",
  30       "desc" : "Filter the data by a specific attribute.",
  31       "isStatic" : false,
  32       "isConstructor" : false,
  33       "isPrivate" : false,
  34       "memberOf" : "Roo.tree.TreeFilter",
  35       "example" : "",
  36       "deprecated" : "",
  37       "since" : "",
  38       "see" : "",
  39       "params" : [
  40         {
  41           "name" : "value",
  42           "type" : "String/RegExp",
  43           "desc" : "Either string that the attribute value\nshould start with or a RegExp to test against the attribute",
  44           "isOptional" : false
  45         },
  46         {
  47           "name" : "attr",
  48           "type" : "String",
  49           "desc" : "(optional) The attribute passed in your node's attributes collection. Defaults to \"text\".",
  50           "isOptional" : false
  51         },
  52         {
  53           "name" : "startNode",
  54           "type" : "TreeNode",
  55           "desc" : "(optional) The node to start the filter at.",
  56           "isOptional" : false
  57         }
  58       ],
  59       "returns" : [
  60       ]
  61     },
  62     {
  63       "name" : "filterBy",
  64       "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.",
  65       "isStatic" : false,
  66       "isConstructor" : false,
  67       "isPrivate" : false,
  68       "memberOf" : "Roo.tree.TreeFilter",
  69       "example" : "",
  70       "deprecated" : "",
  71       "since" : "",
  72       "see" : "",
  73       "params" : [
  74         {
  75           "name" : "fn",
  76           "type" : "Function",
  77           "desc" : "The filter function",
  78           "isOptional" : false
  79         },
  80         {
  81           "name" : "scope",
  82           "type" : "Object",
  83           "desc" : "(optional) The scope of the function (defaults to the current node)",
  84           "isOptional" : false
  85         }
  86       ],
  87       "returns" : [
  88       ]
  89     }
  90   ],
  91   "events" : [
  92   ]
  93 }