////////////////////////////////////////////////////////////////////////////////
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////
package mx.controls.advancedDataGridClasses
{
/**
* The SortInfo class defines information about the sorting of a column
* of the AdvancedDataGrid control.
* Each column in the AdvancedDataGrid control has an associated
* SortInfo instance.
* The AdvancedDataGridSortItemRenderer class uses the
* information in the SortInfo instance to create the item renderer
* for the sort icon and text field in the column header of each column in
* the AdvancedDataGrid control.
*
* @see mx.controls.AdvancedDataGrid
* @see mx.controls.advancedDataGridClasses.AdvancedDataGridSortItemRenderer
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public class SortInfo
{
include "../../core/Version.as";
//--------------------------------------------------------------------------
//
// Class constants
//
//--------------------------------------------------------------------------
/**
* Specifies that the sort is only a visual
* indication of the proposed sort.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const PROPOSEDSORT:String = "proposedSort";
/**
* Specifies that the sort is the actual current sort.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const ACTUALSORT:String = "actualSort";
//--------------------------------------------------------------------------
//
// Constructor
//
//--------------------------------------------------------------------------
/**
* Constructor.
*
* @param sequenceNumber The number of this column in the sort order sequence.
*
* @param descending true
when the column is sorted in descending order.
*
* @param status PROPOSEDSORT
if the sort is only a visual
* indication of the proposed sort, or ACTUALSORT
* if the sort is the actual current sort.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function SortInfo(sequenceNumber:int = -1, descending:Boolean = false,
status:String = ACTUALSORT)
{
this.sequenceNumber = sequenceNumber;
this.descending = descending;
this.status = status;
}
//--------------------------------------------------------------------------
//
// Properties
//
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// sequenceNumber
//--------------------------------------------------------------------------
/**
* The number of this column in the sort order sequence.
* This number is used when sorting by multiple columns.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var sequenceNumber:int;
//--------------------------------------------------------------------------
// descending
//--------------------------------------------------------------------------
/**
* Contains true
when the column is sorted in descending order,
* and false
when the column is sorted in ascending order.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var descending:Boolean;
//--------------------------------------------------------------------------
// status
//--------------------------------------------------------------------------
/**
* Contains PROPOSEDSORT
if the sort is only a visual
* indication of the proposed sort, or contains ACTUALSORT
* if the sort is the actual current sort.
*
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var status:String;
} // end class SortInfo
} // end package mx.controls.advancedDataGridClasses