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

   1 {
   2   "name" : "Roo.CompositeElementLite",
   3   "augments" : [
   4     "Roo.CompositeElement"
   5   ],
   6   "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>",
   7   "isSingleton" : false,
   8   "isStatic" : true,
   9   "isBuiltin" : false,
  10   "config" : [
  11   ],
  12   "methods" : [
  13     {
  14       "name" : "each",
  15       "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>",
  16       "isStatic" : false,
  17       "isConstructor" : false,
  18       "isPrivate" : false,
  19       "memberOf" : "Roo.CompositeElementLite",
  20       "example" : "",
  21       "deprecated" : "",
  22       "since" : "",
  23       "see" : "",
  24       "params" : [
  25         {
  26           "name" : "fn",
  27           "type" : "Function",
  28           "desc" : "The function to call",
  29           "isOptional" : false
  30         },
  31         {
  32           "name" : "scope",
  33           "type" : "Object",
  34           "desc" : "(optional) The <i>this</i> object (defaults to the element)",
  35           "isOptional" : false
  36         }
  37       ],
  38       "returns" : [
  39         {
  40           "name" : "",
  41           "type" : "CompositeElement",
  42           "desc" : "this"
  43         }
  44       ]
  45     },
  46     {
  47       "name" : "item",
  48       "desc" : "Returns a flyweight Element of the dom element object at the specified index",
  49       "isStatic" : false,
  50       "isConstructor" : false,
  51       "isPrivate" : false,
  52       "memberOf" : "Roo.CompositeElementLite",
  53       "example" : "",
  54       "deprecated" : "",
  55       "since" : "",
  56       "see" : "",
  57       "params" : [
  58         {
  59           "name" : "index",
  60           "type" : "Number",
  61           "desc" : "",
  62           "isOptional" : false
  63         }
  64       ],
  65       "returns" : [
  66         {
  67           "name" : "",
  68           "type" : "Roo.Element",
  69           "desc" : ""
  70         }
  71       ]
  72     },
  73     {
  74       "name" : "add",
  75       "desc" : "Adds elements to this composite.",
  76       "isStatic" : false,
  77       "isConstructor" : false,
  78       "isPrivate" : false,
  79       "memberOf" : "Roo.CompositeElement",
  80       "example" : "",
  81       "deprecated" : "",
  82       "since" : "",
  83       "see" : "",
  84       "params" : [
  85         {
  86           "name" : "els",
  87           "type" : "String/Array",
  88           "desc" : "A string CSS selector, an array of elements or an element",
  89           "isOptional" : false
  90         }
  91       ],
  92       "returns" : [
  93         {
  94           "name" : "",
  95           "type" : "CompositeElement",
  96           "desc" : "this"
  97         }
  98       ]
  99     },
 100     {
 101       "name" : "contains",
 102       "desc" : "Returns true if this composite contains the passed element",
 103       "isStatic" : false,
 104       "isConstructor" : false,
 105       "isPrivate" : false,
 106       "memberOf" : "Roo.CompositeElement",
 107       "example" : "",
 108       "deprecated" : "",
 109       "since" : "",
 110       "see" : "",
 111       "params" : [
 112       ],
 113       "returns" : [
 114         {
 115           "name" : "",
 116           "type" : "",
 117           "desc" : "Boolean"
 118         }
 119       ]
 120     },
 121     {
 122       "name" : "replaceElement",
 123       "desc" : "Replaces the specified element with the passed element.",
 124       "isStatic" : false,
 125       "isConstructor" : false,
 126       "isPrivate" : false,
 127       "memberOf" : "Roo.CompositeElement",
 128       "example" : "",
 129       "deprecated" : "",
 130       "since" : "",
 131       "see" : "",
 132       "params" : [
 133         {
 134           "name" : "el",
 135           "type" : "String/HTMLElement/Element/Number",
 136           "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.",
 137           "isOptional" : false
 138         },
 139         {
 140           "name" : "replacement",
 141           "type" : "String/HTMLElement/Element",
 142           "desc" : "The id of an element or the Element itself.",
 143           "isOptional" : false
 144         },
 145         {
 146           "name" : "domReplace",
 147           "type" : "Boolean",
 148           "desc" : "(Optional) True to remove and replace the element in the document too.",
 149           "isOptional" : false
 150         }
 151       ],
 152       "returns" : [
 153         {
 154           "name" : "",
 155           "type" : "CompositeElement",
 156           "desc" : "this"
 157         }
 158       ]
 159     },
 160     {
 161       "name" : "fill",
 162       "desc" : "Clears this composite and adds the elements returned by the passed selector.",
 163       "isStatic" : false,
 164       "isConstructor" : false,
 165       "isPrivate" : false,
 166       "memberOf" : "Roo.CompositeElement",
 167       "example" : "",
 168       "deprecated" : "",
 169       "since" : "",
 170       "see" : "",
 171       "params" : [
 172         {
 173           "name" : "els",
 174           "type" : "String/Array",
 175           "desc" : "A string CSS selector, an array of elements or an element",
 176           "isOptional" : false
 177         }
 178       ],
 179       "returns" : [
 180         {
 181           "name" : "",
 182           "type" : "CompositeElement",
 183           "desc" : "this"
 184         }
 185       ]
 186     },
 187     {
 188       "name" : "clear",
 189       "desc" : "Removes all elements.",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "memberOf" : "Roo.CompositeElement",
 194       "example" : "",
 195       "deprecated" : "",
 196       "since" : "",
 197       "see" : "",
 198       "params" : [
 199       ],
 200       "returns" : [
 201       ]
 202     },
 203     {
 204       "name" : "filter",
 205       "desc" : "Filters this composite to only elements that match the passed selector.",
 206       "isStatic" : false,
 207       "isConstructor" : false,
 208       "isPrivate" : false,
 209       "memberOf" : "Roo.CompositeElement",
 210       "example" : "",
 211       "deprecated" : "",
 212       "since" : "",
 213       "see" : "",
 214       "params" : [
 215         {
 216           "name" : "selector",
 217           "type" : "String",
 218           "desc" : "A string CSS selector",
 219           "isOptional" : false
 220         },
 221         {
 222           "name" : "inverse",
 223           "type" : "Boolean",
 224           "desc" : "return inverse filter (not matches)",
 225           "isOptional" : false
 226         }
 227       ],
 228       "returns" : [
 229         {
 230           "name" : "",
 231           "type" : "CompositeElement",
 232           "desc" : "this"
 233         }
 234       ]
 235     },
 236     {
 237       "name" : "last",
 238       "desc" : "Returns the last Element",
 239       "isStatic" : false,
 240       "isConstructor" : false,
 241       "isPrivate" : false,
 242       "memberOf" : "Roo.CompositeElement",
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "params" : [
 248       ],
 249       "returns" : [
 250         {
 251           "name" : "",
 252           "type" : "Roo.Element",
 253           "desc" : ""
 254         }
 255       ]
 256     },
 257     {
 258       "name" : "removeElement",
 259       "desc" : "Removes the specified element(s).",
 260       "isStatic" : false,
 261       "isConstructor" : false,
 262       "isPrivate" : false,
 263       "memberOf" : "Roo.CompositeElement",
 264       "example" : "",
 265       "deprecated" : "",
 266       "since" : "",
 267       "see" : "",
 268       "params" : [
 269         {
 270           "name" : "el",
 271           "type" : "Mixed",
 272           "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.",
 273           "isOptional" : false
 274         },
 275         {
 276           "name" : "removeDom",
 277           "type" : "Boolean",
 278           "desc" : "(optional) True to also remove the element from the document",
 279           "isOptional" : false
 280         }
 281       ],
 282       "returns" : [
 283         {
 284           "name" : "",
 285           "type" : "CompositeElement",
 286           "desc" : "this"
 287         }
 288       ]
 289     },
 290     {
 291       "name" : "indexOf",
 292       "desc" : "Returns true if this composite contains the passed element",
 293       "isStatic" : false,
 294       "isConstructor" : false,
 295       "isPrivate" : false,
 296       "memberOf" : "Roo.CompositeElement",
 297       "example" : "",
 298       "deprecated" : "",
 299       "since" : "",
 300       "see" : "",
 301       "params" : [
 302       ],
 303       "returns" : [
 304         {
 305           "name" : "",
 306           "type" : "",
 307           "desc" : "Boolean"
 308         }
 309       ]
 310     },
 311     {
 312       "name" : "getCount",
 313       "desc" : "Returns the number of elements in this composite",
 314       "isStatic" : false,
 315       "isConstructor" : false,
 316       "isPrivate" : false,
 317       "memberOf" : "Roo.CompositeElement",
 318       "example" : "",
 319       "deprecated" : "",
 320       "since" : "",
 321       "see" : "",
 322       "params" : [
 323       ],
 324       "returns" : [
 325         {
 326           "name" : "",
 327           "type" : "",
 328           "desc" : "Number"
 329         }
 330       ]
 331     },
 332     {
 333       "name" : "first",
 334       "desc" : "Returns the first Element",
 335       "isStatic" : false,
 336       "isConstructor" : false,
 337       "isPrivate" : false,
 338       "memberOf" : "Roo.CompositeElement",
 339       "example" : "",
 340       "deprecated" : "",
 341       "since" : "",
 342       "see" : "",
 343       "params" : [
 344       ],
 345       "returns" : [
 346         {
 347           "name" : "",
 348           "type" : "Roo.Element",
 349           "desc" : ""
 350         }
 351       ]
 352     }
 353   ],
 354   "events" : [
 355   ]
 356 }