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