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