Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
PrintDataGrid

Package | mx.printing
Class | public class PrintDataGrid
Inheritance | PrintDataGrid DataGrid DataGridBase ListBase ScrollControlBase UIComponent FlexSprite flash.display.Sprite

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The PrintDataGrid control is a DataGrid subclass that is styled to show a table with line borders and is optimized for printing. It can automatically size to properly fit its container, and removes any partially displayed rows.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:PrintDataGrid>` 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:PrintDataGrid>` tag adds the following tag attribute:

      <mx:PrintDataGrid
        Properties
        sizeToPage="true|false"
      >
      ...
      </mx:PrintDataGrid>

Default MXML Property `dataProvider`

View the examples

See also

FlexPrintJob

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object. | UIComponent
|  | activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances. | UIComponent
|  | automationDelegate : Object The delegate object that handles the automation-related functionality. | UIComponent
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UIComponent
|  | automationName : String Name that can be used as an identifier for this object. | UIComponent
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UIComponent
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UIComponent
|  | automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data. | UIComponent
|  | automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application. | UIComponent
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UIComponent
|  | baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | UIComponent
|  | borderMetrics : EdgeMetrics [read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. | ScrollControlBase
|  | bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object. | UIComponent
|  | cachePolicy : String Specifies the bitmap caching policy for this object. | UIComponent
|  | className : String [read-only] The name of this instance's class, such as "Button". | UIComponent
|  | columns : Array [override] An array of DataGridColumn objects, one for each column that can be displayed. | DataGrid
|  | contentMouseX : Number [read-only] Returns the x position of the mouse, in the content coordinate system. | UIComponent
|  | contentMouseY : Number [read-only] Returns the y position of the mouse, in the content coordinate system. | UIComponent
|  | currentPageHeight : Number [read-only] The height of PrintDataGrid that would be, if sizeToPage property is true and PrintDataGrid displays only completely viewable rows and no partial rows. | PrintDataGrid
|  | currentState : String The current view state of the component. | UIComponent
|  | cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers. | UIComponent
|  | data : Object The item in the data provider this component should render when this component is used as an item renderer or item editor. | ListBase
|  | dataProvider : Object Set of data to be viewed. | ListBase
|  | depth : Number Determines the order in which items inside of containers are rendered. | UIComponent
|  | descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance. | UIComponent
|  | designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element. | UIComponent
|  | document : Object A reference to the document object associated with this UIComponent. | UIComponent
|  | enabled : Boolean Whether the component can accept user interaction. | UIComponent
|  | enableIME : Boolean [read-only] A flag that indicates whether the IME should be enabled when the component receives focus. | DataGrid
|  | errorString : String The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails. | UIComponent
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UIComponent
|  | explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UIComponent
|  | flexContextMenu : IFlexContextMenu The context menu for this UIComponent. | UIComponent
|  | focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to. | UIComponent
|  | focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers. | UIComponent
|  | focusPane : Sprite The focus pane associated with this object. | UIComponent
|  | fontContext : IFlexModuleFactory The module factory that provides the font context for this component. | DataGridBase
|  | hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus. | UIComponent
|  | hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix. | UIComponent
|  | headerHeight : Number The height of the header cell of the column, in pixels. | DataGridBase
|  | height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates. | UIComponent
|  | horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | horizontalScrollPosition : Number [override] The offset into the content from the left edge. | DataGrid
|  | id : String ID of the component. | UIComponent
|  | imeMode : String Specifies the IME (input method editor) mode. | DataGrid
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | UIComponent
|  | inheritingStyles : Object The beginning of this component's chain of inheriting styles. | UIComponent
|  | initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required). | UIComponent
|  | instanceIndex : int [read-only] The index of a repeated component. | UIComponent
|  | instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document. | UIComponent
|  | is3D : Boolean [read-only] Contains true when the element is in 3D. | UIComponent
|  | isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object. | UIComponent
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UIComponent
|  | itemEditorInstance : IListItemRenderer A reference to the currently active instance of the item editor, if it exists. | DataGrid
|  | itemRenderer : IFactory The custom item renderer for the control. | ListBase
|  | labelFunction : Function A user-supplied function to run on each item to determine its label. | ListBase
|  | layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings. | UIComponent
|  | left : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | listData : BaseListData When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the listData property of the component with the additional data from the list control. | ListBase
|  | liveScrolling : Boolean = true A flag that indicates whether scrolling is live as the scrollbar thumb is moved or the view is not updated until the thumb is released. | ScrollControlBase
|  | lockedColumnCount : int The index of the first column in the control that scrolls. | DataGridBase
|  | lockedRowCount : int The index of the first row in the control that scrolls. | DataGridBase
|  | maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box. | UIComponent
|  | maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | measuredHeight : Number The default height of the component, in pixels. | UIComponent
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIComponent
|  | measuredWidth : Number The default width of the component, in pixels. | UIComponent
|  | menuSelectionMode : Boolean = false A flag that indicates whether menu-style selection should be used. | ListBase
|  | minColumnWidth : Number The minimum width of the columns, in pixels. | DataGrid
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | moduleFactory : IFlexModuleFactory A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component. | UIComponent
|  | mouseFocusEnabled : Boolean Whether you can receive focus when clicked on. | UIComponent
|  | MXMLDescriptor : Array [read-only] | UIComponent
|  | MXMLProperties : Array [read-only] | UIComponent
|  | nestLevel : int Depth of this object in the containment hierarchy. | UIComponent
|  | nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles. | UIComponent
|  | nullItemRenderer : IFactory The custom item renderer for the control. | ListBase
|  | numAutomationChildren : int [read-only] The number of automation children this container has. | UIComponent
|  | originalHeight : Number [read-only] The height of PrintDataGrid as set by the user. | PrintDataGrid
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | UIComponent
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UIComponent
|  | parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance. | UIComponent
|  | parentDocument : Object [read-only] A reference to the parent document object for this UIComponent. | UIComponent
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UIComponent
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UIComponent
|  | postLayoutTransformOffsets : TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout. | UIComponent
|  | processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens. | UIComponent
|  | repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent. | UIComponent
|  | repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent. | UIComponent
|  | repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent. | UIComponent
|  | repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent. | UIComponent
|  | resizableColumns : Boolean = true A flag that indicates whether the user can change the size of the columns. | DataGrid
|  | right : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | rotation : Number [override] | UIComponent
|  | rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationZ : Number [override] | UIComponent
|  | rowCount : int Number of rows to be displayed. | ListBase
|  | rowHeight : Number The height of the rows in pixels. | ListBase
|  | scaleX : Number [override] Number that specifies the horizontal scaling factor. | UIComponent
|  | scaleY : Number [override] Number that specifies the vertical scaling factor. | UIComponent
|  | scaleZ : Number [override] Number that specifies the scaling factor along the z axis. | UIComponent
|  | screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object. | UIComponent
|  | selectedItemsCompareFunction : Function A function used to compare items in the selectedItems property against items in the data provider. | ListBase
|  | showHeaders : Boolean A flag that indicates whether the control should show column headers. | DataGridBase
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | UIComponent
|  | sizeToPage : Boolean = true If true, the PrintDataGrid readjusts its height to display only completely viewable rows. | PrintDataGrid
|  | sortableColumns : Boolean = true A flag that indicates whether the user can sort the data provider items by clicking on a column header cell. | DataGrid
|  | states : Array The view states that are defined for this component. | UIComponent
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | UIComponent
|  | styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component. | UIComponent
|  | styleName : Object The class style used by this component. | UIComponent
|  | styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors. | UIComponent
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIComponent
|  | tabFocusEnabled : Boolean A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor. | UIComponent
|  | top : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | transform : Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | UIComponent
|  | transformX : Number Sets the x coordinate for the transform center of the component. | UIComponent
|  | transformY : Number Sets the y coordinate for the transform center of the component. | UIComponent
|  | transformZ : Number Sets the z coordinate for the transform center of the component. | UIComponent
|  | transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs. | UIComponent
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIComponent
|  | uid : String A unique identifier for the object. | UIComponent
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIComponent
|  | validationSubField : String Used by a validator to associate a subfield with this component. | UIComponent
|  | validNextPage : Boolean [read-only] Indicates the data provider contains additional data rows that follow the rows that the PrintDataGrid control currently displays. | PrintDataGrid
|  | value : Object [read-only] The selected item, or the data or label field of the selected item. | ListBase
|  | variableRowHeight : Boolean A flag that indicates whether the individual rows can have different height. | ListBase
|  | verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | verticalScrollPosition : Number The offset into the content from the top edge. | ScrollControlBase
|  | viewMetrics : EdgeMetrics [read-only] An EdgeMetrics object taking into account the scroll bars, if visible. | ScrollControlBase
|  | visible : Boolean [override] Whether or not the display object is visible. | UIComponent
|  | width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates. | UIComponent
|  | wordWrap : Boolean A flag that indicates whether text in the row should be word wrapped. | ListBase
|  | x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container. | UIComponent
|  | y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container. | UIComponent
|  | z : Number [override] | UIComponent

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualCollection : ICollectionView A copy of the value normally stored in collection used while running data changes effects. | ListBase
|  | actualIterator : IViewCursor A copy of the value normally stored in iterator used while running data changes effects. | ListBase
|  | allowItemSizeChangeNotification : Boolean [write-only] If false, renderers cannot invalidate size of List. | ListBase
|  | border : IFlexDisplayObject The border object. | ScrollControlBase
|  | cachedItemsChangeEffect : IEffect = null The effect that plays when changes occur in the data provider for the control, set through the itemsChangeEffect style. | ListBase
|  | collection : ICollectionView An ICollectionView that represents the data provider. | ListBase
|  | columnCaretIndicator : Sprite The DisplayObject that contains the graphics that indicates which renderer is the caret for lockedColumns. | DataGridBase
|  | columnHighlightIndicator : Sprite The DisplayObject that contains the graphics that indicates which renderer is highlighted for lockedColumns. | DataGridBase
|  | columnMap : Object A map of item renderes to columns. | DataGridBase
|  | currentCSSState : String [read-only] The state to be used when matching CSS pseudo-selectors. | UIComponent
|  | dataEffectCompleted : Boolean = false A flag that indicates that the a data change effect has just completed. | ListBase
|  | dataItemWrappersByRenderer : Dictionary A dictionary mapping item renderers to the ItemWrappers used to supply their data. | ListBase
|  | defaultColumnCount : int = 4 The default number of columns to display. | ListBase
|  | defaultRowCount : int = 4 The default number of rows to display. | ListBase
|  | explicitColumnCount : int = -1 The column count requested by explicitly setting the columnCount property. | ListBase
|  | explicitColumnWidth : Number The column width requested by explicitly setting the columnWidth. | ListBase
|  | explicitRowCount : int = -1 The row count requested by explicitly setting rowCount. | ListBase
|  | explicitRowHeight : Number The row height requested by explicitly setting rowHeight. | ListBase
|  | factoryMap : Dictionary A map of item renderers by factory. | ListBase
|  | freeItemRenderers : Array A stack of unused item renderers. | ListBase
|  | freeItemRenderersByFactory : Dictionary A map of free item renderers by factory. | ListBase
|  | freeItemRenderersTable : Dictionary A per-column table of unused item renderers. | DataGridBase
|  | hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent
|  | header : DataGridHeaderBase The header sub-component. | DataGridBase
|  | headerMask : Shape The header mask. | DataGridBase
|  | highlightItemRenderer : IListItemRenderer The renderer that is currently rolled over or under the caret. | ListBase
|  | itemsNeedMeasurement : Boolean = true A flag that indicates whether the columnWidth and rowHeight properties need to be calculated. | ListBase
|  | itemsSizeChanged : Boolean = false A flag that indicates that the size of the renderers may have changed. | ListBase
|  | iterator : IViewCursor The main IViewCursor used to fetch items from the data provider and pass the items to the renderers. | ListBase
|  | iteratorValid : Boolean = true A flag that indicates that a page fault as occurred and that the iterator's position is not valid (not positioned at the topmost item being displayed). | ListBase
|  | lastSeekPending : ListBaseSeekPending The most recent seek that caused a page fault. | ListBase
|  | listContent : ListBaseContentHolder An internal display object that parents all of the item renderers, selection and highlighting indicators and other supporting graphics. | ListBase
|  | listContentStyleFilters : Object [read-only] The set of styles to pass from the ListBase to the listContent. | ListBase
|  | listItems : Array [read-only] An Array of Arrays that contains the itemRenderer instances that render each data provider item. | ListBase
|  | lockedColumnAndRowContent : DataGridLockedRowContentHolder The sub-component that contains locked rows for locked columns. | DataGridBase
|  | lockedColumnContent : ListBaseContentHolder The sub-component that contains locked columns. | DataGridBase
|  | lockedColumnHeader : DataGridHeaderBase The header sub-component for locked columns. | DataGridBase
|  | lockedRowContent : DataGridLockedRowContentHolder The sub-component that contains locked rows. | DataGridBase
|  | maskShape : Shape The mask. | ScrollControlBase
|  | modifiedCollectionView : ModifiedCollectionView The collection view that temporarily preserves previous data provider state to facilitate running data change effects. | ListBase
|  | rendererChanged : Boolean = false A flag that indicates that the renderer changed. | ListBase
|  | reservedItemRenderers : Object A hash map of currently unused item renderers that may be used again in the near future. | ListBase
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | UIComponent
|  | rowInfo : Array [read-only] An array of ListRowInfo objects that cache row heights and other tracking information for the rows in listItems. | ListBase
|  | rowMap : Object A hash map of item renderers to their respective ListRowInfo object. | ListBase
|  | runDataEffectNextUpdate : Boolean = false A flag that indicates if a data effect should be initiated the next time the display is updated. | ListBase
|  | runningDataEffect : Boolean = false A flag indicating if a data change effect is currently running. | ListBase
|  | scrollAreaChanged : Boolean A flag that the scrolling area changed due to the appearance or disappearance of scrollbars. | ScrollControlBase
|  | selectedData : Object A hash table of ListBaseSelectionData objects that track which items are currently selected. | ListBase
|  | selectionIndicators : Object A hash table of selection indicators. | ListBase
|  | unconstrainedRenderers : Dictionary A hash map of item renderers that are not subject to the layout algorithms of the list. | ListBase
|  | unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component. | UIComponent
|  | unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList(). | UIComponent
|  | visibleData : Object [read-only] A hash table of data provider item renderers currently in view. | ListBase
|  | wordWrapChanged : Boolean = false A flag that indicates whether the value of the wordWrap property has changed since the last time the display list was updated. | ListBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | PrintDataGrid() Constructor. | PrintDataGrid
|  | addDataEffectItem(item:Object):void Adds an item renderer if a data change effect is running. | ListBase
|  | addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance. | UIComponent
|  | callLater(method:Function, args:Array = null):void Queues a function to be called later. | UIComponent
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | UIComponent
|  | contentToGlobal(point:Point):Point Converts a Point object from content coordinates to global coordinates. | UIComponent
|  | contentToLocal(point:Point):Point Converts a Point object from content to local coordinates. | UIComponent
|  | createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container. | UIComponent
|  | createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container. | UIComponent
|  | createColumnItemRenderer(c:DataGridColumn, forHeader:Boolean, data:Object):IListItemRenderer Returns the item renderer for a column cell or for a column header. | DataGridBase
|  | createItemRenderer(data:Object):IListItemRenderer Creates an item renderer given the data object. | ListBase
|  | createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object. | UIComponent
|  | deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object. | UIComponent
|  | determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent. | UIComponent
|  | dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow. | UIComponent
|  | drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component. | UIComponent
|  | drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programmatically draws a rectangle into this skin's Graphics object. | UIComponent
|  | endEffectsStarted():void Ends all currently playing effects on the component. | UIComponent
|  | executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination. | UIComponent
|  | findString(str:String):Boolean Finds an item in the list based on a String, and moves the selection to it. | ListBase
|  | finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete. | UIComponent
|  | generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent
|  | generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent
|  | getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index. | UIComponent
|  | getAutomationChildren():Array Provides the automation object list . | UIComponent
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | UIComponent
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | UIComponent
|  | getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance. | UIComponent
|  | getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component. | UIComponent
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UIComponent
|  | getFocus():InteractiveObject Gets the object that currently has focus. | UIComponent
|  | getItemRendererFactory(data:Object):IFactory Return the appropriate factory, using the default factory if none specified. | ListBase
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | UIComponent
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | UIComponent
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | UIComponent
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | UIComponent
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | UIComponent
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | UIComponent
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | UIComponent
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | UIComponent
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | UIComponent
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | UIComponent
|  | getRendererSemanticValue(target:Object, semanticProperty:String):Object Returns true or false to indicates whether the effect should play on the target. | ListBase
|  | getRepeaterItem(whichRepeater:int = -1):Object Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated. | UIComponent
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIComponent
|  | getVisibleRect(targetParent:DisplayObject = null):Rectangle Get the bounds of this object that are visible to the user on the screen. | UIComponent
|  | globalToContent(point:Point):Point Converts a Point object from global to content coordinates. | UIComponent
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | UIComponent
|  | hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent. | UIComponent
|  | horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient. | UIComponent
|  | indexToItemRenderer(index:int):IListItemRenderer Get an item renderer for the index of an item in the data provider, if one exists. | ListBase
|  | indicesToIndex(rowIndex:int, colIndex:int):int Computes the offset into the data provider of the item at colIndex, rowIndex. | ListBase
|  | initialize():void Initializes the internal structure of this component. | UIComponent
|  | initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component. | UIComponent
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UIComponent
|  | invalidateLayering():void Called by a component's items to indicate that their depth property has changed. | UIComponent
|  | invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. | UIComponent
|  | invalidateList():void Refresh all rows on the next update. | ListBase
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIComponent
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIComponent
|  | isItemEditable(data:Object):Boolean Determines whether to allow editing of a dataprovider item on a per-row basis. | DataGrid
|  | isItemSelectable(data:Object):Boolean Determines if the item renderer for a data provider item is selectable. | ListBase
|  | isItemShowingCaret(data:Object):Boolean Determines if the item renderer for a data provider item is the item under the caret due to keyboard navigation. | ListBase
|  | isItemVisible(item:Object):Boolean Determines if an item is being displayed by a renderer. | ListBase
|  | itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean Determines whether a renderer contains (or owns) a display object. | ListBase
|  | itemRendererToIndex(itemRenderer:IListItemRenderer):int Returns the index of the item in the data provider of the item being rendered by this item renderer. | ListBase
|  | itemToDataTip(data:Object):String Returns the dataTip string the renderer would display for the given data object based on the dataTipField and dataTipFunction properties. | ListBase
|  | itemToIcon(data:Object):Class Returns the class for an icon, if any, for a data item, based on the iconField and iconFunction properties. | ListBase
|  | itemToItemRenderer(item:Object):IListItemRenderer Returns the item renderer for a given item in the data provider, if there is one. | ListBase
|  | itemToLabel(data:Object):String Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties. | ListBase
|  | localToContent(point:Point):Point Converts a Point object from local to content coordinates. | UIComponent
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | UIComponent
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | UIComponent
|  | measureHeightOfItems(index:int = -1, count:int = 0):Number Measures a set of items from the data provider using the current item renderer and returns the sum of the heights of those items. | ListBase
|  | measureHTMLText(htmlText:String):TextLineMetrics Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | measureText(text:String):TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | measureWidthOfItems(index:int = -1, count:int = 0):Number Measures a set of items from the data provider using the current item renderer and returns the maximum width found. | ListBase
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIComponent
|  | nextPage():void Puts the next set of data rows in view; that is, it sets the PrintDataGrid verticalScrollPosition property to equal verticalScrollPosition + (number of scrollable rows). | PrintDataGrid
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children. | UIComponent
|  | owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | UIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent
|  | prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing. | UIComponent
|  | regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well. | UIComponent
|  | registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners. | UIComponent
|  | removeDataEffectItem(item:Object):void Removes an item renderer if a data change effect is running. | ListBase
|  | removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance. | UIComponent
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIComponent
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | UIComponent
|  | resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing(). | UIComponent
|  | scrollToIndex(index:int):Boolean Ensures that the data provider item at the given index is visible. | ListBase
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIComponent
|  | setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component. | UIComponent
|  | setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state. | UIComponent
|  | setFocus():void Sets the focus to this component. | UIComponent
|  | setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | UIComponent
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | UIComponent
|  | setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setMXMLDescriptor(value:Array):void | UIComponent
|  | setMXMLProperties(value:Array):void | UIComponent
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | UIComponent
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | UIComponent
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIComponent
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | UIComponent
|  | suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called. | UIComponent
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexSprite
|  | transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space. | UIComponent
|  | transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates. | UIComponent
|  | unconstrainRenderer(item:Object):void Called by an UnconstrainItemAction effect as part of a data change effect if the item renderers corresponding to certain data items need to move outside the normal positions of item renderers in the control. | ListBase
|  | validateDisplayList():void Validates the position and size of children and draws other visuals. | UIComponent
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIComponent
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | UIComponent
|  | validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements. | UIComponent
|  | validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component. | UIComponent
|  | verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient. | UIComponent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | addDragData(dragSource:Object):void Adds the selected items to the DragSource object as part of a drag-and-drop operation. | ListBase
|  | addMXMLChildren(comps:Array):void | UIComponent
|  | addToFreeItemRenderers(item:IListItemRenderer):void Adds a renderer to the recycled renderer list, making it invisible and cleaning up references to it. | ListBase
|  | addToRowArrays():void Add a blank row to the beginning of the arrays that store references to the rows. | ListBase
|  | adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle. | UIComponent
|  | adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void [override] Called from the updateDisplayList() method to adjust the size and position of listContent. | DataGrid
|  | adjustRow(contentHolder:ListBaseContentHolder, rowNum:int, yy:Number, hh:Number):void Adjusts the size and positions of the renderers for the given rowNum, row position and height. | DataGridBase
|  | applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform. | UIComponent
|  | applySelectionEffect(indicator:Sprite, uid:String, itemRenderer:IListItemRenderer):void Sets up the effect for applying the selection indicator. | ListBase
|  | attachOverlay():void This is an internal method used by the Flex framework to support the Dissolve effect. | UIComponent
|  | calculateDropIndicatorY(rowCount:Number, rowNum:int):Number Calculates the y position of the drop indicator when performing a drag-and-drop operation. | ListBase
|  | calculateRowHeight(data:Object, hh:Number, skipVisible:Boolean = false):Number Calculates the row height of columns in a row. | DataGridBase
|  | canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped. | UIComponent
|  | childrenCreated():void Performs any final processing after child objects are created. | UIComponent
|  | clearCaretIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void Clears the caret indicator into the given Sprite. | ListBase
|  | clearHighlightIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void Clears the highlight indicator in the given Sprite. | ListBase
|  | clearIndicators():void Removes all selection and highlight and caret indicators. | ListBase
|  | clearRow(contentHolder:ListBaseContentHolder, rowNum:int):void Removes renderers from a row that should be empty for the given rowNum. | DataGridBase
|  | clearSelected(transition:Boolean = false):void Clears the set of selected items and removes all graphics depicting the selected state of those items. | ListBase
|  | clearSeparators():void Removes column header separators that the user normally uses to resize columns. | DataGrid
|  | clearVisibleData():void Empty the visibleData hash table. | ListBase
|  | collectionChangeHandler(event:Event):void Handles CollectionEvents dispatched from the data provider as the data changes. | ListBase
|  | commitProperties():void [override] Calculates the column width and row height and number of rows and columns based on whether properties like columnCount columnWidth, rowHeight and rowCount were explicitly set. | ListBase
|  | configureScrollBars():void Configures the ScrollBars based on the number of rows and columns and viewable rows and columns. | ListBase
|  | copyItemWithUID(item:Object):Object Makes a deep copy of the object by calling the ObjectUtil.copy() method, and replaces the copy's uid property (if present) with a new value by calling the UIDUtil.createUID() method. | ListBase
|  | copySelectedItems(useDataField:Boolean = true):Array Copies the selected items in the order that they were selected. | ListBase
|  | createBorder():void Creates the border for this component. | ScrollControlBase
|  | createChildren():void [override] Creates objects that are children of this ListBase; in this case, the listContent object that will hold all the item renderers. | ListBase
|  | createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used. | UIComponent
|  | createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory. | UIComponent
|  | destroyRow(i:int, numCols:int):void Recycle a row that is no longer needed, and remove its indicators. | ListBase
|  | dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void Helper method for dispatching a PropertyChangeEvent when a property is updated. | UIComponent
|  | dragStartHandler(event:DragEvent):void The default handler for the dragStart event. | ListBase
|  | drawColumnBackground(s:Sprite, columnIndex:int, color:uint, column:DataGridColumn):void Draws a column background for a column with the suggested color. | DataGrid
|  | drawHeaderBackground(headerBG:UIComponent):void Draws the background of the headers into the given UIComponent. | DataGrid
|  | drawHorizontalLine(s:Sprite, rowIndex:int, color:uint, y:Number):void Draws a line between rows. | DataGrid
|  | drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void Draws the renderer with indicators that it is highlighted, selected, or the caret. | ListBase
|  | drawLinesAndColumnBackgrounds():void Draw lines between columns, and column backgrounds. | DataGrid
|  | drawLinesAndColumnGraphics(contentHolder:ListBaseContentHolder, visibleColumns:Array, separators:Object):void Draw lines between columns, and column backgrounds. | DataGrid
|  | drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void Draws a row background at the position and height specified using the color specified. | DataGrid
|  | drawRowBackgrounds():void Draws any alternating row colors, borders and backgrounds for the rows. | ListBase
|  | drawSeparators():void Creates and displays the column header separators that the user normally uses to resize columns. | DataGrid
|  | drawVerticalLine(s:Sprite, colIndex:int, color:uint, x:Number):void Draw lines between columns. | DataGrid
|  | drawVisibleItem(uid:String, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void Draws an item if it is visible. | DataGridBase
|  | findKey(eventCode:int):Boolean Tries to find the next item in the data provider that starts with the character in the eventCode parameter. | ListBase
|  | finishDataChangeEffect(event:EffectEvent):void Cleans up after a data change effect has finished running by restoring the original collection and iterator and removing any cached values used by the effect. | ListBase
|  | finishKeySelection():void [override] Sets selected items based on the caretIndex and anchorIndex properties. | DataGridBase
|  | focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus. | UIComponent
|  | focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus. | UIComponent
|  | generateMXMLAttributes(data:Array):void | UIComponent
|  | generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent
|  | generateMXMLObject(document:Object, data:Array):Object | UIComponent
|  | getReservedOrFreeItemRenderer(data:Object):IListItemRenderer Retrieves an already-created item renderer not currently in use. | ListBase
|  | indexToColumn(index:int):int The column for the data provider item at the given index. | ListBase
|  | indexToRow(index:int):int The row for the data provider item at the given index. | ListBase
|  | initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component. | UIComponent
|  | initializationComplete():void Finalizes the initialization of this component. | UIComponent
|  | initializeAccessibility():void Initializes this component's accessibility code. | UIComponent
|  | initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void Initiates a data change effect when there have been changes in the data provider. | ListBase
|  | invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true). | UIComponent
|  | isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus. | UIComponent
|  | isRendererUnconstrained(item:Object):Boolean Returns true if an item renderer is no longer being positioned by the list's layout algorithm while a data change effect is running as a result of a call to the unconstrainRenderer() method. | ListBase
|  | itemRendererToIndices(item:IListItemRenderer):Point [override] Returns a Point object that defines the columnIndex and rowIndex properties of an item renderer. | DataGridBase
|  | itemToUID(data:Object):String Determines the UID for a data provider item. | ListBase
|  | keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event. | UIComponent
|  | keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event. | UIComponent
|  | layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void Responds to size changes by setting the positions and sizes of this control's borders. | ScrollControlBase
|  | layoutColumnItemRenderer(c:DataGridColumn, item:IListItemRenderer, xx:Number, yy:Number):Point Sizes and temporarily positions an itemRenderer for a column, returning its size as a Point. | DataGridBase
|  | makeListData(data:Object, uid:String, rowNum:int, columnNum:int, column:DataGridColumn):BaseListData Creates a new DataGridListData instance and populates the fields based on the input data provider item. | DataGridBase
|  | makeRow(contentHolder:ListBaseContentHolder, rowNum:int, left:Number, right:Number, yy:Number, data:Object, uid:String):Number Creates the renderers for the given rowNum, dataObject and uid. | DataGridBase
|  | makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point Make enough rows and columns to fill the area described by left, top, right, bottom. | ListBase
|  | measure():void [override] Calculates the measured width and height of the component based on the rowCount, columnCount, rowHeight and columnWidth properties. | ListBase
|  | moveIndicatorsHorizontally(uid:String, moveBlockDistance:Number):void Move the selection and highlight indicators horizontally. | ListBase
|  | moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void Move the selection and highlight indicators vertically. | ListBase
|  | moveRowVertically(i:int, numCols:int, moveBlockDistance:Number):void Move a row vertically, and update the rowInfo record. | ListBase
|  | prepareDataEffect(ce:CollectionEvent):void Prepares the data effect for the collection event. | ListBase
|  | prepareRowArray(contentHolder:ListBaseContentHolder, rowNum:int):void Ensures that there is a slot in the row arrays for the given row number. | DataGridBase
|  | purgeItemRenderers():void Called by the updateDisplayList() method to remove existing item renderers and clean up various caching structures when the renderer changes. | ListBase
|  | reKeyVisibleData():void Update the keys in the visibleData hash table. | ListBase
|  | removeExtraRow(contentHolder:ListBaseContentHolder):void Removes extra row from the end of the contentHolder. | DataGridBase
|  | removeFromRowArrays(i:int):void Remove a row from the arrays that store references to the row. | ListBase
|  | resourcesChanged():void This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way. | UIComponent
|  | restoreRowArrays(modDeltaPos:int):void Remove the requested number of rows from the beginning of the arrays that store references to the rows. | ListBase
|  | roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean Determines if there is enough space in this component to display a given scrollbar. | ScrollControlBase
|  | scrollHandler(event:Event):void Default event handler for the scroll event. | ScrollControlBase
|  | scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void Adjusts the renderers in response to a change in scroll position. | ListBase
|  | scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int [override] Returns the data provider index for the item at the first visible row and column for the given scroll positions. | DataGrid
|  | scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void [override] Adjusts the renderers in response to a change in scroll position. | DataGrid
|  | seekPendingFailureHandler(data:Object, info:ListBaseSeekPending):void The default failure handler when a seek fails due to a page fault. | ListBase
|  | seekPendingResultHandler(data:Object, info:ListBaseSeekPending):void The default result handler when a seek fails due to a page fault. | ListBase
|  | seekPositionSafely(index:int):Boolean Seek to a position, and handle an ItemPendingError if necessary. | ListBase
|  | setRowCount(v:int):void Sets the rowCount property without causing invalidation or setting the explicitRowCount property, which permanently locks in the number of rows. | ListBase
|  | setRowHeight(v:Number):void Sets the rowHeight property without causing invalidation or setting of explicitRowHeight which permanently locks in the height of the rows. | ListBase
|  | setRowInfo(contentHolder:ListBaseContentHolder, rowNum:int, yy:Number, hh:Number, uid:String):void Sets the rowInfo for the given rowNum, row position and height. | DataGridBase
|  | setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent
|  | setupColumnItemRenderer(c:DataGridColumn, contentHolder:ListBaseContentHolder, rowNum:int, colNum:int, data:Object, uid:String):IListItemRenderer Sets up an item renderer for a column and put it in the listItems array at the requested position. | DataGridBase
|  | shiftRow(oldIndex:int, newIndex:int, numCols:int, shiftItems:Boolean):void Shift a row in the arrays that reference rows. | ListBase
|  | stateChanged(oldState:String, newState:String, recursive:Boolean):void This method is called when a state changes to check whether state-specific styles apply to this component. | UIComponent
|  | sumRowHeights(startRowIdx:int, endRowIdx:int):Number Determine the height of the requested set of rows. | ListBase
|  | truncateRowArrays(numRows:int):void Remove all remaining rows from the end of the arrays that store references to the rows. | ListBase
|  | UIDToItemRenderer(uid:String):IListItemRenderer Find an item renderer based on its UID if it is visible. | ListBase
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] Adds or removes item renderers if the number of displayable items changed. | ListBase
|  | updateList():void Refreshes all rows. | ListBase
|  | updateRendererDisplayList(r:IListItemRenderer):void Redraws the renderer synchronously. | DataGridBase

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | add | Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent
|  | change | Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction. | ListBase
|  | columnStretch | Dispatched when a user changes the width of a column, indicating that the amount of data displayed in that column may have changed. | DataGrid
|  | creationComplete | Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent
|  | currentStateChange | Dispatched after the view state has changed. | UIComponent
|  | currentStateChanging | Dispatched after the currentState property changes, but before the view state changes. | UIComponent
|  | dataChange | Dispatched when the data property changes. | ListBase
|  | dragStart | Dispatched by the drag initiator when starting a drag operation. | UIComponent
|  | effectStop | Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent
|  | enterState | Dispatched after the component has entered a view state. | UIComponent
|  | exitState | Dispatched just before the component exits a view state. | UIComponent
|  | headerShift | Dispatched when the user releases the mouse button on a column header after having dragged the column to a new location resulting in shifting the column to a new index. | DataGrid
|  | hide | Dispatched when an object's state changes from visible to invisible. | UIComponent
|  | initialize | Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent
|  | invalid | Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent
|  | itemEditorCreate | Dispatched when the item editor has just been instantiated. | DataGrid
|  | move | Dispatched when the object has moved. | UIComponent
|  | preinitialize | Dispatched at the beginning of the component initialization sequence. | UIComponent
|  | remove | Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent
|  | resize | Dispatched when the component is resized. | UIComponent
|  | scroll | Dispatched when the content is scrolled. | ScrollControlBase
|  | show | Dispatched when an object's state changes from invisible to visible. | UIComponent
|  | stateChangeComplete | Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent
|  | stateChangeInterrupted | Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent
|  | touchInteractionEnd | A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStart | A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStarting | A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent
|  | updateComplete | Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent
|  | valid | Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent
|  | valueCommit | Dispatched when values are changed programmatically or by user interaction. | UIComponent

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | accentColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | ScrollControlBase
|  | alternatingItemColors | Type: Array Format: Color CSS Inheritance: yes The colors to use for the backgrounds of the items in the list. | ListBase
|  | backgroundAlpha | Type: Number CSS Inheritance: no Theme: halo Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style. | ScrollControlBase
|  | backgroundColor | Type: uint Format: Color CSS Inheritance: no Theme: halo Background color of a component. | ScrollControlBase
|  | backgroundDisabledColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | ScrollControlBase
|  | backgroundImage | Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | ScrollControlBase
|  | backgroundSize | Type: String CSS Inheritance: no Theme: halo Scales the image specified by `backgroundImage` to different percentage sizes. | ScrollControlBase
|  | baseline | Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent
|  | borderAlpha | Type: Number CSS Inheritance: no Theme: spark Alpha of the border. | ScrollControlBase
|  | borderColor | Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | ScrollControlBase
|  | borderSides | Type: String CSS Inheritance: no Theme: halo Bounding box sides. | ScrollControlBase
|  | borderSkin | Type: Class CSS Inheritance: no The border skin class of the component. | ScrollControlBase
|  | borderStyle | Type: String CSS Inheritance: no Bounding box style. | ScrollControlBase
|  | borderThickness | Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. | ScrollControlBase
|  | borderVisible | Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | ScrollControlBase
|  | bottom | Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent
|  | chromeColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | ScrollControlBase
|  | color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ScrollControlBase
|  | contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | ScrollControlBase
|  | contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | ScrollControlBase
|  | defaultDataGridItemEditor | Type: Class CSS Inheritance: no Name of the class of the itemEditor to be used if one is not specified for a column. | DataGrid
|  | defaultDataGridItemRenderer | Type: Class CSS Inheritance: no Name of the class of the itemRenderer to be used if one is not specified for a column or its header. | DataGrid
|  | direction | Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | ScrollControlBase
|  | disabledColor | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | ScrollControlBase
|  | disabledIconColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo The color for the icon in a disabled skin. | DataGrid
|  | dropShadowColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Color of the drop shadow. | ScrollControlBase
|  | dropShadowEnabled | Type: Boolean CSS Inheritance: no Theme: halo Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase
|  | dropShadowVisible | Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase
|  | errorColor | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent
|  | focusAlpha | Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | ScrollControlBase
|  | focusBlendMode | Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent
|  | focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | ScrollControlBase
|  | focusRoundedCorners | Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | ScrollControlBase
|  | focusSkin | Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent
|  | focusThickness | Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent
|  | fontAntiAliasType | Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields. See also flash.text.TextField flash.text.AntiAliasType | ScrollControlBase
|  | fontFamily | Type: String CSS Inheritance: yes Name of the font to use. | ScrollControlBase
|  | fontGridFitType | Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField flash.text.GridFitType | ScrollControlBase
|  | fontSharpness | Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | ScrollControlBase
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | ScrollControlBase
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. | ScrollControlBase
|  | fontThickness | Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | ScrollControlBase
|  | fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. | ScrollControlBase
|  | headerBackgroundSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the background of the column headers in a DataGrid control. | DataGrid
|  | headerColors | Type: Array Format: Color CSS Inheritance: yes Theme: halo An array of two colors used to draw the header background gradient. | DataGrid
|  | headerSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between column headers in a DataGrid control. | DataGrid
|  | headerStyleName | Type: String CSS Inheritance: no The name of a CSS style declaration for controlling other aspects of the appearance of the column headers. | DataGrid
|  | horizontalCenter | Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | horizontalGridLineColor | Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | DataGrid
|  | horizontalGridLines | Type: Boolean CSS Inheritance: no A flag that indicates whether to show horizontal grid lines between the rows. | DataGrid
|  | horizontalLockedSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between the locked and unlocked rows in a DataGrid control. | DataGrid
|  | horizontalSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between rows in a DataGrid control. | DataGrid
|  | iconColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo The color for the icon in a skin. | DataGrid
|  | interactionMode | Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH | UIComponent
|  | kerning | Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`). | ScrollControlBase
|  | layoutDirection | Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection | UIComponent
|  | leading | Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | ScrollControlBase
|  | left | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent
|  | letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | ScrollControlBase
|  | locale | Type: String CSS Inheritance: yes The locale of the text displayed by this component. | ScrollControlBase
|  | paddingBottom | Type: Number Format: Length CSS Inheritance: no The number of pixels between the bottom of the row and the bottom of the renderer in the row. | ListBase
|  | paddingLeft | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | ListBase
|  | paddingRight | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | ListBase
|  | paddingTop | Type: Number Format: Length CSS Inheritance: no The number of pixels between the top of the row and the top of the renderer in the row. | ListBase
|  | right | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent
|  | shadowDirection | Type: String CSS Inheritance: no Theme: halo Direction of the drop shadow. | ScrollControlBase
|  | shadowDistance | Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of the drop shadow. | ScrollControlBase
|  | showErrorSkin | Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent
|  | showErrorTip | Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent
|  | sortArrowSkin | Type: Class CSS Inheritance: no The class to use as the skin for the arrow that indicates the column sort direction. | DataGrid
|  | stretchCursor | Type: Class CSS Inheritance: no The class to use as the skin for the cursor that indicates that a column can be resized. | DataGrid
|  | symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | ScrollControlBase
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. | ScrollControlBase
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. | ScrollControlBase
|  | textFieldClass | Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | ScrollControlBase
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | ScrollControlBase
|  | themeColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent
|  | top | Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent
|  | verticalAlign | Type: String CSS Inheritance: no The vertical alignment of a renderer in a row. | ListBase
|  | verticalCenter | Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | verticalGridLineColor | Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | DataGrid
|  | verticalGridLines | Type: Boolean CSS Inheritance: no A flag that indicates whether to show vertical grid lines between the columns. | DataGrid
|  | verticalLockedSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between the locked and unlocked columns in a DataGrid control. | DataGrid
|  | verticalSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separators between columns in a DataGrid control. | DataGrid

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property. | UIComponent
|  | DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property. | UIComponent
|  | DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property. | UIComponent
|  | DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property. | UIComponent

Property Detail

currentPageHeight | property

`currentPageHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The height of PrintDataGrid that would be, if `sizeToPage` property is `true` and PrintDataGrid displays only completely viewable rows and no partial rows. If `sizeToPage` property is `true`, the value of this property equals the `height` property.

