asdoc/mx/controls/listClasses/BaseListData.js.json

{ "type": "class",
  "qname": "mx.controls.listClasses.BaseListData",
  "baseClassname": "org.apache.royale.events.EventDispatcher"
  ,
    "description": "The BaseListData class defines the data type of the <code>listData</code> property implemented by drop-in item renderers or drop-in item editors. All drop-in item renderers and drop-in item editors must implement the IDropInListItemRenderer interface, which defines the <code>listData</code> property.  <p>The <code>listData</code> property is of type BaseListData, where the BaseListData class has three subclasses: DataGridListData, ListData, and TreeListData. The actual data type of the value of the <code>listData</code> property depends on the control using the drop-in item renderer or item editor. For a DataGrid control, the value is of type DataGridListData, for a List control the value is of type ListData, and for a Tree control, the value is of type TreeListData.</p>  <p>When used as a drop-in item renderer or drop-in item editor, Flex sets the <code>listData</code> property to a BaseListData-derived class containing information computed about the item in the data provider containing the data for the item.</p>  <p>While the properties of this class are writable, you should consider them to be read only. They are initialized by the list class, and read by an item renderer or item editor. Changing these values can lead to unexpected results.</p>  <p>The properties are marked bindable, but these properties do not actually do any change detection or send change events. The properties are changed as a whole by setting a new value for the <code>listData</code> property. The <code>change</code> event for the modification of the <code>listData</code> property updates all bindings.</p>",
  "tags": [
  {  "tagName": "see",
         "values": ["mx.controls.listClasses.IDropInListItemRenderer"]},
      {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.controls.listClasses.BaseListData",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.      control.",
        "tags": [
        {  "tagName": "param",
               "values": ["label The textual representation of the item data.", "uid A unique identifier.", "owner A reference to the list control.", "rowIndex The index of the row in the currently visible rows of the control.", "columnIndex The index of the column in the currently visible columns of the"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "label", "type": "String"},
        { "name": "uid", "type": "String"},
        { "name": "owner", "type": "mx.core.IUIComponent"},
        { "name": "rowIndex", "type": "int"},
        { "name": "columnIndex", "type": "int"}]}
      ,
      { "type": "field",
        "qname": "columnIndex",
        "return": "int",
        "namespace": "public",
        "bindable": ["__NoChangeEvent__"],
        "details": [],
        "deprecated": {},
          "description": "The index of the column of the List-based control relative to the currently visible columns of the control, where the first column is at an index of 1.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "label",
        "return": "String",
        "namespace": "public",
        "bindable": ["__NoChangeEvent__"],
        "details": [],
        "deprecated": {},
          "description": "The textual representation of the item data, based on the list class's <code>itemToLabel()</code> method.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "owner",
        "return": "mx.core.IUIComponent",
        "namespace": "public",
        "bindable": ["__NoChangeEvent__"],
        "details": [],
        "deprecated": {},
          "description": "A reference to the list object that owns this item. This should be a ListBase-derived class. This property is typed as IUIComponent so that drop-ins like Label and TextInput don't have to have dependencies on List and all of its dependencies.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "rowIndex",
        "return": "int",
        "namespace": "public",
        "bindable": ["__NoChangeEvent__"],
        "details": [],
        "deprecated": {},
          "description": "The index of the row of the DataGrid, List, or Tree control relative to the currently visible rows of the control, where the first row is at an index of 1. For example, you click on an item in the control and <code>rowIndex</code> is set to 3. You then scroll the control to change the row's position in the visible rows of the control, and then click on the same row as before. The <code>rowIndex</code> now contains a different value corresponding to the new index of the row in the currently visible rows.",
        "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": "String",
        "qname": "uid",
        "namespace": "public",
        "bindable": ["__NoChangeEvent__"],
        "details": [],
        "deprecated": {},
          "description": "The unique identifier for this item.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }