The <mx:PrintAdvancedDataGrid> tag inherits the tag attributes
* of its superclass; however, you do not use the properties, styles, events,
* and effects (or methods) associated with user interaction.
* The <mx:PrintAdvancedDataGrid> tag adds the following tag attribute:
*
* <mx:PrintAdvancedDataGrid * Properties * allowInteraction="true|false" * displayIcons="true|false" * sizeToPage="true|false" * source="null" * > * ... * </mx:PrintAdvancedDataGrid> ** * @see mx.printing.FlexPrintJob * @see mx.printing.PrintDataGrid * @see mx.controls.AdvancedDataGrid * * @includeExample examples/AdvancedPrintDataGridExample.mxml * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ public class PrintAdvancedDataGrid extends AdvancedDataGrid { include "../core/Version.as"; //-------------------------------------------------------------------------- // // Constructor // //-------------------------------------------------------------------------- /** * Constructor. * *
Constructs a PrintAdvancedDataGrid control with no scroll bars, user interactivity, * column sorting, resizing, drag scrolling, selection, or keyboard * interaction. * The default height is 100% of the container height, or the height * required to display all the data provider rows, whichever is smaller.
* * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ public function PrintAdvancedDataGrid() { super(); horizontalScrollPolicy = ScrollPolicy.OFF; verticalScrollPolicy = ScrollPolicy.OFF; sortableColumns = false; selectable = false; // to disable dragScrolling dragEnabled = true; resizableColumns = false; mouseChildren = false; super.percentHeight = 100; } //-------------------------------------------------------------------------- // // Variables // //-------------------------------------------------------------------------- /** * @private * Previous Page row count. */ private var previousPageRowCount:int = 0; /** * @private * Variable for storing the folderClosedIcon. */ private var folderClosedIconClass:Class; /** * @private * Variable for storing the folderOpenIcon. */ private var folderOpenIconClass:Class; /** * @private * Variable for storing the defaultLeafIcon. */ private var defaultLeafIconClass:Class; /** * @private * Storage variable for changes to displayIcons. */ private var displayIconsChanged:Boolean; //-------------------------------------------------------------------------- // // Overridden properties // //-------------------------------------------------------------------------- //---------------------------------- // height //---------------------------------- [Bindable("heightChanged")] [Inspectable(category="General")] [PercentProxy("percentHeight")] /** * @private * Getter needs to be overridden if setter is overridden. */ override public function get height():Number { return super.height; } /** * @private * Height setter needs to be overridden to update _originalHeight. */ override public function set height(value:Number):void { _originalHeight = value; if (!isNaN(percentHeight)) { super.percentHeight = NaN; measure(); value = measuredHeight; } super.height = value; invalidateDisplayList(); if (sizeToPage && !isNaN(explicitHeight)) explicitHeight = NaN; } //---------------------------------- // percentHeight //---------------------------------- [Bindable("resize")] [Inspectable(category="Size", defaultValue="NaN")] /** * @private * Getter needs to be overridden if setter is overridden. */ override public function get percentHeight():Number { return super.percentHeight; } /** * @private * percentHeight setter needs to be overridden to update _originalHeight. */ override public function set percentHeight(value:Number):void { _originalHeight = NaN; super.percentHeight = value; } //-------------------------------------------------------------------------- // // Properties // //-------------------------------------------------------------------------- //---------------------------------- // currentPageHeight //---------------------------------- /** * @private * Storage for the currentPageHeight property. */ private var _currentPageHeight:Number; /** * The height that the PrintAdvancedDataGrid would be if thesizeToPage
* property is true, meaning that the PrintAdvancedDataGrid displays only completely
* viewable rows and displays no partial rows.
* If the sizeToPage property
* is false, the value of this property equals
* the height property.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function get currentPageHeight():Number
{
return _currentPageHeight;
}
//----------------------------------
// displayIcons
//----------------------------------
/**
* @private
* Indicates that the folder/leaf icons will be displayed or not.
*/
private var _displayIcons:Boolean = true;
/**
* If true, display the folder and leaf icons in the navigation tree.
*
* @default true
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function get displayIcons():Boolean
{
return _displayIcons;
}
public function set displayIcons(value:Boolean):void
{
if (value != _displayIcons)
{
_displayIcons = value;
displayIconsChanged = true;
itemsSizeChanged = true;
invalidateProperties();
invalidateSize();
invalidateDisplayList();
}
}
//----------------------------------
// allowInteraction
//----------------------------------
/**
* Storage for the allowInteraction property.
* @private
*/
private var _allowInteraction:Boolean;
/**
* If true, allows some interactions with the control,
* such as column resizing, column reordering, and expanding or collapsing nodes.
*
* @default false
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function get allowInteraction():Boolean
{
return _allowInteraction;
}
public function set allowInteraction(value:Boolean):void
{
_allowInteraction = value;
if(value)
{
mouseChildren = true;
resizableColumns = true;
}
else
{
mouseChildren = false;
resizableColumns = false;
}
}
//----------------------------------
// originalHeight
//----------------------------------
/**
* Storage for the originalHeight property.
* @private
*/
private var _originalHeight:Number;
/**
* The height of the PrintAdvancedDataGrid as set by the user.
* If the sizeToPage property is false,
* the value of this property equals the height property.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function get originalHeight():Number
{
return _originalHeight;
}
//----------------------------------
// sizeToPage
//----------------------------------
/**
* If true, the PrintAdvancedDataGrid readjusts its height to display
* only completely viewable rows.
*
* @default true
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var sizeToPage:Boolean = true;
//----------------------------------
// source
//----------------------------------
/**
* @private
* Source ADG.
*/
private var _source:AdvancedDataGrid;
/**
* Initializes the PrintAdvancedDataGrid control and all of its properties
* from the specified AdvancedDataGrid control.
*
* Note: The width and height of the PrintAdvancedDataGrid control
* are not taken from the source AdvancedDataGrid control.
* Changes to the source AdvancedDataGrid control are not automatically reflected
* in the PrintAdvancedDataGrid instance.
* Therefore, you must reset the source property after changing
* the source AdvancedDataGrid control.
true if a set of rows is
* available else false.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function get validNextPage():Boolean
{
var vPos:int = verticalScrollPosition + rowCount ;
return dataProvider && vPos < dataProvider.length ? true : false;
}
//----------------------------------
// validPreviousPage
//----------------------------------
/**
* Indicates that the data provider contains data rows that precede
* the rows that the PrintAdvancedDataGrid control currently displays.
*
* @return A Boolean value of true if a set of rows is
* available else false.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function get validPreviousPage():Boolean
{
var vPos:int = verticalScrollPosition - previousPageRowCount ;
return dataProvider && vPos >= 0 ? true : false;
}
//--------------------------------------------------------------------------
//
// Overridden methods: UIComponent
//
//--------------------------------------------------------------------------
/**
* @private
* Checks the changes in displayIcons and update the display.
*/
override protected function commitProperties():void
{
super.commitProperties();
// set treeColumn in case of a column grouped AdvacnedDataGrid
if (source && source.groupedColumns && source.treeColumn)
{
var n:int = source.columns.length;
for (var i:int = 0; i < n; i++)
{
var sourceColumn:AdvancedDataGridColumn = source.columns[i];
if (sourceColumn == source.treeColumn)
{
this.treeColumn = this.columns[i];
break;
}
}
}
if(displayIconsChanged)
{
displayIconsChanged = false;
if(displayIcons)
{
setStyle("defaultLeafIcon",defaultLeafIconClass);
setStyle("folderClosedIcon",folderClosedIconClass);
setStyle("folderOpenIcon",folderOpenIconClass);
}
else
{
// get the styles and store them
folderClosedIconClass = getStyle("folderClosedIcon");
folderOpenIconClass = getStyle("folderOpenIcon");
defaultLeafIconClass = getStyle("defaultLeafIcon");
// set the folder/leaf icons to null
setStyle("defaultLeafIcon",null);
setStyle("folderClosedIcon",null);
setStyle("folderOpenIcon",null);
}
}
}
/**
* @private
* Sets the default number of display rows to dataProvider.length.
*/
override protected function measure():void
{
var oldRowCount:uint = rowCount;
var count:uint;
count = (dataProvider) ? dataProvider.length : 0;
// Headers should show even if there is no dataProvider
if (count == 0 && headerVisible)
count++;
if (count >= verticalScrollPosition)
count -= verticalScrollPosition;
else
count = 0;
setRowCount(count);
// need to calculate rowCount before super()
super.measure();
measureHeight();
if (isNaN(_originalHeight))
_originalHeight = measuredHeight;
_currentPageHeight = measuredHeight;
if (!sizeToPage)
{
setRowCount(oldRowCount);
super.measure();
}
}
/**
* @private
* setActualSize() is overridden to update _originalHeight.
*/
override public function setActualSize(w:Number, h:Number):void
{
if (!isNaN(percentHeight))
{
_originalHeight = h;
super.percentHeight = NaN;
measure();
h = measuredHeight;
}
super.setActualSize(w, h);
invalidateDisplayList();
if (sizeToPage && !isNaN(explicitHeight))
explicitHeight = NaN;
}
//--------------------------------------------------------------------------
//
// Overridden methods: ListBase
//
//--------------------------------------------------------------------------
/**
* @private
* Overridden configureScrollBars to disable autoScrollUp.
*/
override protected function configureScrollBars():void
{
}
//--------------------------------------------------------------------------
//
// Methods
//
//--------------------------------------------------------------------------
/**
* Puts the next set of data rows in view;
* that is, it sets the PrintAdvancedDataGrid verticalScrollPosition
* property to equal verticalScrollPosition + (number of scrollable rows).
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function nextPage():void
{
previousPageRowCount = rowCount - lockedRowCount;
if (verticalScrollPosition < dataProvider.length)
{
verticalScrollPosition += rowCount - lockedRowCount;
// TODO: can this be avoided?
itemsSizeChanged = true;
invalidateSize();
invalidateDisplayList();
}
}
/**
* Puts the previous set of data rows in view;
* that is, it sets the PrintAdvancedDataGrid verticalScrollPosition
* property to equal verticalScrollPosition - (number of rows in the previous page).
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function previousPage():void
{
if (verticalScrollPosition > 0)
{
verticalScrollPosition = Math.max(0, (verticalScrollPosition - previousPageRowCount));
invalidateSize();
invalidateDisplayList();
}
}
/**
* @private
* ListBase.measure() does'nt calculate measuredHeight in required way
* so have to add the code here.
*/
private function measureHeight():void
{
if( dataProvider && dataProvider.length > 0
&& (verticalScrollPosition >= dataProvider.length))
{
setRowCount(0);
measuredHeight = 0;
measuredMinHeight = 0;
return;
}
var o:EdgeMetrics = viewMetrics;
var rc:int = (explicitRowCount < 1) ? rowCount : explicitRowCount;
var maxHeight:Number = isNaN(_originalHeight) ? -1
: _originalHeight - o.top - o.bottom;
measuredHeight = measureHeightOfItemsUptoMaxHeight(
-1, rc, maxHeight) + o.top + o.bottom;
measuredMinHeight = measureHeightOfItemsUptoMaxHeight(
-1, Math.min(rc, 2), maxHeight) + o.top + o.bottom;
}
/**
* Moves to the first page of the PrintAdvancedDataGrid control,
* which corresponds to the first set of visible rows.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function moveToFirstPage():void
{
// move the iterator to the first position
// this is done because when nextPage() is called without
// checking for validNextPage(), listItems becomes empty after the last page
// and the iterator is not seeked to the desired position.
iterator.seek(CursorBookmark.FIRST);
verticalScrollPosition = 0;
invalidateSize();
invalidateDisplayList();
}
//--------------------------------------------------------------------------
//
// Overridden event handlers: UIComponent
//
//--------------------------------------------------------------------------
/**
* @private
* Overridden keyDown to disable keyboard functionality.
*/
override protected function keyDownHandler(event:KeyboardEvent):void
{
}
/**
* @private
* Overridden expandItemHandler to disable animation
* and recalculate the height
* when allowInteraction is false.
*/
override mx_internal function expandItemHandler(event:AdvancedDataGridEvent):void
{
event.animate = false; // no animation
super.expandItemHandler(event);
// we have to recalculate the height
itemsSizeChanged = true;
invalidateDisplayList();
invalidateSize();
invalidateProperties();
}
}
}