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

   1 {
   2   "name" : "Roo.ComponentMgr",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "Provides a common registry of all components on a page so that they can be easily accessed by component id (see {@link Roo.getCmp}).",
   8   "isSingleton" : true,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "ComponentMgr",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [],
  19   "returns" : [],
  20   "throws" : "",
  21   "requires" : "",
  22   "config" : [],
  23   "methods" : [
  24     {
  25       "name" : "onAvailable",
  26       "type" : "function",
  27       "desc" : "Registers a function that will be called when a specified component is added to ComponentMgr",
  28       "sig" : "(id, fn, scope)",
  29       "static" : false,
  30       "memberOf" : "",
  31       "isStatic" : false,
  32       "isConstructor" : false,
  33       "isPrivate" : false,
  34       "example" : "",
  35       "deprecated" : "",
  36       "since" : "",
  37       "see" : "",
  38       "exceptions" : "",
  39       "requires" : "",
  40       "params" : [
  41         {
  42           "name" : "id",
  43           "type" : "String",
  44           "desc" : "The component id",
  45           "isOptional" : false
  46         },
  47         {
  48           "name" : "fn",
  49           "type" : "Funtction",
  50           "desc" : "The callback function",
  51           "isOptional" : false
  52         },
  53         {
  54           "name" : "scope",
  55           "type" : "Object",
  56           "desc" : "The scope of the callback",
  57           "isOptional" : false
  58         }
  59       ],
  60       "returns" : []
  61     },
  62     {
  63       "name" : "get",
  64       "type" : "function",
  65       "desc" : "Returns a component by id",
  66       "sig" : "(id)",
  67       "static" : false,
  68       "memberOf" : "",
  69       "isStatic" : false,
  70       "isConstructor" : false,
  71       "isPrivate" : false,
  72       "example" : "",
  73       "deprecated" : "",
  74       "since" : "",
  75       "see" : "",
  76       "exceptions" : "",
  77       "requires" : "",
  78       "params" : [
  79         {
  80           "name" : "id",
  81           "type" : "String",
  82           "desc" : "The component id",
  83           "isOptional" : false
  84         }
  85       ],
  86       "returns" : []
  87     },
  88     {
  89       "name" : "register",
  90       "type" : "function",
  91       "desc" : "Registers a component.",
  92       "sig" : "(c)",
  93       "static" : false,
  94       "memberOf" : "",
  95       "isStatic" : false,
  96       "isConstructor" : false,
  97       "isPrivate" : false,
  98       "example" : "",
  99       "deprecated" : "",
 100       "since" : "",
 101       "see" : "",
 102       "exceptions" : "",
 103       "requires" : "",
 104       "params" : [
 105         {
 106           "name" : "c",
 107           "type" : "Roo.Component",
 108           "desc" : "The component",
 109           "isOptional" : false
 110         }
 111       ],
 112       "returns" : []
 113     },
 114     {
 115       "name" : "unregister",
 116       "type" : "function",
 117       "desc" : "Unregisters a component.",
 118       "sig" : "(c)",
 119       "static" : false,
 120       "memberOf" : "",
 121       "isStatic" : false,
 122       "isConstructor" : false,
 123       "isPrivate" : false,
 124       "example" : "",
 125       "deprecated" : "",
 126       "since" : "",
 127       "see" : "",
 128       "exceptions" : "",
 129       "requires" : "",
 130       "params" : [
 131         {
 132           "name" : "c",
 133           "type" : "Roo.Component",
 134           "desc" : "The component",
 135           "isOptional" : false
 136         }
 137       ],
 138       "returns" : []
 139     }
 140   ],
 141   "events" : []
 142 }