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