| Package | com.flexicious.grids.spark.print |
| Class | public class ExtendedSparkPrintDataGrid |
| Inheritance | ExtendedSparkPrintDataGrid  ExtendedSparkDataGrid SEdgBase spark.components.DataGrid |
| Implements | com.flexicious.print.printareas.IPrintDatagrid |
Default MXML PropertydataProvider
| Property | Defined By | ||
|---|---|---|---|
 | additionalFilterArgumentsFunction : Function
In scenarios where there are detached filters, this function
may be used to add on to the list of arguments before the filter is
run. | SEdgBase | |
| autoLoadPreferences : Boolean = true | ExtendedSparkDataGrid | |
| clickBehavior : String
Grid can be setup to launch a popup when the user clicks or hovers. | ExtendedSparkDataGrid | |
| clickParentDisplayObject : DisplayObject
The parent object to use while calling PopupManager.addPopUp. | ExtendedSparkDataGrid | |
| clickPopupClass : IFactory
The popup class to launch. | ExtendedSparkDataGrid | |
| clickPopupHeight : Number
The height of the popup to launch when the clickBehavior is set. | ExtendedSparkDataGrid | |
| clickPopupTitle : String
The title of the popup to launch when the clickBehavior is set. | ExtendedSparkDataGrid | |
| clickPopupWidth : Number
The width of the popup to launch when the clickBehavior is set. | ExtendedSparkDataGrid | |
| collectionManipulatorFactory : IFactory
The class that manages the collection filtering, paging and sorting. | ExtendedSparkDataGrid | |
| columns : IList [override] [write-only] | ExtendedSparkDataGrid | |
| _columnWidthsDirty : Boolean = false | ExtendedSparkDataGrid | |
| copyAllRowsMenuText : String = Copy All Rows
Text for the Copy All Rows
| ExtendedSparkDataGrid | |
| copyCellMenuText : String = Copy Cell
Text for the Copy Cell Menu
| ExtendedSparkDataGrid | |
| copySelectedRowMenuText : String = Copy Selected Row
Text for the Copy Selected Row
| ExtendedSparkDataGrid | |
| currentItemUnderMouse : Object [read-only] | ExtendedSparkDataGrid | |
| dataProviderNoPaging : Object [read-only]
Gets a copy of the dataprovider with filter and sort applied, but no paging. | ExtendedSparkDataGrid | |
| displayOrder : String
A comma seperated list of the following strings:
filter,body,footer,pager for the Advanced Data Grid
filter,header,body,footer,pager for the Classic Data Grid
Changes the order in which the grid displays the
filter,header,body,footer,pager
The order in which the various sections of the grid
are laid out. | SEdgBase | |
| enableColumnWidthMode : Boolean = true
Flag to use the columnWidthMode based column resizing. | ExtendedSparkDataGrid | |
| enableCopy : Boolean
A flag that indicates whether or not to show the context menu options to
copy the cell,row, or table data
| SEdgBase | |
| enableDoubleClickEdit : Boolean
Enables or disables keyboard navigation for filters. | SEdgBase | |
| enableExport : Boolean
A flag that may be used for binding purposes
in the custom pager control. | SEdgBase | |
| enableFilters : Boolean
A flag that indicates whether or not to show the filters
| SEdgBase | |
| enableFooters : Boolean
A flag that indicates whether or not to show the footer
| SEdgBase | |
| enableKeyboardNavigation : Boolean
Enables or disables keyboard navigation for filters. | SEdgBase | |
| enableMultiplePreferences : Boolean
A Flag that will enable multiple named versions of preferences to be persisted. | ExtendedSparkDataGrid | |
| enablePaging : Boolean
A flag to indicate whether or not to enable paging functionality
| ExtendedSparkDataGrid | |
| enablePreferencePersistence : Boolean
When set to true, causes the grid to look for settings stored
previously in the local shared object store if
preferencePersistenceMode='client' or dispatch an event requesting
settings from the server in preferencePersistenceMode='server'
| ExtendedSparkDataGrid | |
| enablePrint : Boolean
A flag that may be used for binding purposes
in the custom pager control. | SEdgBase | |
| excelOptions : ExportOptions
The Export options object that is used to configure the excel export behavior - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| exportableColumns : Array [read-only]
Returns a list of columns that have excludeFromExport=false (default)
| ExtendedSparkDataGrid | |
| filterPageSortMode : String
The Filter/Page/Sort Mode. | SEdgBase | |
| filterRowHeight : Number
The height of the filter row. | ExtendedSparkDataGrid | |
| filterVisible : Boolean
If you have enableFilters set to true but want the filter row to not
appear, you can set this value. | ExtendedSparkDataGrid | |
| footerRowHeight : Number
The height of the footer row. | ExtendedSparkDataGrid | |
| footerVisible : Boolean
If you have enableFooters set to true but want the footer row to not
appear, you can set this value. | ExtendedSparkDataGrid | |
| forcePagerRow : Boolean
Use this flag to show the pager control even if the
enablePaging is set to false. | ExtendedSparkDataGrid | |
| groupedColumns : Array
Unused/Not Applicable. | ExtendedSparkDataGrid | |
| headerHeight : Number [read-only] | ExtendedSparkPrintDataGrid | ||
| horizontalScrollPolicy : String
Returns scroller.getStyle("horizontalScrollPolicy");
| ExtendedSparkDataGrid | |
| horizontalScrollPosition : Number
Returns scroller.getStyle("horizontalScrollPolicy");
| ExtendedSparkDataGrid | |
| initialSortAscending : Boolean
In conjunction with the initialSortField property,
If the initial value used to set the dataProvider is
sorted by a specific field,
set this property to the name of that field. | SEdgBase | |
| initialSortField : String
If the initial value used to set the dataProvider is
sorted by a specific field,
set this property to the name of that field. | SEdgBase | |
| listContent : Object [read-only]
returns scroller
| ExtendedSparkDataGrid | |
| lockedColumnCount : int [read-only]
Unused/Not Applicable. | ExtendedSparkDataGrid | |
| lockedColumns : Array [read-only]
Returns columns 0 through x, where x=lockedColumnCount
| SEdgBase | |
| lockedColumnWidth : int [read-only]
Returns the width of the locked columns
| SEdgBase | |
| lockedHeader : DataGridHeader [read-only]
Returns the locked header row
| SEdgBase | |
| nativeExcelExporter : Exporter
The default exporter in flexicious is a pure CSV exporter. | ExtendedSparkDataGrid | |
| pageIndex : int
The current page index
| ExtendedSparkDataGrid | |
| pager : IPager [read-only]
Handle to the current IPager control. | ExtendedSparkDataGrid | |
| pagerPosition : String
The horizontal positioning of the contents of the pager. | SEdgBase | |
| pagerRenderer : IFactory
A Class that implements com.flexicious.controls.interfaces.IPager. | ExtendedSparkDataGrid | |
| pagerRowHeight : Number
The height of the pager row. | ExtendedSparkDataGrid | |
| pagerVisible : Boolean
If you have enablePaging set to true but want the pager row to not
appear, you can set this value. | ExtendedSparkDataGrid | |
| pageSize : int
The number of records to display per page
| ExtendedSparkDataGrid | |
| pdfOptions : PrintOptions
The Print options object that is used to configure the pdf behavior - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| pdfPrinter : IPDFPrinter
A class that takes the PDF Pages as they are generated. | ExtendedSparkDataGrid | |
| popupFactoryExportOptions : IFactory
The renderer that shows up when the user clicks on the Word or Excel button - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| popupFactoryOpenSettingsPopup : IFactory
The renderer that shows up when the user clicks on the Open Settings button - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| popupFactoryPrintOptions : IFactory
The renderer that shows up when the user clicks on the Print or PDF button - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| popupFactorySaveSettingsPopup : IFactory
The renderer that shows up when the user clicks on the Save Settings button - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| popupFactorySettingsPopup : IFactory
The renderer that shows up when the user clicks on the Settings button - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| preferencePersistenceKey : String
String value that uniquely identifies this grid across the application. | ExtendedSparkDataGrid | |
| preferencePersistenceMode : String
String value "server" or "client". | ExtendedSparkDataGrid | |
| preferences : String
Returns an XML representation of the preferences specified in
the preferencesToPersist property and values being the actual
values. | ExtendedSparkDataGrid | |
| preferencesLoaded : Boolean [read-only]
Returns true if the load preferences has been called. | ExtendedSparkDataGrid | |
| preferencesSet : Boolean
A flag to indicate that the preferences for this grid
has been set. | ExtendedSparkDataGrid | |
| preferencesToPersist : String
A comma delimited string of the following values:
columnOrder,columnVisiblity,columnWidth,filter,sort,verticalScroll,horizontalScroll
Each represents a setting that can potentially be persisted. | ExtendedSparkDataGrid | |
| printableColumns : Array [read-only]
Returns a list of columns that have excludeFromPrint=false (default)
| ExtendedSparkDataGrid | |
| printExportData : Object
Gets the records to print or to export. | SEdgBase | |
| printExportParameters : Object
Any custom data that you wish to pass into the print/export mechanism.
This will then be available on Print/Export Options
when the Print or Export is run. | SEdgBase | |
| printListItems : Array [read-only] | ExtendedSparkPrintDataGrid | ||
| printOptions : PrintOptions
The Print options object that is used to configure the print behavior - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| rowCount : int [override] [read-only] | ExtendedSparkPrintDataGrid | ||
| selectAllState : String
The state of the select all header checkbox. | ExtendedSparkDataGrid | |
| selectedKeyField : String
The property(attribute) of the type(class) of the objects
contained within the collection bound to the dataProvider. | ExtendedSparkDataGrid | |
| selectedKeys : ArrayCollection [read-only]
Gets the keys of the objects selected by the user
when used in conjunction with the selectedKeyField
object
| ExtendedSparkDataGrid | |
| selectedObjects : ArrayCollection [read-only]
Gets the objects selected by the user
when used in conjunction with the selectedKeyField
object
| ExtendedSparkDataGrid | |
| settingsColumns : Array [read-only]
Returns a list of columns that have excludeFromPrint=false (default)
| ExtendedSparkDataGrid | |
| showSpinnerOnCreationComplete : Boolean | ExtendedSparkDataGrid | |
| showSpinnerOnFilterPageSort : Boolean
A flag when set, automatically shows the spinner on creation complete and
any filter page or sort operation. | SEdgBase | |
| spinner : ISpinner | ExtendedSparkDataGrid | |
| spinnerFactory : IFactory
Factory responsible for instantiating a new spinner. | ExtendedSparkDataGrid | |
| spinnerLabel : String
The label of the spinner control, you can use styles
to control the appearance. | ExtendedSparkDataGrid | |
| totalRecords : int
The total number of records (needs to be set only in server mode,
because there is no way for the grid to know how many records on
the server match the filter criteria)
In client mode, the count of the data provider is used instead. | ExtendedSparkDataGrid | |
| unLockedColumns : Array [read-only]
Returns columns x through columns.count, where x=lockedColumnCount
| ExtendedSparkDataGrid | |
| unLockedHeader : DataGridHeader [read-only]
Returns the unlocked part of the header
| SEdgBase | |
| useCompactPreferences : Boolean
If set to true, uses the newer preference persistence scheme introduced in
Flexicious 2.0, which stores the preferences as custom string as opposed to XML,
making it a lot less verbose. | ExtendedSparkDataGrid | |
| useModuleFactory : Boolean [read-only]
Flag that indicates to use the module factory of the grid to show popups. | ExtendedSparkDataGrid | |
| userSettingsOptionsFunction : Function
Hook for the client to plug in their own UserSettings. | ExtendedSparkDataGrid | |
| validNextPage : Boolean [read-only]
Indicates the data provider contains additional data rows that follow
the rows that the PrintDataGrid control currently displays. | ExtendedSparkPrintDataGrid | ||
| verticalScrollBarOffset : int [read-only]
If the vertical scrollbar is visible, returns the width
of the vertical scroll bar. | SEdgBase | |
| verticalScrollPosition : Number
Returns scroller.getStyle("horizontalScrollPolicy");
| ExtendedSparkDataGrid | |
| viewMetrics : EdgeMetrics [read-only]
Unused/Not applicable to the Nested DataGrid. | ExtendedSparkDataGrid | |
| visibleColumns : Array [read-only]
Returns the visible columns from the unlocked header. | SEdgBase | |
| wordOptions : ExportOptions
The Export options object that is used to configure the word export behavior - currently only supported in Ultimate
| ExtendedSparkDataGrid | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ExtendedSparkPrintDataGrid | ||
| addContextMenuItem(lbl:String, clickHandler:Function, separatorBefore:Boolean = false):void
Adds the specified context menu item to the context menu. | ExtendedSparkDataGrid | |
| clearFilter():void
Calls clear on all internal filter controls, resetting the state
| ExtendedSparkDataGrid | |
| clearPreferences():void | ExtendedSparkDataGrid | |
| clearSelectedCheckBoxes():void
Clears the checkbox selections when used in
conjunction with SelectAllCheckBoxHeaderColumn
see com.flexicious.grids.columns.SelectAllCheckBoxHeaderColumn
| ExtendedSparkDataGrid | |
| clearSort():void
Clears out the sort. | SEdgBase | |
| ExtendedSparkDataGrid | ||
|
Consolidates the current state of all our filters, pager and
sorts and creates a filter object that can be used to act
on it
| ExtendedSparkDataGrid | |
| createPopup(popupData:Object):Object
Creates the popup. | ExtendedSparkDataGrid | |
| createPrintComponentFactory():IFactory
Gets the class responsible for handling the PrintUI should be a IPrintDataGrid
| ExtendedSparkDataGrid | |
| getAutoLoadPreferences():Boolean
By default, when the grid's creation complete event is dispatched, the grid will go
in and load the saved preference. | ExtendedSparkDataGrid | |
|
When enableMultiplePreferences = true, this represents the currently applied preference
| ExtendedSparkDataGrid | |
| getDistinctValuesForColumn(dataField:String):ArrayCollection | ExtendedSparkDataGrid | |
| getExportableColumns(options:ExportOptions):Array | ExtendedSparkDataGrid | |
| getFilterArguments():ArrayCollection | ExtendedSparkDataGrid | |
| getFilterColumn(searchField:String):Object
Given a field to search for, return the column that has it's
searchField set to the provided value. | ExtendedSparkDataGrid | |
| getFilterValue(column:String):*
Used to get the current value of the filter. | ExtendedSparkDataGrid | |
| getFilterX(renderer:IFilterControl):Number
Used by filter to identify where relative position for each control for tabbing
| ExtendedSparkDataGrid | |
|
When enableMultiplePreferences = true, this represents a list of all preferences saved for this
grid. | ExtendedSparkDataGrid | |
| getLastItemUnderMouse():Object
Gets the item that was under the mouse last
| ExtendedSparkDataGrid | |
| getPrintableColumns(options:PrintOptions):Array | ExtendedSparkDataGrid | |
| getRowText(item:Object):String
Converts an objects properties into tab delimited format
| SEdgBase | |
| ExtendedSparkDataGrid | ||
gotoRow(rowIndex:int):void
In addition to the basic nextPage function, we provide the
gotoRow so user can easily jump back and forth on the preview
window
| ExtendedSparkPrintDataGrid | ||
| hideSpinner():void
Removes the spinner and sets the listContent.alpha back to 1
| ExtendedSparkDataGrid | |
| invalidateDisplayList():void [override]
Need to invalidte our children when we invalidate. | ExtendedSparkDataGrid | |
| invalidateList():void
Interface conformance, will simply reset the visibility of the footer, filter and pager groups. | ExtendedSparkDataGrid | |
| loadPreferences():void
Loads preference values from the Shared object, called automatically in
preferencePersistenceMode=client. | ExtendedSparkDataGrid | |
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). | ExtendedSparkPrintDataGrid | ||
| pauseKeyboardListeners(filterRenderer:Object):void
For some operations, like shift tab and tab key up, purposely pause the Container keyboard listenters,
so we do not overwrite the work of one keyboard handler by triggering another. | ExtendedSparkDataGrid | |
| persistPreferences(name:String = Default, isDefault:Boolean = false):void
Persists the preferences as Shared Objects when preferencePersistenceMode=client
or dispatches an event with the preference information when preferencePersistenceMode=server
| ExtendedSparkDataGrid | |
| processFilter():void
If you want to control when the filter runs,
set the filterTriggerEvent="none" on each of the
columns, and call this function to trigger the filter
| ExtendedSparkDataGrid | |
| processSort(sorts:ArrayCollection):void
Used by state persistence to load sort settings that were
persisted previously. | SEdgBase | |
| refreshLayout():void
Resets the position of each of the filter controls, the
position, height and width of the filter and footer container rows,
as well as the pager control
This is done automatically when the columns are resized, or the
list changes, or the grid is resized. | ExtendedSparkDataGrid | |
| removeContextMenuItem(lbl:String):void
Removes the specified context menu item
| ExtendedSparkDataGrid | |
| setColumnWidthsUsingWidthMode(force:Boolean = false):void
Recalculates column widths on basis of columnWidthMode. | ExtendedSparkDataGrid | |
| setContextMenuEnableDisable(lbl:String, enabled:Boolean):Boolean
Sets the enabled/disabled flag on the specified context menu item. | ExtendedSparkDataGrid | |
| setContextMenuEnableVisible(lbl:String, visible:Boolean):Boolean
Sets the visible flag on the specified context menu item. | ExtendedSparkDataGrid | |
| setCurrentPreferenceInfo(val:PreferenceInfo, applyPreferences:Boolean = true):void
When enableMultiplePreferences = true, applies the given preference as the current
preference. | ExtendedSparkDataGrid | |
| setFilterFocus(fld:String):Boolean | ExtendedSparkDataGrid | |
| setFilterValue(column:String, value:Object, triggerEvent:Boolean = true):void
Used to set the initial value of the filter. | ExtendedSparkDataGrid | |
| setFocusOnNextFocusableFilterControl():Boolean
Sets the focus on the next focusable filter control, starting at column index 0. | ExtendedSparkDataGrid | |
| setGridPreferencesInfo(val:GridPreferencesInfo, applyPreferences:Boolean = true):void
Sets the multiple preferences array. | ExtendedSparkDataGrid | |
setResizableColumns(val:Boolean):void | ExtendedSparkPrintDataGrid | ||
| showPopup(popupData:Object):Object
Launches the actual popup. | ExtendedSparkDataGrid | |
| showSpinner():void
Shows the spinner with default values defined below:
Label: "Loading please wait"
X Position : center X of the grid
Y Position : center Y of the grid
Grid Alpa when the spinner is active : 0.3
Spinner appearance can be modified using styles . | ExtendedSparkDataGrid | |
| showToaster(message:String, toasterPosition:String = BOTTOM_RIGHT, toasterRenderer:IFactory = null, animationDuration:Number = 1000, visibleDuration:Number = 5000, moveAnimate:Boolean = true, fadeAnimate:Boolean = true):void [override] | ExtendedSparkDataGrid | |
| Method | Defined By | ||
|---|---|---|---|
| adjustSelectionUponNavigation(event:KeyboardEvent):Boolean [override] | ExtendedSparkDataGrid | |
| commitProperties():void [override] | ExtendedSparkDataGrid | |
| createMenuItems():void | ExtendedSparkDataGrid | |
|
returns UserSettingsOptions.create(this);
| ExtendedSparkDataGrid | |
| filterPageSort(rebuildPageIndex:Boolean, recalculateTotal:Boolean):void
In client mode, whenever there is a filter or a page or a sort, we basically
so the filter, then do the sort, and then apply the page
(which is really a filter on the page index)
| ExtendedSparkDataGrid | |
| getPeristenceKey():String | ExtendedSparkDataGrid | |
| initializeGrid():void | ExtendedSparkDataGrid | |
| keyDownHandler(event:KeyboardEvent):void [override] | ExtendedSparkDataGrid | |
| onCellContextMenuItemClick(event:ContextMenuEvent):void
Method to handle the click for the copy cell menu item
Copies the current cell in tab delimited format into the clipboard
| ExtendedSparkDataGrid | |
| onCollectionChange(event:Event):void | ExtendedSparkDataGrid | |
| onContextMenuShown(event:ContextMenuEvent):void | ExtendedSparkDataGrid | |
| onHeaderRelease(evt:GridEvent):void
Need to handle the sort manually, because in client mode,
we are sorting all the pages. | ExtendedSparkDataGrid | |
| onItemRollover(event:ListEvent):void
For popup support, we keep track of what the
user is hovering over. | ExtendedSparkDataGrid | |
| onRowContextMenuItemClick(event:ContextMenuEvent):void
Adds the copy menu
| ExtendedSparkDataGrid | |
| onTableContextMenuItemClick(event:ContextMenuEvent):void
Method to handle the click for the copy table menu item
Copies the current page in tab delimited format into the clipboard
| ExtendedSparkDataGrid | |
partAdded(partName:String, instance:Object):void [override] | ExtendedSparkPrintDataGrid | ||
| placeSort():void
Places the sort icon
| SEdgBase | |
| redrawHeaderAndFooter(event:Event):void | ExtendedSparkDataGrid | |
| selectAllCheckBoxes():void | ExtendedSparkDataGrid | |
| setPreferences(arrayCollection:ArrayCollection):void
Takes an array collection of preferences and applies them to the grid. | ExtendedSparkDataGrid | |
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| headerHeight | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesheaderHeight:Number [read-only] public function get headerHeight():Number| printListItems | property |
printListItems:Array [read-only] public function get printListItems():Array| rowCount | property |
rowCount:int [read-only] [override] public function get rowCount():int| validNextPage | property |
validNextPage:Boolean [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.1 |
Indicates the data provider contains additional data rows that follow the rows that the PrintDataGrid control currently displays.
public function get validNextPage():Boolean| ExtendedSparkPrintDataGrid | () | Constructor |
public function ExtendedSparkPrintDataGrid()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
| gotoRow | () | method |
public function gotoRow(rowIndex:int):voidIn addition to the basic nextPage function, we provide the gotoRow so user can easily jump back and forth on the preview window
Parameters
rowIndex:int |
| nextPage | () | method |
public function nextPage():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, 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).
| partAdded | () | method |
override protected function partAdded(partName:String, instance:Object):voidParameters
partName:String | |
instance:Object |
| setResizableColumns | () | method |
public function setResizableColumns(val:Boolean):voidParameters
val:Boolean |