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

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