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

   1 {
   2   "name" : "Roo.CompositeElementLite",
   3   "augments" : [
   4     "Roo.CompositeElement"
   5   ],
   6   "childClasses" : {  },
   7   "tree_children" : [],
   8   "tree_parent" : [],
   9   "desc" : "Flyweight composite class. Reuses the same Roo.Element for element operations.\n <pre><code>\n var els = Roo.select(\"#some-el div.some-class\");\n // or select directly from an existing element\n var el = Roo.get('some-el');\n el.select('div.some-class');\n\n els.setWidth(100); // all elements become 100 width\n els.hide(true); // all elements fade out and hide\n // or\n els.setWidth(100).hide(true);\n </code></pre><br><br>\n<b>NOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element\nactions will be performed on all the elements in this collection.</b>",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "isAbstract" : false,
  14   "isBuilderTop" : false,
  15   "memberOf" : "CompositeElementLite",
  16   "example" : "",
  17   "deprecated" : "",
  18   "since" : "",
  19   "see" : "",
  20   "params" : [],
  21   "returns" : [],
  22   "throws" : "",
  23   "requires" : "",
  24   "config" : [],
  25   "methods" : [
  26     {
  27       "name" : "each",
  28       "type" : "function",
  29       "desc" : "Calls the passed function passing (el, this, index) for each element in this composite. <b>The element\npassed is the flyweight (shared) Roo.Element instance, so if you require a\na reference to the dom node, use el.dom.</b>",
  30       "sig" : "(fn, scope)",
  31       "static" : false,
  32       "memberOf" : "",
  33       "isStatic" : false,
  34       "isConstructor" : false,
  35       "isPrivate" : false,
  36       "example" : "",
  37       "deprecated" : "",
  38       "since" : "",
  39       "see" : "",
  40       "exceptions" : "",
  41       "requires" : "",
  42       "params" : [
  43         {
  44           "name" : "fn",
  45           "type" : "Function",
  46           "desc" : "The function to call",
  47           "isOptional" : false
  48         },
  49         {
  50           "name" : "scope",
  51           "type" : "Object",
  52           "desc" : "(optional) The <i>this</i> object (defaults to the element)",
  53           "isOptional" : false
  54         }
  55       ],
  56       "returns" : [
  57         {
  58           "name" : "",
  59           "type" : "CompositeElement",
  60           "desc" : "this"
  61         }
  62       ]
  63     },
  64     {
  65       "name" : "item",
  66       "type" : "function",
  67       "desc" : "Returns a flyweight Element of the dom element object at the specified index",
  68       "sig" : "(index)",
  69       "static" : false,
  70       "memberOf" : "",
  71       "isStatic" : false,
  72       "isConstructor" : false,
  73       "isPrivate" : false,
  74       "example" : "",
  75       "deprecated" : "",
  76       "since" : "",
  77       "see" : "",
  78       "exceptions" : "",
  79       "requires" : "",
  80       "params" : [
  81         {
  82           "name" : "index",
  83           "type" : "Number",
  84           "desc" : "",
  85           "isOptional" : false
  86         }
  87       ],
  88       "returns" : [
  89         {
  90           "name" : "",
  91           "type" : "Roo.Element",
  92           "desc" : ""
  93         }
  94       ]
  95     },
  96     {
  97       "name" : "add",
  98       "type" : "function",
  99       "desc" : "Adds elements to this composite.",
 100       "sig" : "(els)",
 101       "static" : false,
 102       "memberOf" : "Roo.CompositeElement",
 103       "isStatic" : false,
 104       "isConstructor" : false,
 105       "isPrivate" : false,
 106       "example" : "",
 107       "deprecated" : "",
 108       "since" : "",
 109       "see" : "",
 110       "exceptions" : "",
 111       "requires" : "",
 112       "params" : [
 113         {
 114           "name" : "els",
 115           "type" : "String/Array",
 116           "desc" : "A string CSS selector, an array of elements or an element",
 117           "isOptional" : false
 118         }
 119       ],
 120       "returns" : [
 121         {
 122           "name" : "",
 123           "type" : "CompositeElement",
 124           "desc" : "this"
 125         }
 126       ]
 127     },
 128     {
 129       "name" : "contains",
 130       "type" : "function",
 131       "desc" : "Returns true if this composite contains the passed element",
 132       "sig" : "()\n{\n\n}",
 133       "static" : false,
 134       "memberOf" : "Roo.CompositeElement",
 135       "isStatic" : false,
 136       "isConstructor" : false,
 137       "isPrivate" : false,
 138       "example" : "",
 139       "deprecated" : "",
 140       "since" : "",
 141       "see" : "",
 142       "exceptions" : "",
 143       "requires" : "",
 144       "params" : [],
 145       "returns" : [
 146         {
 147           "name" : "",
 148           "type" : "",
 149           "desc" : "Boolean"
 150         }
 151       ]
 152     },
 153     {
 154       "name" : "replaceElement",
 155       "type" : "function",
 156       "desc" : "Replaces the specified element with the passed element.",
 157       "sig" : "(el, replacement, domReplace)",
 158       "static" : false,
 159       "memberOf" : "Roo.CompositeElement",
 160       "isStatic" : false,
 161       "isConstructor" : false,
 162       "isPrivate" : false,
 163       "example" : "",
 164       "deprecated" : "",
 165       "since" : "",
 166       "see" : "",
 167       "exceptions" : "",
 168       "requires" : "",
 169       "params" : [
 170         {
 171           "name" : "el",
 172           "type" : "String/HTMLElement/Element/Number",
 173           "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.",
 174           "isOptional" : false
 175         },
 176         {
 177           "name" : "replacement",
 178           "type" : "String/HTMLElement/Element",
 179           "desc" : "The id of an element or the Element itself.",
 180           "isOptional" : false
 181         },
 182         {
 183           "name" : "domReplace",
 184           "type" : "Boolean",
 185           "desc" : "(Optional) True to remove and replace the element in the document too.",
 186           "isOptional" : false
 187         }
 188       ],
 189       "returns" : [
 190         {
 191           "name" : "",
 192           "type" : "CompositeElement",
 193           "desc" : "this"
 194         }
 195       ]
 196     },
 197     {
 198       "name" : "fill",
 199       "type" : "function",
 200       "desc" : "Clears this composite and adds the elements returned by the passed selector.",
 201       "sig" : "(els)",
 202       "static" : false,
 203       "memberOf" : "Roo.CompositeElement",
 204       "isStatic" : false,
 205       "isConstructor" : false,
 206       "isPrivate" : false,
 207       "example" : "",
 208       "deprecated" : "",
 209       "since" : "",
 210       "see" : "",
 211       "exceptions" : "",
 212       "requires" : "",
 213       "params" : [
 214         {
 215           "name" : "els",
 216           "type" : "String/Array",
 217           "desc" : "A string CSS selector, an array of elements or an element",
 218           "isOptional" : false
 219         }
 220       ],
 221       "returns" : [
 222         {
 223           "name" : "",
 224           "type" : "CompositeElement",
 225           "desc" : "this"
 226         }
 227       ]
 228     },
 229     {
 230       "name" : "clear",
 231       "type" : "function",
 232       "desc" : "Removes all elements.",
 233       "sig" : "()\n{\n\n}",
 234       "static" : false,
 235       "memberOf" : "Roo.CompositeElement",
 236       "isStatic" : false,
 237       "isConstructor" : false,
 238       "isPrivate" : false,
 239       "example" : "",
 240       "deprecated" : "",
 241       "since" : "",
 242       "see" : "",
 243       "exceptions" : "",
 244       "requires" : "",
 245       "params" : [],
 246       "returns" : []
 247     },
 248     {
 249       "name" : "filter",
 250       "type" : "function",
 251       "desc" : "Filters this composite to only elements that match the passed selector.",
 252       "sig" : "(selector, inverse)",
 253       "static" : false,
 254       "memberOf" : "Roo.CompositeElement",
 255       "isStatic" : false,
 256       "isConstructor" : false,
 257       "isPrivate" : false,
 258       "example" : "",
 259       "deprecated" : "",
 260       "since" : "",
 261       "see" : "",
 262       "exceptions" : "",
 263       "requires" : "",
 264       "params" : [
 265         {
 266           "name" : "selector",
 267           "type" : "String",
 268           "desc" : "A string CSS selector",
 269           "isOptional" : false
 270         },
 271         {
 272           "name" : "inverse",
 273           "type" : "Boolean",
 274           "desc" : "return inverse filter (not matches)",
 275           "isOptional" : false
 276         }
 277       ],
 278       "returns" : [
 279         {
 280           "name" : "",
 281           "type" : "CompositeElement",
 282           "desc" : "this"
 283         }
 284       ]
 285     },
 286     {
 287       "name" : "last",
 288       "type" : "function",
 289       "desc" : "Returns the last Element",
 290       "sig" : "()\n{\n\n}",
 291       "static" : false,
 292       "memberOf" : "Roo.CompositeElement",
 293       "isStatic" : false,
 294       "isConstructor" : false,
 295       "isPrivate" : false,
 296       "example" : "",
 297       "deprecated" : "",
 298       "since" : "",
 299       "see" : "",
 300       "exceptions" : "",
 301       "requires" : "",
 302       "params" : [],
 303       "returns" : [
 304         {
 305           "name" : "",
 306           "type" : "Roo.Element",
 307           "desc" : ""
 308         }
 309       ]
 310     },
 311     {
 312       "name" : "removeElement",
 313       "type" : "function",
 314       "desc" : "Removes the specified element(s).",
 315       "sig" : "(el, removeDom)",
 316       "static" : false,
 317       "memberOf" : "Roo.CompositeElement",
 318       "isStatic" : false,
 319       "isConstructor" : false,
 320       "isPrivate" : false,
 321       "example" : "",
 322       "deprecated" : "",
 323       "since" : "",
 324       "see" : "",
 325       "exceptions" : "",
 326       "requires" : "",
 327       "params" : [
 328         {
 329           "name" : "el",
 330           "type" : "Mixed",
 331           "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.",
 332           "isOptional" : false
 333         },
 334         {
 335           "name" : "removeDom",
 336           "type" : "Boolean",
 337           "desc" : "(optional) True to also remove the element from the document",
 338           "isOptional" : false
 339         }
 340       ],
 341       "returns" : [
 342         {
 343           "name" : "",
 344           "type" : "CompositeElement",
 345           "desc" : "this"
 346         }
 347       ]
 348     },
 349     {
 350       "name" : "indexOf",
 351       "type" : "function",
 352       "desc" : "Returns true if this composite contains the passed element",
 353       "sig" : "()\n{\n\n}",
 354       "static" : false,
 355       "memberOf" : "Roo.CompositeElement",
 356       "isStatic" : false,
 357       "isConstructor" : false,
 358       "isPrivate" : false,
 359       "example" : "",
 360       "deprecated" : "",
 361       "since" : "",
 362       "see" : "",
 363       "exceptions" : "",
 364       "requires" : "",
 365       "params" : [],
 366       "returns" : [
 367         {
 368           "name" : "",
 369           "type" : "",
 370           "desc" : "Boolean"
 371         }
 372       ]
 373     },
 374     {
 375       "name" : "getCount",
 376       "type" : "function",
 377       "desc" : "Returns the number of elements in this composite",
 378       "sig" : "()\n{\n\n}",
 379       "static" : false,
 380       "memberOf" : "Roo.CompositeElement",
 381       "isStatic" : false,
 382       "isConstructor" : false,
 383       "isPrivate" : false,
 384       "example" : "",
 385       "deprecated" : "",
 386       "since" : "",
 387       "see" : "",
 388       "exceptions" : "",
 389       "requires" : "",
 390       "params" : [],
 391       "returns" : [
 392         {
 393           "name" : "",
 394           "type" : "",
 395           "desc" : "Number"
 396         }
 397       ]
 398     },
 399     {
 400       "name" : "first",
 401       "type" : "function",
 402       "desc" : "Returns the first Element",
 403       "sig" : "()\n{\n\n}",
 404       "static" : false,
 405       "memberOf" : "Roo.CompositeElement",
 406       "isStatic" : false,
 407       "isConstructor" : false,
 408       "isPrivate" : false,
 409       "example" : "",
 410       "deprecated" : "",
 411       "since" : "",
 412       "see" : "",
 413       "exceptions" : "",
 414       "requires" : "",
 415       "params" : [],
 416       "returns" : [
 417         {
 418           "name" : "",
 419           "type" : "Roo.Element",
 420           "desc" : ""
 421         }
 422       ]
 423     }
 424   ],
 425   "events" : []
 426 }