asdoc/org/apache/royale/core/ILabelFunction.js.json

{ "type": "interface",
  "qname": "org.apache.royale.core.ILabelFunction",
"baseInterfaceNames": [
"org.apache.royale.core.IBead"]
,
    "description": "The ILabelFunction interface is the interface used at Item Renderer level to detect if there's a bead on the strand that wants to use an external label function to format labels.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.10.0"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "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"]}  ]}]
  }