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