X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.CompositeElement.js diff --git a/docs/output/Ext.CompositeElement.js b/docs/output/Ext.CompositeElement.js index 02e7b984..a02fe7cb 100644 --- a/docs/output/Ext.CompositeElement.js +++ b/docs/output/Ext.CompositeElement.js @@ -1,465 +1 @@ -Ext.data.JsonP.Ext_CompositeElement({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-add", - "shortDoc": "Adds elements to this Composite object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

Either an Array of DOM elements to add, or another Composite object who's elements should be added.

\n", - "name": "els" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "root" - } - ], - "name": "add", - "owner": "Ext.CompositeElementLite", - "doc": "

Adds elements to this Composite object.

\n", - "linenr": 75, - "return": { - "type": "CompositeElement", - "doc": "

This Composite object.

\n" - }, - "html_filename": "CompositeElementLite.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-clear", - "shortDoc": "Removes all elements. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - - ], - "name": "clear", - "owner": "Ext.CompositeElementLite", - "doc": "

Removes all elements.

\n", - "linenr": 246, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "CompositeElementLite.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-contains", - "shortDoc": "Returns true if this composite contains the passed element ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

{Mixed} The id of an element, or an Ext.core.Element, or an HtmlElement to find within the composite collection.

\n", - "name": "el" - } - ], - "name": "contains", - "owner": "Ext.CompositeElementLite", - "doc": "

Returns true if this composite contains the passed element

\n", - "linenr": 35, - "return": { - "type": "void", - "doc": "

Boolean

\n" - }, - "html_filename": "CompositeElementLite-more.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-each", - "shortDoc": "Calls the passed function for each element in this composite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The function to call. The function is passed the following parameters:

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope (this reference) in which the function is executed. (defaults to the Element)

\n", - "name": "scope" - } - ], - "name": "each", - "owner": "Ext.CompositeElementLite", - "doc": "

Calls the passed function for each element in this composite.

\n\n", - "linenr": 145, - "return": { - "type": "CompositeElement", - "doc": "

this

\n" - }, - "html_filename": "CompositeElementLite.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-fill", - "shortDoc": "Clears this Composite and adds the elements passed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

Either an array of DOM elements, or another Composite from which to fill this Composite.

\n", - "name": "els" - } - ], - "name": "fill", - "owner": "Ext.CompositeElementLite", - "doc": "

Clears this Composite and adds the elements passed.

\n", - "linenr": 175, - "return": { - "type": "CompositeElement", - "doc": "

this

\n" - }, - "html_filename": "CompositeElementLite.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-filter", - "shortDoc": "Filters this composite to only elements that match the passed selector. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - { - "type": "String/Function", - "optional": false, - "doc": "

A string CSS selector or a comparison function.\nThe comparison function will be called with the following arguments:

\n", - "name": "selector" - } - ], - "name": "filter", - "owner": "Ext.CompositeElementLite", - "doc": "

Filters this composite to only elements that match the passed selector.

\n", - "linenr": 187, - "return": { - "type": "CompositeElement", - "doc": "

this

\n" - }, - "html_filename": "CompositeElementLite.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-first", - "shortDoc": "Returns the first Element ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js", - "private": false, - "params": [ - - ], - "name": "first", - "owner": "Ext.CompositeElementLite", - "doc": "

Returns the first Element

\n", - "linenr": 19, - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "html_filename": "CompositeElementLite-more.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-getCount", - "shortDoc": "Returns the number of elements in this Composite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - - ], - "name": "getCount", - "owner": "Ext.CompositeElementLite", - "doc": "

Returns the number of elements in this Composite.

\n", - "linenr": 68, - "return": { - "type": "void", - "doc": "

Number

\n" - }, - "html_filename": "CompositeElementLite.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-indexOf", - "shortDoc": "Find the index of the passed element within the composite collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

{Mixed} The id of an element, or an Ext.core.Element, or an HtmlElement to find within the composite collection.

\n", - "name": "el" - } - ], - "name": "indexOf", - "owner": "Ext.CompositeElementLite", - "doc": "

Find the index of the passed element within the composite collection.

\n", - "linenr": 214, - "return": { - "type": "void", - "doc": "

Number The index of the passed Ext.core.Element in the composite collection, or -1 if not found.

\n" - }, - "html_filename": "CompositeElementLite.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-item", - "shortDoc": "Returns a flyweight Element of the dom element object at the specified index ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "\n", - "name": "index" - } - ], - "name": "item", - "owner": "Ext.CompositeElementLite", - "doc": "

