asdoc/mx/controls/advancedDataGridClasses/AdvancedDataGridHeaderInfo.js.json

{ "type": "class",
  "qname": "mx.controls.advancedDataGridClasses.AdvancedDataGridHeaderInfo",
  "baseClassname": ""
  ,
    "description": "The AdvancedDataGridHeaderInfo class contains information that describes the hierarchy of the columns of the AdvancedDataGrid control.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.controls.advancedDataGridClasses.AdvancedDataGridHeaderInfo",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.  that this AdvancedDataGridHeaderInfo instance corresponds to.  of this AdvancedDataGridHeaderInfo instance.  in the AdvancedDataGrid control.  in the columns hierarchy of the AdvancedDataGrid control.  of this AdvancedDataGridHeaderInfo instance.  requires extracting data from nested objects.  render the column header.",
        "tags": [
        {  "tagName": "param",
               "values": ["column A reference to the AdvancedDataGridColumn instance", "parent The parent AdvancedDataGridHeaderInfo instance", "index The index of this AdvancedDataGridHeaderInfo instance", "depth The depth of this AdvancedDataGridHeaderInfo instance", "children An Array of all of the child AdvancedDataGridHeaderInfo instances", "internalLabelFunction A function that gets created if the column grouping", "headerItem A reference to IListItemRenderer instance used to"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "column", "type": "mx.controls.advancedDataGridClasses.AdvancedDataGridColumn"},
        { "name": "parent", "type": "mx.controls.advancedDataGridClasses.AdvancedDataGridHeaderInfo"},
        { "name": "index", "type": "int"},
        { "name": "depth", "type": "int"},
        { "name": "children", "type": "Array"},
        { "name": "internalLabelFunction", "type": "Function"},
        { "name": "headerItem", "type": "org.apache.royale.core.IUIBase"}]}
      ,
      { "type": "field",
        "qname": "column",
        "return": "mx.controls.advancedDataGridClasses.AdvancedDataGridColumn",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A reference to the AdvancedDataGridColumn instance corresponding to this AdvancedDataGridHeaderInfo instance.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "parent",
        "return": "mx.controls.advancedDataGridClasses.AdvancedDataGridHeaderInfo",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The parent AdvancedDataGridHeaderInfo instance of this AdvancedDataGridHeaderInfo instance if this column is part of a column group.",
        "tags": [
        {  "tagName": "default",
               "values": ["null"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "index",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The index of this AdvancedDataGridHeaderInfo instance in the AdvancedDataGrid control.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "depth",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The depth of this AdvancedDataGridHeaderInfo instance in the columns hierarchy of the AdvancedDataGrid control, if this column is part of a column group.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "children",
        "return": "Array",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "An Array of all of the child AdvancedDataGridHeaderInfo instances of this AdvancedDataGridHeaderInfo instance, if this column is part of a column group.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "headerItem",
        "return": "org.apache.royale.core.IUIBase",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A reference to IListItemRenderer instance used to render the column header.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "internalLabelFunction",
        "return": "Function",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A function that gets created if the column grouping requires extracting data from nested objects.  <p>For example, if each data row appears as: </p> <pre>row = {.., .., Q1: { y2005: 241, y2006:353}};</pre>  <p>and you define a column group as:</p> <pre>     &lt;mx:AdvancedDataGridColumnGroup dataField=&quot;Q1&quot;&gt;\\n &lt;mx:AdvancedDataGridColumn dataField=&quot;y2005&quot;&gt;\\n &lt;mx:AdvancedDataGridColumn dataField=&quot;y2006&quot;&gt;\\n &lt;/mx:AdvancedDataGridColumnGroup&gt;</pre>  <p>The function for the column corresponding to y2005 is defined as:</p> <pre>     function foo():String\\n {\\n return row[&quot;Q1&quot;][&quot;2005&quot;];\\n }</pre>  <p>The function also handles the case when any of the column or column groups uses a label function instead of a data field.</p>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "columnSpan",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Number of actual columns spanned by the column header when using column groups.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "actualColNum",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The actual column index at which the header starts, relative to the currently displayed columns.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "visible",
        "return": "Boolean",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Contains <code>true</code> if the column is currently visible.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "visibleChildren",
        "return": "Array",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "An Array of the currently visible child AdvancedDataGridHeaderInfo instances. if this column is part of a column group.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "visibleIndex",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The index of this column in the list of visible children of its parent AdvancedDataGridHeaderInfo instance, if this column is part of a column group.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }