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

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