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

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