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

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