docs/output/Ext.CompositeElementLite.js

   1 Ext.data.JsonP.Ext_CompositeElementLite({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "xtype": null,
   7   "docauthor": null,
   8   "members": {
   9     "cfg": [
  10
  11     ],
  12     "method": [
  13       {
  14         "deprecated": null,
  15         "alias": null,
  16         "protected": false,
  17         "tagname": "method",
  18         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-add",
  19         "shortDoc": "Adds elements to this Composite object. ...",
  20         "static": false,
  21         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
  22         "private": false,
  23         "params": [
  24           {
  25             "type": "Mixed",
  26             "optional": false,
  27             "doc": "<p>Either an Array of DOM elements to add, or another Composite object who's elements should be added.</p>\n",
  28             "name": "els"
  29           },
  30           {
  31             "type": "Object",
  32             "optional": false,
  33             "doc": "\n",
  34             "name": "root"
  35           }
  36         ],
  37         "name": "add",
  38         "owner": "Ext.CompositeElementLite",
  39         "doc": "<p>Adds elements to this Composite object.</p>\n",
  40         "linenr": 75,
  41         "return": {
  42           "type": "CompositeElement",
  43           "doc": "<p>This Composite object.</p>\n"
  44         },
  45         "html_filename": "CompositeElementLite.html"
  46       },
  47       {
  48         "deprecated": null,
  49         "alias": null,
  50         "protected": false,
  51         "tagname": "method",
  52         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-clear",
  53         "shortDoc": "Removes all elements. ...",
  54         "static": false,
  55         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
  56         "private": false,
  57         "params": [
  58
  59         ],
  60         "name": "clear",
  61         "owner": "Ext.CompositeElementLite",
  62         "doc": "<p>Removes all elements.</p>\n",
  63         "linenr": 246,
  64         "return": {
  65           "type": "void",
  66           "doc": "\n"
  67         },
  68         "html_filename": "CompositeElementLite.html"
  69       },
  70       {
  71         "deprecated": null,
  72         "alias": null,
  73         "protected": false,
  74         "tagname": "method",
  75         "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-contains",
  76         "shortDoc": "Returns true if this composite contains the passed element ...",
  77         "static": false,
  78         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
  79         "private": false,
  80         "params": [
  81           {
  82             "type": "Object",
  83             "optional": false,
  84             "doc": "<p>{Mixed} The id of an element, or an <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a>, or an HtmlElement to find within the composite collection.</p>\n",
  85             "name": "el"
  86           }
  87         ],
  88         "name": "contains",
  89         "owner": "Ext.CompositeElementLite",
  90         "doc": "<p>Returns true if this composite contains the passed element</p>\n",
  91         "linenr": 35,
  92         "return": {
  93           "type": "void",
  94           "doc": "<p>Boolean</p>\n"
  95         },
  96         "html_filename": "CompositeElementLite-more.html"
  97       },
  98       {
  99         "deprecated": null,
 100         "alias": null,
 101         "protected": false,
 102         "tagname": "method",
 103         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-each",
 104         "shortDoc": "Calls the passed function for each element in this composite. ...",
 105         "static": false,
 106         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 107         "private": false,
 108         "params": [
 109           {
 110             "type": "Function",
 111             "optional": false,
 112             "doc": "<p>The function to call. The function is passed the following parameters:<ul>\n<li><b>el</b> : Element<div class=\"sub-desc\">The current Element in the iteration.\n<b>This is the flyweight (shared) <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a> instance, so if you require a\na reference to the dom node, use el.dom.</b></div></li>\n<li><b>c</b> : Composite<div class=\"sub-desc\">This Composite object.</div></li>\n<li><b>idx</b> : Number<div class=\"sub-desc\">The zero-based index in the iteration.</div></li>\n</ul></p>\n",
 113             "name": "fn"
 114           },
 115           {
 116             "type": "Object",
 117             "optional": true,
 118             "doc": "<p>(optional) The scope (<i>this</i> reference) in which the function is executed. (defaults to the Element)</p>\n",
 119             "name": "scope"
 120           }
 121         ],
 122         "name": "each",
 123         "owner": "Ext.CompositeElementLite",
 124         "doc": "<p>Calls the passed function for each element in this composite.</p>\n\n",
 125         "linenr": 145,
 126         "return": {
 127           "type": "CompositeElement",
 128           "doc": "<p>this</p>\n"
 129         },
 130         "html_filename": "CompositeElementLite.html"
 131       },
 132       {
 133         "deprecated": null,
 134         "alias": null,
 135         "protected": false,
 136         "tagname": "method",
 137         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-fill",
 138         "shortDoc": "Clears this Composite and adds the elements passed. ...",
 139         "static": false,
 140         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 141         "private": false,
 142         "params": [
 143           {
 144             "type": "Mixed",
 145             "optional": false,
 146             "doc": "<p>Either an array of DOM elements, or another Composite from which to fill this Composite.</p>\n",
 147             "name": "els"
 148           }
 149         ],
 150         "name": "fill",
 151         "owner": "Ext.CompositeElementLite",
 152         "doc": "<p>Clears this Composite and adds the elements passed.</p>\n",
 153         "linenr": 175,
 154         "return": {
 155           "type": "CompositeElement",
 156           "doc": "<p>this</p>\n"
 157         },
 158         "html_filename": "CompositeElementLite.html"
 159       },
 160       {
 161         "deprecated": null,
 162         "alias": null,
 163         "protected": false,
 164         "tagname": "method",
 165         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-filter",
 166         "shortDoc": "Filters this composite to only elements that match the passed selector. ...",
 167         "static": false,
 168         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 169         "private": false,
 170         "params": [
 171           {
 172             "type": "String/Function",
 173             "optional": false,
 174             "doc": "<p>A string CSS selector or a comparison function.\nThe comparison function will be called with the following arguments:<ul>\n<li><code>el</code> : Ext.core.Element<div class=\"sub-desc\">The current DOM element.</div></li>\n<li><code>index</code> : Number<div class=\"sub-desc\">The current index within the collection.</div></li>\n</ul></p>\n",
 175             "name": "selector"
 176           }
 177         ],
 178         "name": "filter",
 179         "owner": "Ext.CompositeElementLite",
 180         "doc": "<p>Filters this composite to only elements that match the passed selector.</p>\n",
 181         "linenr": 187,
 182         "return": {
 183           "type": "CompositeElement",
 184           "doc": "<p>this</p>\n"
 185         },
 186         "html_filename": "CompositeElementLite.html"
 187       },
 188       {
 189         "deprecated": null,
 190         "alias": null,
 191         "protected": false,
 192         "tagname": "method",
 193         "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-first",
 194         "shortDoc": "Returns the first Element ...",
 195         "static": false,
 196         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
 197         "private": false,
 198         "params": [
 199
 200         ],
 201         "name": "first",
 202         "owner": "Ext.CompositeElementLite",
 203         "doc": "<p>Returns the first Element</p>\n",
 204         "linenr": 19,
 205         "return": {
 206           "type": "Ext.core.Element",
 207           "doc": "\n"
 208         },
 209         "html_filename": "CompositeElementLite-more.html"
 210       },
 211       {
 212         "deprecated": null,
 213         "alias": null,
 214         "protected": false,
 215         "tagname": "method",
 216         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-getCount",
 217         "shortDoc": "Returns the number of elements in this Composite. ...",
 218         "static": false,
 219         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 220         "private": false,
 221         "params": [
 222
 223         ],
 224         "name": "getCount",
 225         "owner": "Ext.CompositeElementLite",
 226         "doc": "<p>Returns the number of elements in this Composite.</p>\n",
 227         "linenr": 68,
 228         "return": {
 229           "type": "void",
 230           "doc": "<p>Number</p>\n"
 231         },
 232         "html_filename": "CompositeElementLite.html"
 233       },
 234       {
 235         "deprecated": null,
 236         "alias": null,
 237         "protected": false,
 238         "tagname": "method",
 239         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-indexOf",
 240         "shortDoc": "Find the index of the passed element within the composite collection. ...",
 241         "static": false,
 242         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 243         "private": false,
 244         "params": [
 245           {
 246             "type": "Object",
 247             "optional": false,
 248             "doc": "<p>{Mixed} The id of an element, or an <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a>, or an HtmlElement to find within the composite collection.</p>\n",
 249             "name": "el"
 250           }
 251         ],
 252         "name": "indexOf",
 253         "owner": "Ext.CompositeElementLite",
 254         "doc": "<p>Find the index of the passed element within the composite collection.</p>\n",
 255         "linenr": 214,
 256         "return": {
 257           "type": "void",
 258           "doc": "<p>Number The index of the passed <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a> in the composite collection, or -1 if not found.</p>\n"
 259         },
 260         "html_filename": "CompositeElementLite.html"
 261       },
 262       {
 263         "deprecated": null,
 264         "alias": null,
 265         "protected": false,
 266         "tagname": "method",
 267         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-item",
 268         "shortDoc": "Returns a flyweight Element of the dom element object at the specified index ...",
 269         "static": false,
 270         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 271         "private": false,
 272         "params": [
 273           {
 274             "type": "Number",
 275             "optional": false,
 276             "doc": "\n",
 277             "name": "index"
 278           }
 279         ],
 280         "name": "item",
 281         "owner": "Ext.CompositeElementLite",
 282         "doc": "<p>Returns a flyweight Element of the dom element object at the specified index</p>\n",
 283         "linenr": 115,
 284         "return": {
 285           "type": "Ext.core.Element",
 286           "doc": "\n"
 287         },
 288         "html_filename": "CompositeElementLite.html"
 289       },
 290       {
 291         "deprecated": null,
 292         "alias": null,
 293         "protected": false,
 294         "tagname": "method",
 295         "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-last",
 296         "shortDoc": "Returns the last Element ...",
 297         "static": false,
 298         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
 299         "private": false,
 300         "params": [
 301
 302         ],
 303         "name": "last",
 304         "owner": "Ext.CompositeElementLite",
 305         "doc": "<p>Returns the last Element</p>\n",
 306         "linenr": 27,
 307         "return": {
 308           "type": "Ext.core.Element",
 309           "doc": "\n"
 310         },
 311         "html_filename": "CompositeElementLite-more.html"
 312       },
 313       {
 314         "deprecated": null,
 315         "alias": null,
 316         "protected": false,
 317         "tagname": "method",
 318         "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-removeElement",
 319         "shortDoc": "Removes the specified element(s). ...",
 320         "static": false,
 321         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
 322         "private": false,
 323         "params": [
 324           {
 325             "type": "Mixed",
 326             "optional": false,
 327             "doc": "<p>The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.</p>\n",
 328             "name": "el"
 329           },
 330           {
 331             "type": "Boolean",
 332             "optional": true,
 333             "doc": "<p>(optional) True to also remove the element from the document</p>\n",
 334             "name": "removeDom"
 335           }
 336         ],
 337         "name": "removeElement",
 338         "owner": "Ext.CompositeElementLite",
 339         "doc": "<p>Removes the specified element(s).</p>\n",
 340         "linenr": 44,
 341         "return": {
 342           "type": "CompositeElement",
 343           "doc": "<p>this</p>\n"
 344         },
 345         "html_filename": "CompositeElementLite-more.html"
 346       },
 347       {
 348         "deprecated": null,
 349         "alias": null,
 350         "protected": false,
 351         "tagname": "method",
 352         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-replaceElement",
 353         "shortDoc": "Replaces the specified element with the passed element. ...",
 354         "static": false,
 355         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 356         "private": false,
 357         "params": [
 358           {
 359             "type": "Mixed",
 360             "optional": false,
 361             "doc": "<p>The id of an element, the Element itself, the index of the element in this composite\nto replace.</p>\n",
 362             "name": "el"
 363           },
 364           {
 365             "type": "Mixed",
 366             "optional": false,
 367             "doc": "<p>The id of an element or the Element itself.</p>\n",
 368             "name": "replacement"
 369           },
 370           {
 371             "type": "Boolean",
 372             "optional": false,
 373             "doc": "<p>(Optional) True to remove and replace the element in the document too.</p>\n",
 374             "name": "domReplace"
 375           }
 376         ],
 377         "name": "replaceElement",
 378         "owner": "Ext.CompositeElementLite",
 379         "doc": "<p>Replaces the specified element with the passed element.</p>\n",
 380         "linenr": 223,
 381         "return": {
 382           "type": "CompositeElement",
 383           "doc": "<p>this</p>\n"
 384         },
 385         "html_filename": "CompositeElementLite.html"
 386       }
 387     ],
 388     "property": [
 389       {
 390         "type": "Array",
 391         "deprecated": null,
 392         "alias": null,
 393         "protected": false,
 394         "tagname": "property",
 395         "href": "CompositeElementLite.html#Ext-CompositeElementLite-property-elements",
 396         "shortDoc": "The Array of DOM elements which this CompositeElement encapsulates. ...",
 397         "static": false,
 398         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 399         "private": false,
 400         "name": "elements",
 401         "owner": "Ext.CompositeElementLite",
 402         "doc": "<p>The Array of DOM elements which this CompositeElement encapsulates. Read-only.</p>\n\n\n<p>This will not <i>usually</i> be accessed in developers' code, but developers wishing\nto augment the capabilities of the CompositeElementLite class may use it when adding\nmethods to the class.</p>\n\n\n<p>For example to add the <code>nextAll</code> method to the class to <b>add</b> all\nfollowing siblings of selected elements, the code would be</p>\n\n\n<p><code></p>\n\n<pre>Ext.override(Ext.CompositeElementLite, {\n    nextAll: function() {\n        var els = this.elements, i, l = els.length, n, r = [], ri = -1;\n\n//      Loop through all elements in this Composite, accumulating\n//      an Array of all siblings.\n        for (i = 0; i < l; i++) {\n            for (n = els[i].nextSibling; n; n = n.nextSibling) {\n                r[++ri] = n;\n            }\n        }\n\n//      Add all found siblings to this Composite\n        return this.add(r);\n    }\n});</pre>\n\n\n<p></code></p>\n",
 403         "linenr": 20,
 404         "html_filename": "CompositeElementLite.html"
 405       }
 406     ],
 407     "cssVar": [
 408
 409     ],
 410     "cssMixin": [
 411
 412     ],
 413     "event": [
 414
 415     ]
 416   },
 417   "singleton": false,
 418   "alias": null,
 419   "superclasses": [
 420
 421   ],
 422   "protected": false,
 423   "tagname": "class",
 424   "mixins": [
 425
 426   ],
 427   "href": "CompositeElementLite-more.html#Ext-CompositeElementLite",
 428   "subclasses": [
 429     "Ext.CompositeElement"
 430   ],
 431   "static": false,
 432   "author": null,
 433   "component": false,
 434   "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
 435   "private": false,
 436   "alternateClassNames": [
 437
 438   ],
 439   "name": "Ext.CompositeElementLite",
 440   "doc": "<p>This class encapsulates a <i>collection</i> of DOM elements, providing methods to filter\nmembers, or to perform collective actions upon the whole set.</p>\n\n\n<p>Although they are not listed, this class supports all of the methods of <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a> and\n<a href=\"#/api/Ext.fx.Anim\" rel=\"Ext.fx.Anim\" class=\"docClass\">Ext.fx.Anim</a>. The methods from these classes will be performed on all the elements in this collection.</p>\n\n\n<p>Example:</p>\n\n<pre><code>var els = Ext.select(\"#some-el div.some-class\");\n// or select directly from an existing element\nvar el = Ext.get('some-el');\nel.select('div.some-class');\n\nels.setWidth(100); // all elements become 100 width\nels.hide(true); // all elements fade out and hide\n// or\nels.setWidth(100).hide(true);\n</code></pre>\n\n",
 441   "mixedInto": [
 442
 443   ],
 444   "linenr": 1,
 445   "xtypes": [
 446
 447   ],
 448   "html_filename": "CompositeElementLite-more.html",
 449   "extends": null
 450 });