Returns a flyweight Element of the dom element object at the specified index

\n", - "linenr": 115, - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "html_filename": "CompositeElementLite.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-last", - "shortDoc": "Returns the last Element ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js", - "private": false, - "params": [ - - ], - "name": "last", - "owner": "Ext.CompositeElementLite", - "doc": "

Returns the last Element

\n", - "linenr": 27, - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "html_filename": "CompositeElementLite-more.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-removeElement", - "shortDoc": "Removes the specified element(s). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.

\n", - "name": "el" - }, - { - "type": "Boolean", - "optional": true, - "doc": "

(optional) True to also remove the element from the document

\n", - "name": "removeDom" - } - ], - "name": "removeElement", - "owner": "Ext.CompositeElementLite", - "doc": "

Removes the specified element(s).

\n", - "linenr": 44, - "return": { - "type": "CompositeElement", - "doc": "

this

\n" - }, - "html_filename": "CompositeElementLite-more.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-replaceElement", - "shortDoc": "Replaces the specified element with the passed element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "

The id of an element, the Element itself, the index of the element in this composite\nto replace.

\n", - "name": "el" - }, - { - "type": "Mixed", - "optional": false, - "doc": "

The id of an element or the Element itself.

\n", - "name": "replacement" - }, - { - "type": "Boolean", - "optional": false, - "doc": "

(Optional) True to remove and replace the element in the document too.

\n", - "name": "domReplace" - } - ], - "name": "replaceElement", - "owner": "Ext.CompositeElementLite", - "doc": "

Replaces the specified element with the passed element.

\n", - "linenr": 223, - "return": { - "type": "CompositeElement", - "doc": "

this

\n" - }, - "html_filename": "CompositeElementLite.html" - } - ], - "property": [ - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "CompositeElement2.html#Ext-CompositeElement-property-", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElement.js", - "private": false, - "name": "", - "owner": "Ext.CompositeElement", - "doc": "

Iterates each element in this composite calling the supplied function using Ext.each.

\n", - "linenr": 52, - "html_filename": "CompositeElement2.html" - }, - { - "type": "Array", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "CompositeElementLite.html#Ext-CompositeElementLite-property-elements", - "shortDoc": "The Array of DOM elements which this CompositeElement encapsulates. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js", - "private": false, - "name": "elements", - "owner": "Ext.CompositeElementLite", - "doc": "

The Array of DOM elements which this CompositeElement encapsulates. Read-only.

\n\n\n

This will not usually 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.

\n\n\n

For example to add the nextAll method to the class to add all\nfollowing siblings of selected elements, the code would be

\n\n\n

\n\n
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});
\n\n\n

\n", - "linenr": 20, - "html_filename": "CompositeElementLite.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - "Ext.CompositeElementLite" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "CompositeElement2.html#Ext-CompositeElement", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElement.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.CompositeElement", - "doc": "

This class encapsulates a collection of DOM elements, providing methods to filter\nmembers, or to perform collective actions upon the whole set.

\n\n\n

Although they are not listed, this class supports all of the methods of Ext.core.Element and\nExt.fx.Anim. The methods from these classes will be performed on all the elements in this collection.

\n\n\n

All methods return this and can be chained.

\n\n\n

Usage:

