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