Implementation
`public function get currentPageHeight():Number`

originalHeight | property |

`originalHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The height of PrintDataGrid as set by the user. If the `sizeToPage` property is `false`, the value of this property equals the `height` property.

Implementation
`public function get originalHeight():Number`

sizeToPage | property |

`public var sizeToPage:Boolean = true`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

If `true`, the PrintDataGrid readjusts its height to display only completely viewable rows.

validNextPage | property |

`validNextPage:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates the data provider contains additional data rows that follow the rows that the PrintDataGrid control currently displays.

Implementation
`public function get validNextPage():Boolean`
Constructor Detail

PrintDataGrid | () | Constructor

`public function PrintDataGrid()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Constructs a DataGrid without scrollbars or 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 dataProvider rows, whichever is smaller.

Method Detail

nextPage | () | method

`public function nextPage():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Puts the next set of data rows in view; that is, it sets the PrintDataGrid `verticalScrollPosition` property to equal `verticalScrollPosition` + (number of scrollable rows).

Examples
FormPrintHeader.mxml

    <?xml version="1.0"?>
    <!--

      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.

    -->
    <!-- Custom control for the header area of the printed page. -->
    <s:VGroup name="FormPrintHeader"
            xmlns:fx="http://ns.adobe.com/mxml/2009"
            xmlns:s="library://ns.adobe.com/flex/spark"
            width="60%"
            horizontalAlign="right" >

        <s:Label text="This is a placeholder for first page contents"/>

    </s:VGroup>

