| Package | com.flexicious.lic |
| Class | public class SEdgBase |
| Inheritance | SEdgBase  spark.components.DataGrid |
| Subclasses | ExtendedSparkDataGrid |
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 | ||
| 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 | ||
| 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 | ||
| enablePrint : Boolean
A flag that may be used for binding purposes
in the custom pager control. | SEdgBase | ||
| filterPageSortMode : String
The Filter/Page/Sort Mode. | SEdgBase | ||
| 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 | ||
| 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 | ||
| pagerPosition : String
The horizontal positioning of the contents of the pager. | SEdgBase | ||
| 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 | ||
| showSpinnerOnFilterPageSort : Boolean
A flag when set, automatically shows the spinner on creation complete and
any filter page or sort operation. | SEdgBase | ||
| unLockedHeader : DataGridHeader [read-only]
Returns the unlocked part of the header
| SEdgBase | ||
| verticalScrollBarOffset : int [read-only]
If the vertical scrollbar is visible, returns the width
of the vertical scroll bar. | SEdgBase | ||
| visibleColumns : Array [read-only]
Returns the visible columns from the unlocked header. | SEdgBase | ||
| Property | Defined By | ||
|---|---|---|---|
| _triggerEvent : Boolean = true
If we're setting filters programatically,
we may not want the filterPageSortChange event
to fire. | SEdgBase | ||
| Method | Defined By | ||
|---|---|---|---|
SEdgBase() | SEdgBase | ||
clearSort():void
Clears out the sort. | SEdgBase | ||
getRowText(item:Object):String
Converts an objects properties into tab delimited format
| SEdgBase | ||
processSort(sorts:ArrayCollection):void
Used by state persistence to load sort settings that were
persisted previously. | SEdgBase | ||
showToaster(message:String, toasterPosition:String = BOTTOM_RIGHT, toasterRenderer:IFactory = null, animationDuration:Number = 1000, visibleDuration:Number = 5000, moveAnimate:Boolean = true, fadeAnimate:Boolean = true):void | SEdgBase | ||
| Method | Defined By | ||
|---|---|---|---|
placeSort():void
Places the sort icon
| SEdgBase | ||
| _triggerEvent | property |
protected var _triggerEvent:Boolean = trueIf we're setting filters programatically, we may not want the filterPageSortChange event to fire. This flag, when set to true will prevent the event from being fired
| additionalFilterArgumentsFunction | property |
additionalFilterArgumentsFunction:FunctionIn scenarios where there are detached filters, this function may be used to add on to the list of arguments before the filter is run. Should no parameters, and return an array collection of the filter expressions
public function get additionalFilterArgumentsFunction():Function public function set additionalFilterArgumentsFunction(value:Function):void| displayOrder | property |
displayOrder:StringA 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. Please note: The way advanced data grid is structured, the header and body are one section, so the "header" is not a valid value for the list of displayOrder objects.
public function get displayOrder():String public function set displayOrder(value:String):void| enableCopy | property |
enableCopy:BooleanA flag that indicates whether or not to show the context menu options to copy the cell,row, or table data
public function get enableCopy():Boolean public function set enableCopy(value:Boolean):void| enableDoubleClickEdit | property |
enableDoubleClickEdit:BooleanEnables or disables keyboard navigation for filters.
public function get enableDoubleClickEdit():Boolean public function set enableDoubleClickEdit(value:Boolean):void| enableExport | property |
enableExport:BooleanA flag that may be used for binding purposes in the custom pager control. This flag does not change any behavior. It defaults to true.
This property can be used as the source for data binding.
public function get enableExport():Boolean public function set enableExport(value:Boolean):void| enableFilters | property |
enableFilters:BooleanA flag that indicates whether or not to show the filters
This property can be used as the source for data binding.
public function get enableFilters():Boolean public function set enableFilters(value:Boolean):void| enableFooters | property |
enableFooters:BooleanA flag that indicates whether or not to show the footer
This property can be used as the source for data binding.
public function get enableFooters():Boolean public function set enableFooters(value:Boolean):void| enableKeyboardNavigation | property |
enableKeyboardNavigation:BooleanEnables or disables keyboard navigation for filters.
public function get enableKeyboardNavigation():Boolean public function set enableKeyboardNavigation(value:Boolean):void| enablePrint | property |
enablePrint:BooleanA flag that may be used for binding purposes in the custom pager control. This flag does not change any behavior. It defaults to true.
This property can be used as the source for data binding.
public function get enablePrint():Boolean public function set enablePrint(value:Boolean):void| filterPageSortMode | property |
filterPageSortMode:StringThe Filter/Page/Sort Mode. Can be either "server" or "client". In client mode, the grid will take care of paging, sorting and filtering once the dataprovider is set. In server mode, the grid will fire a com.flexicious.grids.events.FilterPageSortChangeEvent named filterPageSortChange that should be used to construct an appropriate query to be sent to the backend.
The default value is client.
public function get filterPageSortMode():String public function set filterPageSortMode(value:String):voidSee also
| initialSortAscending | property |
initialSortAscending:BooleanIn 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. This will make the grid draw the sort icon for that column on initial load.
public function get initialSortAscending():Boolean public function set initialSortAscending(value:Boolean):void| initialSortField | property |
initialSortField:StringIf the initial value used to set the dataProvider is sorted by a specific field, set this property to the name of that field. This will make the grid draw the sort icon for that column on initial load.
public function get initialSortField():String public function set initialSortField(value:String):void| lockedColumns | property |
lockedColumns:Array [read-only] Returns columns 0 through x, where x=lockedColumnCount
public function get lockedColumns():Array| lockedColumnWidth | property |
lockedColumnWidth:int [read-only] Returns the width of the locked columns
public function get lockedColumnWidth():int| lockedHeader | property |
lockedHeader:DataGridHeader [read-only] Returns the locked header row
public function get lockedHeader():DataGridHeader| pagerPosition | property |
pagerPosition:StringThe horizontal positioning of the contents of the pager. Please use the displayOrder property to control the vertical positioning Handled by default if you use the built in pager (com.flexicious.grids.columns.footers.PagerControl) , but if you implement your owncom.flexicious.controls.interfaces.IPager, then needs to be handled by you.
public function get pagerPosition():String public function set pagerPosition(value:String):voidSee also
| printExportData | property |
printExportData:ObjectGets the records to print or to export. Only applicable when the filterPageSortMode of the grid is set to server, and the user requests to print all pages or specific pages of data that are not currently loaded.
public function get printExportData():Object public function set printExportData(value:Object):void| printExportParameters | property |
printExportParameters:ObjectAny 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.
public function get printExportParameters():Object public function set printExportParameters(value:Object):void| showSpinnerOnFilterPageSort | property |
showSpinnerOnFilterPageSort:BooleanA flag when set, automatically shows the spinner on creation complete and any filter page or sort operation. Hides automatically on collection reset. Defaults to false. If you wish to manually control when the spinner appears, leave this as false, and call showSpinner and hideSpinner as required.
public function get showSpinnerOnFilterPageSort():Boolean public function set showSpinnerOnFilterPageSort(value:Boolean):void| unLockedHeader | property |
unLockedHeader:DataGridHeader [read-only] Returns the unlocked part of the header
public function get unLockedHeader():DataGridHeader| verticalScrollBarOffset | property |
verticalScrollBarOffset:int [read-only] If the vertical scrollbar is visible, returns the width of the vertical scroll bar.
public function get verticalScrollBarOffset():int| visibleColumns | property |
visibleColumns:Array [read-only] Returns the visible columns from the unlocked header.
public function get visibleColumns():Array| SEdgBase | () | Constructor |
public function SEdgBase()| clearSort | () | method |
public function clearSort():voidClears out the sort.
| getRowText | () | method |
public function getRowText(item:Object):StringConverts an objects properties into tab delimited format
Parameters
item:Object |
String |
| placeSort | () | method |
protected function placeSort():voidPlaces the sort icon
| processSort | () | method |
public function processSort(sorts:ArrayCollection):voidUsed by state persistence to load sort settings that were persisted previously.
Parameters
sorts:ArrayCollection |
| showToaster | () | method |
public function showToaster(message:String, toasterPosition:String = BOTTOM_RIGHT, toasterRenderer:IFactory = null, animationDuration:Number = 1000, visibleDuration:Number = 5000, moveAnimate:Boolean = true, fadeAnimate:Boolean = true):voidParameters
message:String | |
toasterPosition:String (default = BOTTOM_RIGHT) | |
toasterRenderer:IFactory (default = null) | |
animationDuration:Number (default = 1000) | |
visibleDuration:Number (default = 5000) | |
moveAnimate:Boolean (default = true) | |
fadeAnimate:Boolean (default = true) |