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

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