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

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