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

   1 {
   2   "name" : "Roo.ComponentMgr",
   3   "augments" : [
   4   ],
   5   "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}).",
   6   "isSingleton" : true,
   7   "isStatic" : false,
   8   "isBuiltin" : false,
   9   "memberOf" : "ComponentMgr",
  10   "example" : "",
  11   "deprecated" : "",
  12   "since" : "",
  13   "see" : "",
  14   "params" : [
  15   ],
  16   "returns" : [
  17   ],
  18   "config" : [
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "onAvailable",
  23       "desc" : "Registers a function that will be called when a specified component is added to ComponentMgr",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Roo.ComponentMgr",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33         {
  34           "name" : "id",
  35           "type" : "String",
  36           "desc" : "The component id",
  37           "isOptional" : false
  38         },
  39         {
  40           "name" : "fn",
  41           "type" : "Funtction",
  42           "desc" : "The callback function",
  43           "isOptional" : false
  44         },
  45         {
  46           "name" : "scope",
  47           "type" : "Object",
  48           "desc" : "The scope of the callback",
  49           "isOptional" : false
  50         }
  51       ],
  52       "returns" : [
  53       ]
  54     },
  55     {
  56       "name" : "get",
  57       "desc" : "Returns a component by id",
  58       "isStatic" : false,
  59       "isConstructor" : false,
  60       "isPrivate" : false,
  61       "memberOf" : "Roo.ComponentMgr",
  62       "example" : "",
  63       "deprecated" : "",
  64       "since" : "",
  65       "see" : "",
  66       "params" : [
  67         {
  68           "name" : "id",
  69           "type" : "String",
  70           "desc" : "The component id",
  71           "isOptional" : false
  72         }
  73       ],
  74       "returns" : [
  75       ]
  76     },
  77     {
  78       "name" : "register",
  79       "desc" : "Registers a component.",
  80       "isStatic" : false,
  81       "isConstructor" : false,
  82       "isPrivate" : false,
  83       "memberOf" : "Roo.ComponentMgr",
  84       "example" : "",
  85       "deprecated" : "",
  86       "since" : "",
  87       "see" : "",
  88       "params" : [
  89         {
  90           "name" : "c",
  91           "type" : "Roo.Component",
  92           "desc" : "The component",
  93           "isOptional" : false
  94         }
  95       ],
  96       "returns" : [
  97       ]
  98     },
  99     {
 100       "name" : "unregister",
 101       "desc" : "Unregisters a component.",
 102       "isStatic" : false,
 103       "isConstructor" : false,
 104       "isPrivate" : false,
 105       "memberOf" : "Roo.ComponentMgr",
 106       "example" : "",
 107       "deprecated" : "",
 108       "since" : "",
 109       "see" : "",
 110       "params" : [
 111         {
 112           "name" : "c",
 113           "type" : "Roo.Component",
 114           "desc" : "The component",
 115           "isOptional" : false
 116         }
 117       ],
 118       "returns" : [
 119       ]
 120     }
 121   ],
 122   "events" : [
 123   ]
 124 }