FormPrintFooter.mxml

    <?xml version="1.0"?>
    <!--

      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.

    -->
    <!-- Custom control for the footer area of the printed page. -->
    <s:VGroup name="FormPrintFooter"
            xmlns:fx="http://ns.adobe.com/mxml/2009"
            xmlns:s="library://ns.adobe.com/flex/spark"
            width="60%"
            horizontalAlign="right" >

        <!-- Declare and initialize the product total variable. -->
        <fx:Script>
            <![CDATA[
                [Bindable]
                public var pTotal:Number = 0;
            ]]>
        </fx:Script>

        <s:Label text="Product Total: {pTotal}"/>

    </s:VGroup>

FormPrintView.mxml

    <?xml version="1.0"?>
    <!--

      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.

    -->
    <!-- Custom control to print the Halo DataGrid control on multiple pages. -->
    <s:VGroup name="FormPrintView"
            xmlns:fx="http://ns.adobe.com/mxml/2009"
            xmlns:s="library://ns.adobe.com/flex/spark"
            xmlns:mx="library://ns.adobe.com/flex/mx"
            xmlns="*">

        <fx:Script>
            <![CDATA[
                import mx.core.*;

                // Declare and initialize the variables used in the component.
                // The application sets the actual prodTotal value.
                [Bindable]
                public var pageNumber:Number = 1;

                [Bindable]
                public var prodTotal:Number = 0;

                // Control the page contents by selectively hiding the header and
                // footer based on the page type.
                public function showPage(pageType:String):void {
                    if (pageType == "first" || pageType == "middle") {
                        // Hide the footer.
                        footer.includeInLayout = false;
                        footer.visible = false;
                    }
                    if (pageType == "middle" || pageType == "last") {
                        // The header won't be used again; hide it.
                        header.includeInLayout = false;
                        header.visible = false;
                    }
                    if (pageType == "last") {
                        // Show the footer.
                        footer.includeInLayout = true;
                        footer.visible = true;
                    }
                    //Update the DataGrid layout to reflect the results.
                    validateNow();
                }
            ]]>
        </fx:Script>

        <!-- The template for the printed page, with the contents for all pages. -->
        <s:VGroup width="80%" horizontalAlign="left">
            <s:Label text="Page {pageNumber}"/>
        </s:VGroup>

        <FormPrintHeader id="header" />

        <!-- The data grid. The sizeToPage property is true by default, so the last
            page has only as many grid rows as are needed for the data. -->
        <mx:PrintDataGrid id="myDataGrid" width="60%" height="100%">
            <!-- Specify the columns to ensure that their order is correct. -->
            <mx:columns>
                <mx:DataGridColumn dataField="Index" />
                <mx:DataGridColumn dataField="Qty" />
            </mx:columns>
        </mx:PrintDataGrid>

        <!-- Create a FormPrintFooter control and set its prodTotal variable. -->
        <FormPrintFooter id="footer" pTotal="{prodTotal}" />

    </s:VGroup>

