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

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