| { "type": "class", | |
| "qname": "mx.collections.HierarchicalCollectionView", | |
| "baseClassname": "org.apache.royale.events.EventDispatcher" | |
| , | |
| "description": "The HierarchicalCollectionView class provides a hierarchical view of a standard collection. The <code><mx.HierarchicalCollectionView></code> inherits all the tag attributes of its superclass, and defines the following tag attributes:</p> <pre>\\n <mx:HierarchicalCollectionView\\n <b>Properties </b>\\n showRoot="true|false"\\n source="<i>No default</i>"\\n />\\n </pre>", | |
| "tags": [ | |
| { "tagName": "mxml", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "mx.collections.HierarchicalCollectionView", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructor.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["hierarchicalData The data structure containing the hierarchical data.", "argOpenNodes The Object that defines a node to appear as open."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": [{ "name": "hierarchicalData", "type": "mx.collections.IHierarchicalData"}, | |
| { "name": "argOpenNodes", "type": "Object"}]} | |
| , | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "Boolean", | |
| "qname": "hasRoot", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Object", | |
| "qname": "openNodes", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Boolean", | |
| "qname": "showRoot", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "default", | |
| "values": ["true"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "mx.collections.IHierarchicalData", | |
| "qname": "source", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Function", | |
| "qname": "filterFunction", | |
| "namespace": "public", | |
| "bindable": ["filterFunctionChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "private", | |
| "values": []} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "int", | |
| "qname": "length", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The length of the currently parsed collection (i.e. the number of nodes that can be accessed by navigating the collection via HierarchicalCollectionViewCursor)", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "mx.collections.ISort", | |
| "qname": "sort", | |
| "namespace": "public", | |
| "bindable": ["sortChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "private", | |
| "values": []} ]}, | |
| { "type": "method", | |
| "qname": "createCursor", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Returns a new instance of a view iterator over the items in this view.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.collections.IViewCursor"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["IViewCursor instance."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "mx.collections.IViewCursor", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "contains", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Checks the collection for the data item using standard equality test. and <code>false</code> if not.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["item The Object that defines the node to look for."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["<code>true</code> if the data item is in the collection,"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": [{ "name": "item", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "refresh", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": [""]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "getNodeDepth", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "int", | |
| "params": [{ "name": "node", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "getParentItem", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Returns the parent of a node. The parent of a top-level node is <code>null</code>. <code>null</code> for a top-level node, and <code>undefined</code> if the parent cannot be determined.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["node The Object that defines the node."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["The parent node containing the node,"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "*", | |
| "params": [{ "name": "node", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "deleteParentMapping", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "return": "void", | |
| "params": [{ "name": "uid", "type": "String"}]} | |
| , | |
| { "type": "method", | |
| "qname": "addParentMapping", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "return": "void", | |
| "params": [{ "name": "uid", "type": "String"}, | |
| { "name": "parent", "type": "Object"}, | |
| { "name": "replaceExisting", "type": "Boolean"}]} | |
| , | |
| { "type": "method", | |
| "qname": "getChildren", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": [""]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "mx.collections.ICollectionView", | |
| "params": [{ "name": "node", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "openNode", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "node", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "closeNode", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "node", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "addChild", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": [{ "name": "parent", "type": "Object"}, | |
| { "name": "newChild", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "removeChild", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "inheritDoc", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": [{ "name": "parent", "type": "Object"}, | |
| { "name": "child", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "addChildAt", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Add a child node to a node at the specified index. This implementation does the following: <ul> <li>If the <code>parent</code> is null or undefined, inserts the <code>child</code> at the specified <code>index</code> in the collection specified by <code>source</code>. </li> <li>If the <code>parent</code> has a <code>children</code> field or property, the method adds the <code>child</code> to it at the <code>index</code> location. In this case, the <code>source</code> is not required. </li> <li>If the <code>parent</code> does not have a <code>children</code> field or property, the method adds the <code>children</code> to the <code>parent</code>. The method then adds the <code>child</code> to the parent at the <code>index</code> location. In this case, the <code>source</code> is not required. </li> <li>If the <code>index</code> value is greater than the collection length or number of children in the parent, adds the object as the last child. </li> </ul>", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["parent The Object that defines the parent node.", "newChild The Object that defines the child node.", "index The 0-based index of where to insert the child node."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["<code>true</code> if the child is added successfully."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": [{ "name": "parent", "type": "Object"}, | |
| { "name": "newChild", "type": "Object"}, | |
| { "name": "index", "type": "int"}]} | |
| , | |
| { "type": "method", | |
| "qname": "removeChildAt", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Removes the child node from a node at the specified index.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["parent The Object that defines the parent node.", "index The 0-based index of the child node to remove relative to the parent."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["<code>true</code> if the child is removed successfully."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Boolean", | |
| "params": [{ "name": "parent", "type": "Object"}, | |
| { "name": "index", "type": "int"}]} | |
| ] | |
| } |