PrintDataGridExample.mxml

    <?xml version="1.0"?>
    <!--

      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.

    -->
    <!-- Main application to print a Halo DataGrid control on multiple pages. -->
    <s:Application name="PrintDataGridExample.mxml"
            xmlns:fx="http://ns.adobe.com/mxml/2009"
            xmlns:s="library://ns.adobe.com/flex/spark"
            xmlns:mx="library://ns.adobe.com/flex/mx"
            initialize="initData();">

        <fx:Script>
            <![CDATA[

            import mx.printing.*;
            import mx.collections.ArrayCollection;
            import FormPrintView;
            import mx.core.FlexGlobals;

            // Declare variables and initialize simple variables.
            [Bindable]
            public var dgProvider:ArrayCollection;
            public var footerHeight:Number = 20;
            public var prodIndex:Number;
            public var prodTotal:Number = 0;

            // Data initialization.
            public function initData():void {
                // Create the data provider for the DataGrid control.
                dgProvider = new ArrayCollection;
            }

            // Fill the dgProvider ArrayCollection with the specified items.
            public function setdgProvider(items:int):void {
                prodIndex=1;
                dgProvider.removeAll();
                for (var z:int=0; z<items; z++) {
                    var prod1:Object = {};
                    prod1.Qty = prodIndex * 7;
                    prod1.Index = prodIndex++;
                    prodTotal += prod1.Qty;
                    dgProvider.addItem(prod1);
                }
            }

            // The function to print the output.
            public function doPrint():void {
                var printJob:FlexPrintJob = new FlexPrintJob();
                if (printJob.start()) {
                    // Create a FormPrintView control as a child of the current view.
                    var thePrintView:FormPrintView = new FormPrintView();
                    FlexGlobals.topLevelApplication.addElement(thePrintView);

                    //Set the print view properties.
                    thePrintView.width=printJob.pageWidth;
                    thePrintView.height=printJob.pageHeight;
                    thePrintView.prodTotal = prodTotal;
                    // Set the data provider of the FormPrintView component's data grid
                    // to be the data provider of the displayed data grid.
                    thePrintView.myDataGrid.dataProvider = myDataGrid.dataProvider;
                    // Create a single-page image.
                    thePrintView.showPage("single");
                    // If the print image's data grid can hold all the provider's rows,
                    // add the page to the print job.
                    if (!thePrintView.myDataGrid.validNextPage)  {
                        printJob.addObject(thePrintView);
                    }
                    // Otherwise, the job requires multiple pages.
                    else {
                        // Create the first page and add it to the print job.
                        thePrintView.showPage("first");
                        printJob.addObject(thePrintView);
                        thePrintView.pageNumber++;
                        // Loop through the following code until all pages are queued.
                        while (true) {
                            // Move the next page of data to the top of the print grid.
                            thePrintView.myDataGrid.nextPage();
                            thePrintView.showPage("last");
                            // If the page holds the remaining data, or if the last page
                            // was completely filled by the last grid data, queue it for printing.
                            // Test if there is data for another PrintDataGrid page.
                            if (!thePrintView.myDataGrid.validNextPage) {
                                // This is the last page; queue it and exit the print loop.
                                printJob.addObject(thePrintView);
                                break;
                            } else {
                                // This is not the last page. Queue a middle page.
                                thePrintView.showPage("middle");
                                printJob.addObject(thePrintView);
                                thePrintView.pageNumber++;
                            }
                        }
                    }
                    // All pages are queued; remove the FormPrintView control to free memory.
                    FlexGlobals.topLevelApplication.removeElement(thePrintView);
                }
                // Send the job to the printer.
                printJob.send();
            }
            ]]>
        </fx:Script>

        <s:Panel title="DataGrid Printing Example"
                width="75%" height="75%"
                horizontalCenter="0" verticalCenter="0">
            <s:VGroup left="10" right="10" top="10" bottom="10">
                <mx:DataGrid id="myDataGrid" dataProvider="{dgProvider}">
                    <mx:columns>
                        <mx:DataGridColumn dataField="Index"/>
                        <mx:DataGridColumn dataField="Qty"/>
                    </mx:columns>
                </mx:DataGrid>

                <s:Label width="100%" color="blue"
                    text="Specify the number of lines and click Fill Grid first. Then you can click Print."/>

                <s:TextInput id="dataItems" text="35"/>

                <s:HGroup>
                    <s:Button id="setDP" label="Fill Grid" click="setdgProvider(int(dataItems.text));"/>
                    <s:Button id="printDG" label="Print" click="doPrint();"/>
                </s:HGroup>
            </s:VGroup>
        </s:Panel>

    </s:Application>

Sun Mar 5 2017, 03:42 PM +11:00