asdoc/mx/collections/IHierarchicalData.swf.json

{ "type": "interface",
  "qname": "mx.collections.IHierarchicalData",
"baseInterfaceNames": [
"org.apache.royale.events.IEventDispatcher"]
,
    "description": "The IHierarchicalData interface defines the interface used to represent hierarchical data as the data provider for a Flex component. Hierarchical data is data in a structure of parent and child data items.",
  "tags": [
  {  "tagName": "see",
         "values": ["mx.collections.ICollectionView"]},
      {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
    "qname": "canHaveChildren",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns <code>true</code> if the node can contain children.  <p>Nodes do not have to contain children for the method to return <code>true</code>. This method is useful in determining whether other nodes can be appended as children to the specified node.</p>",
    "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": ["<code>true</code> if the node can contain children."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Boolean",
      "params": [{ "name": "node", "type": "Object"}]}
  ,
  { "type": "method",
    "qname": "hasChildren",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns <code>true</code> if the node has children.",
    "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": ["<code>true</code> if the node has children."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Boolean",
      "params": [{ "name": "node", "type": "Object"}]}
  ,
  { "type": "method",
    "qname": "getChildren",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns an Object representing the node's children.  If <code>null</code>, return a collection of top-level nodes.",
    "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": ["An Object containing the children nodes."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Object",
      "params": [{ "name": "node", "type": "Object"}]}
  ,
  { "type": "method",
    "qname": "getData",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns data from a node.",
    "tags": [
    {  "tagName": "param",
           "values": ["node The node Object from which to get the data."]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "return",
           "values": ["The requested data."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Object",
      "params": [{ "name": "node", "type": "Object"}]}
  ,
  { "type": "method",
    "qname": "getRoot",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns the root data item.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "return",
           "values": ["The Object containing the root data item."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Object",
      "params": []}
  ]
  }