\n\n
var els = Ext.select(\"#some-el div.some-class\", true);\n// or select directly from an existing element\nvar el = Ext.get('some-el');\nel.select('div.some-class', true);\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
\n\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "CompositeElement2.html", - "extends": "Ext.CompositeElementLite" -}); \ No newline at end of file +Ext.data.JsonP.Ext_CompositeElement({"tagname":"class","html":"

Hierarchy

Ext.CompositeElementLite
Ext.CompositeElement

Files

This class encapsulates a collection of DOM elements, providing methods to filter\nmembers, or to perform collective actions upon the whole set.

\n\n\n

Although they are not listed, this class supports all of the methods of Ext.Element and\nExt.fx.Anim. The methods from these classes will be performed on all the elements in this collection.

\n\n\n

All methods return this and can be chained.

\n\n\n

Usage:

\n\n
var els = Ext.select(\"#some-el div.some-class\", true);\n// or select directly from an existing element\nvar el = Ext.get('some-el');\nel.select('div.some-class', true);\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
\n\n
Defined By

Properties

The Array of DOM elements which this CompositeElement encapsulates. ...

The Array of DOM elements which this CompositeElement encapsulates. Read-only.

\n\n\n

This will not usually 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.

\n\n\n

For example to add the nextAll method to the class to add all\nfollowing siblings of selected elements, the code would be

\n\n\n

\n\n
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});
\n\n\n

\n
Defined By

Methods

Adds elements to this Composite object. ...

Adds elements to this Composite object.

\n

Parameters

  • els : HTMLElement[]/Ext.CompositeElement

    Either an Array of DOM elements to add, or another Composite object who's elements should be added.

    \n

Returns

Removes all elements. ...

Removes all elements.

\n
Returns true if this composite contains the passed element ...

Returns true if this composite contains the passed element

\n

Parameters

  • el : Object

    {String/HTMLElement/Ext.Element/Number} The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection.

    \n
Calls the passed function for each element in this composite. ...

Calls the passed function for each element in this composite.

\n\n

Parameters

  • fn : Function

    The function to call. The function is passed the following parameters:

      \n
    • el : Element
      The current Element in the iteration.\nThis is the flyweight (shared) Ext.Element instance, so if you require a\na reference to the dom node, use el.dom.
    • \n
    • c : Composite
      This Composite object.
    • \n
    • idx : Number
      The zero-based index in the iteration.
    • \n

    \n
  • scope : Object (optional)

    The scope (this reference) in which the function is executed. (defaults to the Element)

    \n

Returns

Clears this Composite and adds the elements passed. ...

Clears this Composite and adds the elements passed.

\n

Parameters

  • els : HTMLElement[]/Ext.CompositeElement

    Either an array of DOM elements, or another Composite from which to fill this Composite.

    \n

Returns

Filters this composite to only elements that match the passed selector. ...

Filters this composite to only elements that match the passed selector.

\n

Parameters

  • selector : String/Function

    A string CSS selector or a comparison function.\nThe comparison function will be called with the following arguments:

      \n
    • el : Ext.Element
      The current DOM element.
    • \n
    • index : Number
      The current index within the collection.
    • \n

    \n

Returns

Returns the first Element ...

Returns the first Element

\n

Returns

Returns the number of elements in this Composite. ...

Returns the number of elements in this Composite.

\n
Find the index of the passed element within the composite collection. ...

Find the index of the passed element within the composite collection.

\n

Parameters

  • el : Object

    {Mixed} The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection.

    \n
Returns a flyweight Element of the dom element object at the specified index ...

Returns a flyweight Element of the dom element object at the specified index

\n

Parameters

Returns

Returns the last Element ...

Returns the last Element

\n

Returns

Removes the specified element(s). ...

Removes the specified element(s).

\n

Parameters

  • el : String/HTMLElement/Ext.Element/Number

    The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.

    \n
  • removeDom : Boolean (optional)

    True to also remove the element from the document

    \n

Returns

Replaces the specified element with the passed element. ...

Replaces the specified element with the passed element.

\n

Parameters

  • el : String/HTMLElement/Ext.Element/Number

    The id of an element, the Element itself, the index of the element in this composite\nto replace.

    \n
  • replacement : String/Ext.Element

    The id of an element or the Element itself.

    \n
  • domReplace : Boolean (optional)

    True to remove and replace the element in the document too.

    \n

Returns

","allMixins":[],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.CompositeElementLite","inheritable":false,"static":false,"superclasses":["Ext.CompositeElementLite","Ext.CompositeElement"],"singleton":false,"code_type":"assignment","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":null,"required":null,"protected":false,"name":"elements","id":"property-elements"}],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"add","id":"method-add"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"clear","id":"method-clear"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"contains","id":"method-contains"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"each","id":"method-each"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"fill","id":"method-fill"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"filter","id":"method-filter"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"first","id":"method-first"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"getCount","id":"method-getCount"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"indexOf","id":"method-indexOf"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"item","id":"method-item"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"last","id":"method-last"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"removeElement","id":"method-removeElement"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.CompositeElementLite","template":false,"required":null,"protected":false,"name":"replaceElement","id":"method-replaceElement"}],"event":[]},"private":false,"component":false,"name":"Ext.CompositeElement","alternateClassNames":[],"id":"class-Ext.CompositeElement","mixedInto":[],"xtypes":{},"files":[{"href":"CompositeElement2.html#Ext-CompositeElement","filename":"CompositeElement.js"}]}); \ No newline at end of file