Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs / symbols / Roo.CompositeElement.json
diff --git a/docs/symbols/Roo.CompositeElement.json b/docs/symbols/Roo.CompositeElement.json
new file mode 100644 (file)
index 0000000..6987987
--- /dev/null
@@ -0,0 +1,364 @@
+{
+  "name" : "Roo.CompositeElement",
+  "augments" : [
+  ],
+  "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>",
+  "isSingleton" : false,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "CompositeElement",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+  ],
+  "returns" : [
+  ],
+  "config" : [
+  ],
+  "methods" : [
+    {
+      "name" : "add",
+      "desc" : "Adds elements to this composite.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "els",
+          "type" : "String/Array",
+          "desc" : "A string CSS selector, an array of elements or an element",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "CompositeElement",
+          "desc" : "this"
+        }
+      ]
+    },
+    {
+      "name" : "contains",
+      "desc" : "Returns true if this composite contains the passed element",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "",
+          "desc" : "Boolean"
+        }
+      ]
+    },
+    {
+      "name" : "each",
+      "desc" : "Calls the passed function passing (el, this, index) for each element in this composite.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "fn",
+          "type" : "Function",
+          "desc" : "The function to call",
+          "isOptional" : false
+        },
+        {
+          "name" : "scope",
+          "type" : "Object",
+          "desc" : "(optional) The <i>this</i> object (defaults to the element)",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "CompositeElement",
+          "desc" : "this"
+        }
+      ]
+    },
+    {
+      "name" : "replaceElement",
+      "desc" : "Replaces the specified element with the passed element.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "el",
+          "type" : "String/HTMLElement/Element/Number",
+          "desc" : "The id of an element, the Element itself, the index of the element in this composite\nto replace.",
+          "isOptional" : false
+        },
+        {
+          "name" : "replacement",
+          "type" : "String/HTMLElement/Element",
+          "desc" : "The id of an element or the Element itself.",
+          "isOptional" : false
+        },
+        {
+          "name" : "domReplace",
+          "type" : "Boolean",
+          "desc" : "(Optional) True to remove and replace the element in the document too.",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "CompositeElement",
+          "desc" : "this"
+        }
+      ]
+    },
+    {
+      "name" : "fill",
+      "desc" : "Clears this composite and adds the elements returned by the passed selector.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "els",
+          "type" : "String/Array",
+          "desc" : "A string CSS selector, an array of elements or an element",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "CompositeElement",
+          "desc" : "this"
+        }
+      ]
+    },
+    {
+      "name" : "clear",
+      "desc" : "Removes all elements.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "filter",
+      "desc" : "Filters this composite to only elements that match the passed selector.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "selector",
+          "type" : "String",
+          "desc" : "A string CSS selector",
+          "isOptional" : false
+        },
+        {
+          "name" : "inverse",
+          "type" : "Boolean",
+          "desc" : "return inverse filter (not matches)",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "CompositeElement",
+          "desc" : "this"
+        }
+      ]
+    },
+    {
+      "name" : "item",
+      "desc" : "Returns the Element object at the specified index",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "index",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Roo.Element",
+          "desc" : ""
+        }
+      ]
+    },
+    {
+      "name" : "last",
+      "desc" : "Returns the last Element",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Roo.Element",
+          "desc" : ""
+        }
+      ]
+    },
+    {
+      "name" : "removeElement",
+      "desc" : "Removes the specified element(s).",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "el",
+          "type" : "Mixed",
+          "desc" : "The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.",
+          "isOptional" : false
+        },
+        {
+          "name" : "removeDom",
+          "type" : "Boolean",
+          "desc" : "(optional) True to also remove the element from the document",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "CompositeElement",
+          "desc" : "this"
+        }
+      ]
+    },
+    {
+      "name" : "indexOf",
+      "desc" : "Returns true if this composite contains the passed element",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "",
+          "desc" : "Boolean"
+        }
+      ]
+    },
+    {
+      "name" : "getCount",
+      "desc" : "Returns the number of elements in this composite",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "",
+          "desc" : "Number"
+        }
+      ]
+    },
+    {
+      "name" : "first",
+      "desc" : "Returns the first Element",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.CompositeElement",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Roo.Element",
+          "desc" : ""
+        }
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file