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

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