{ "type": "class",
  "qname": "spark.events.GridSortEvent",
  "baseClassname": "org.apache.royale.events.Event"
  ,
    "description": "The GridSortEvent class represents events that are dispatched when the data provider of a Spark DataGrid control is sorted as the result of the user clicking on the header of a column in the DataGrid.",
  "tags": [
  {  "tagName": "see",
         "values": ["spark.components.DataGrid", "spark.components.gridClasses.GridColumn", "spark.components.GridColumnHeaderGroup"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 2.5"]},
      {  "tagName": "productversion",
         "values": ["Flex 4.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]},
      {  "tagName": "royalesuppresspublicvarwarning",
         "values": []}  ],
  "members": [
  { "type": "field",
        "qname": "SORT_CHANGE",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The <code>GridSortEvent.SORT_CHANGE</code> constant defines the value of the <code>type</code> property of the event object for a <code>sortChange</code> event, which indicates that a sort filter has just been applied to the grid's <code>dataProvider</code> collection.  <p>Typically, if a column header mouse click triggered the sort, then the last index of <code>columnIndices</code> is the column's index. Note that interactive sorts are not necessarily triggered by a mouse click.</p>  <p>This event is dispatched when the user interacts with the control. When you sort the data provider's collection programmatically, the component does not dispatch the <code>sortChange</code> event. </p>  <p>The properties of the event object have the following values:</p> <table class=&quot;innertable&quot;> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td>false</td></tr> <tr><td><code>cancelable</code></td><td>false</td></tr> <tr><td><code>columnIndices</code></td><td>The vector of column indices of the sorted columns.</td></tr> <tr><td><code>currentTarget</code></td><td>The Object that defines the event listener that handles the event. For example, if you use <code>myDataGrid.addEventListener()</code> to register an event listener, myDataGrid is the value of the <code>currentTarget</code>. </td></tr> <tr><td><code>newSortFields</code></td><td>The array of ISortFields for this sort.</td></tr> <tr><td><code>oldSortFields</code></td><td>The array of ISortFields for the last sort.</td></tr> <tr><td><code>target</code></td><td>The Object that dispatched the event; it is not always the Object listening for the event. Use the <code>currentTarget</code> property to always access the Object listening for the event.</td></tr> <tr><td><code>type</code></td><td>GridSortEvent.SORT_CHANGE</td></tr> </table>",
        "tags": [
        {  "tagName": "see",
               "values": ["spark.components.DataGrid#dataProvider", "spark.components.DataGrid#sortByColumns"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "eventType",
               "values": ["sortChange"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "SORT_CHANGING",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The <code>GridSortEvent.SORT_CHANGING</code> constant defines the value of the <code>type</code> property of the event object for a <code>sortChanging</code> event, which indicates that a sort filter is about to be applied to the grid's <code>dataProvider</code> collection. Call preventDefault() on this event to prevent the sort from occurring or you modify <code>columnIndices</code> and <code>newSortFields</code> if you want to change the default behavior of the sort.  <p>Typically, if a column header mouse click triggered the sort, then the last index of <code>columnIndices</code> is the column's index. Note that interactive sorts are not necessarily triggered by a mouse click.</p>  <p>This event is dispatched when the user interacts with the control. When you sort the data provider's collection programmatically, the component does not dispatch the <code>sortChanging</code> event. </p>  <p>The properties of the event object have the following values:</p> <table class=&quot;innertable&quot;> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td>false</td></tr> <tr><td><code>cancelable</code></td><td>false</td></tr> <tr><td><code>columnIndices</code></td><td>The vector of column indices of the columns to be sorted.</td></tr> <tr><td><code>currentTarget</code></td><td>The Object that defines the event listener that handles the event. For example, if you use <code>myDataGrid.addEventListener()</code> to register an event listener, myDataGrid is the value of the <code>currentTarget</code>. </td></tr> <tr><td><code>newSortFields</code></td><td>The array of ISortFields for this sort.</td></tr> <tr><td><code>oldSortFields</code></td><td>The array of ISortFields for the last sort.</td></tr> <tr><td><code>target</code></td><td>The Object that dispatched the event; it is not always the Object listening for the event. Use the <code>currentTarget</code> property to always access the Object listening for the event.</td></tr> <tr><td><code>type</code></td><td>GridSortEvent.SORT_CHANGING</td></tr> </table>",
        "tags": [
        {  "tagName": "see",
               "values": ["spark.components.DataGrid#dataProvider", "spark.components.DataGrid#sortByColumns"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "eventType",
               "values": ["sortChanging"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "spark.events.GridSortEvent",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.   up the display list hierarchy.  associated with the event can be prevented.",
        "tags": [
        {  "tagName": "param",
               "values": ["type The event type; indicates the action that caused the event.", "bubbles Specifies whether the event can bubble", "cancelable Specifies whether the behavior", "columnIndices The vector of column indices of the sorted columns.", "oldSortFields The array of ISortFields for the last sort.", "newSortFields The array of ISortFields for this sort."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "type", "type": "String"},
        { "name": "bubbles", "type": "Boolean"},
        { "name": "cancelable", "type": "Boolean"},
        { "name": "columnIndices", "type": "Vector.<int>"},
        { "name": "oldSortFields", "type": "Array"},
        { "name": "newSortFields", "type": "Array"}]}
      ,
      { "type": "field",
        "qname": "columnIndices",
        "return": "Vector.<int>",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The vector of column indices of the sorted columns. If <code>type</code> is <code>GridSortEvent.SORT_CHANGING</code> this value can be modified and it will be used to update the grid's <code>columnHeaderGroup</code> <code>visibleSortIndicatorIndices</code>.",
        "tags": [
        {  "tagName": "see",
               "values": ["spark.components.DataGrid#columnHeaderGroup", "spark.components.GridColumnHeaderGroup#visibleSortIndicatorIndices", "spark.components.gridClasses.GridColumn#columnIndex"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "newSortFields",
        "return": "Array",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The array of ISortFields for this sort. If <code>type</code> is <code>GridSortEvent.SORT_CHANGING</code> this value can be modified and it will be used to sort the <code>dataProvider</code> of the grid.",
        "tags": [
        {  "tagName": "see",
               "values": ["spark.components.DataGrid#dataProvider", "spark.components.gridClasses.GridColumn#sortCompareFunction", "spark.components.gridClasses.GridColumn#sortDescending", "spark.components.gridClasses.GridColumn#sortField"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "Array",
        "qname": "oldSortFields",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The array of ISortFields for the last sort.  This can be <code>null</code>. The elements in this Array should not be modified.",
        "tags": [
        {  "tagName": "see",
               "values": ["spark.components.DataGrid#dataProvider", "spark.components.gridClasses.GridColumn#sortCompareFunction", "spark.components.gridClasses.GridColumn#sortDescending", "spark.components.gridClasses.GridColumn#sortField"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }