asdoc/org/apache/royale/jewel/supportClasses/table/ITableColumn.swf.json

{ "type": "interface",
  "qname": "org.apache.royale.jewel.supportClasses.table.ITableColumn",
    "description": "Jewel ITableColumn is the interface used by Jewel TableColumn in the Jewel Table.  Define which renderer to use for each cell in the table, and other optional data like the width, the label (used in header), and the name of the field in the data containing the value to display in the column (for the simplest ItemRenderer).",
  "members": [
  { "type": "accessor",
    "access": "read-write",
    "return": "org.apache.royale.core.IFactory",
    "qname": "itemRenderer",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The ItemRenderer class or factory to use to make instances of itemRenderers for display of data.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.7"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Number",
    "qname": "columnWidth",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The width of the column. DataGrid defaults to "numColumns/n %", where n is the number of columns",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.7"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "label",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The label for the column (appears in the header area).",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.7"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "dataField",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The name of the field containing the data value presented by the column. This value is used by the itemRenderer is select the property from the data.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.7"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Function",
    "qname": "labelFunction",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "A user-supplied function to run on each item to determine its label. By default, the list looks for a property named <code>label</code> on each data provider item and displays it. However, some data sets do not have a <code>label</code> property nor do they have another property that can be used for displaying. An example is a data set that has lastName and firstName fields but you want to display full names.  <p>You can supply a <code>labelFunction</code> that finds the appropriate fields and returns a displayable string. The <code>labelFunction</code> is also good for handling formatting and localization. </p>  <p>For most components, the label function takes a single argument which is the item in the data provider and returns a String.</p> <pre>\\n myLabelFunction(item:Object):String</pre>  <p>The method signature for the data grid classes is:</p> <pre>\\n myLabelFunction(item:Object, column:DataGridColumn):String</pre>  <p>where <code>item</code> contains the DataGrid item object, and <code>column</code> specifies the DataGrid column.</p>",
    "tags": [
    {  "tagName": "default",
           "values": ["null"]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.10.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "className",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The name of the style class to use for this column. DataGrid uses &quot;.jewel.list.column&quot;",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.7"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "align",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The name of the style class to use for this column.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.7"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "columnLabelAlign",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "How column label text align in the header",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.7"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "Number",
    "qname": "percentColumnWidth",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {}},
  { "type": "accessor",
    "access": "read-only",
    "return": "Number",
    "qname": "explicitColumnWidth",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {}}]
  }