Packagecom.flexicious.nestedtreedatagrid.pager
Classpublic class PagerControl
InheritancePagerControl Inheritance mx.containers.HBox
Implements IFixedWidth, IExtendedPager, mx.binding.IBindingClient



Public Properties
 PropertyDefined By
  boxDrilldown : HBox
PagerControl
  boxExport : HBox
PagerControl
  boxFilters : HBox
PagerControl
  boxFooters : HBox
PagerControl
  boxMultiColumnSort : HBox
PagerControl
  boxPaging : HBox
PagerControl
  boxPreferences : HBox
PagerControl
  boxPrint : HBox
PagerControl
  boxToolbarActions : HBox
PagerControl
  BTN_CLEAR_FILTER : ImageButton
PagerControl
  BTN_COLLAPSE_ALL : ImageButton
PagerControl
  BTN_EXCEL : ImageButton
PagerControl
  BTN_EXP_ALL : ImageButton
PagerControl
  BTN_EXP_ONE_DOWN : ImageButton
PagerControl
  BTN_EXP_ONE_UP : ImageButton
PagerControl
  BTN_FILTER : ImageButton
PagerControl
  BTN_FIRST_PAGE : ImageButton
PagerControl
  BTN_FOOTER : ImageButton
PagerControl
  BTN_LAST_PAGE : ImageButton
PagerControl
  BTN_MCS : ImageButton
PagerControl
  BTN_NEXT_PAGE : ImageButton
PagerControl
  BTN_OPEN_PREFS : ImageButton
PagerControl
  BTN_PDF : ImageButton
PagerControl
  BTN_PREFERENCES : ImageButton
PagerControl
  BTN_PREV_PAGE : ImageButton
PagerControl
  BTN_PRINT : ImageButton
PagerControl
  BTN_RUN_FILTER : ImageButton
PagerControl
  BTN_SAVE_PREFS : ImageButton
PagerControl
  BTN_WORD : ImageButton
PagerControl
  cbxPage : ComboBox
PagerControl
  dispatchEvents : Boolean
PagerControl
  grid : IExtendedDataGrid
PagerControl
  horizontalGapNum : Number = 3
PagerControl
  imgButton : Array
PagerControl
  LBL_GOTO_PAGE : Label
PagerControl
  level : FlexDataGridColumnLevel
PagerControl
  nestedGrid : FlexDataGrid
[read-only]
PagerControl
  pageCount : int
[read-only]
PagerControl
  pageEnd : int
[read-only]
PagerControl
  pageIndex : int
PagerControl
  _PagerControl_HBox3 : HBox
PagerControl
  pagerPosition : String
PagerControl
  pageSize : int
PagerControl
  pageStart : int
[read-only]
PagerControl
  repeaterToolbarActions : Repeater
PagerControl
  rowInfo : RowInfo
PagerControl
  totalRecords : int
PagerControl
  width : Number
[override] [write-only]
PagerControl
Protected Properties
 PropertyDefined By
  _toolbarActions : ArrayCollection
PagerControl
Public Methods
 MethodDefined By
  
Constructor.
PagerControl
  
PagerControl
  
Default handler for the Clear Filter Button.
PagerControl
  
onCreationComplete(event:Event):void
PagerControl
  
Default handler for the Word Export Button.
PagerControl
  
Default handler for the First Page Navigation Button
PagerControl
  
Default handler for the Last Page Navigation Button
PagerControl
  
Default handler for the Next Page Navigation Button
PagerControl
  
Default handler for the Previous Page Navigation Button
PagerControl
  
Default handler for the Open Settings Popup Calls var popup:Object=nestedGrid.popupFactoryOpenSettingsPopup.newInstance();UIUtils.addPopUp(popup as IFlexDisplayObject,grid as DisplayObject,true,null,null,grid.useModuleFactory?grid.moduleFactory:null);popup.grid=grid;
PagerControl
  
Default handler for the Page Change Combo Box
PagerControl
  
Default handler for the Page Change Event
PagerControl
  
onPdf():void
Default handler for the Print Button.
PagerControl
  
onPrint():void
Default handler for the Print Button.
PagerControl
  
Default handler for the Process Filter Button.
PagerControl
  
Default handler for the Save Settings Popup Calls var popup:Object=nestedGrid.popupFactorySaveSettingsPopup.newInstance();UIUtils.addPopUp(popup as IFlexDisplayObject,grid as DisplayObject,null,null,grid.useModuleFactory?grid.moduleFactory:null);popup.grid=grid;
PagerControl
  
Default handler for the Show Hide Filter Button.
PagerControl
  
Default handler for the Show Hide Filter Button.
PagerControl
  
Default handler for the Settings Popup Calls var popup:Object=nestedGrid.popupFactorySettingsPopup.newInstance();UIUtils.addPopUp(popup as IFlexDisplayObject,grid as DisplayObject,true,null,null,grid.useModuleFactory?grid.moduleFactory:null);popup.grid=grid;
PagerControl
  
Default handler for the Word Export Button.
PagerControl
  
reset():void
Sets the page index to 1(0), dispatches the reset event.
PagerControl
  
setActualSize(w:Number, h:Number):void
[override]
PagerControl
Protected Methods
 MethodDefined By
  
PagerControl
  
PagerControl
  
onToolbarActionsChanged(event:Event):void
PagerControl
  
onToolbarButtonClick(event:MouseEvent):void
PagerControl
  
onToolbarbuttonCreationComplete(event:FlexEvent):void
PagerControl
Events
 Event Summary Defined By
  PagerControl
  PagerControl
Property Detail
_PagerControl_HBox3property
public var _PagerControl_HBox3:HBox

This property can be used as the source for data binding.

_toolbarActionsproperty 
protected var _toolbarActions:ArrayCollection

This property can be used as the source for data binding.

boxDrilldownproperty 
public var boxDrilldown:HBox

This property can be used as the source for data binding.

boxExportproperty 
public var boxExport:HBox

This property can be used as the source for data binding.

boxFiltersproperty 
public var boxFilters:HBox

This property can be used as the source for data binding.

boxFootersproperty 
public var boxFooters:HBox

This property can be used as the source for data binding.

boxMultiColumnSortproperty 
public var boxMultiColumnSort:HBox

This property can be used as the source for data binding.

boxPagingproperty 
public var boxPaging:HBox

This property can be used as the source for data binding.

boxPreferencesproperty 
public var boxPreferences:HBox

This property can be used as the source for data binding.

boxPrintproperty 
public var boxPrint:HBox

This property can be used as the source for data binding.

boxToolbarActionsproperty 
public var boxToolbarActions:HBox

This property can be used as the source for data binding.

BTN_CLEAR_FILTERproperty 
public var BTN_CLEAR_FILTER:ImageButton

This property can be used as the source for data binding.

BTN_COLLAPSE_ALLproperty 
public var BTN_COLLAPSE_ALL:ImageButton

This property can be used as the source for data binding.

BTN_EXCELproperty 
public var BTN_EXCEL:ImageButton

This property can be used as the source for data binding.

BTN_EXP_ALLproperty 
public var BTN_EXP_ALL:ImageButton

This property can be used as the source for data binding.

BTN_EXP_ONE_DOWNproperty 
public var BTN_EXP_ONE_DOWN:ImageButton

This property can be used as the source for data binding.

BTN_EXP_ONE_UPproperty 
public var BTN_EXP_ONE_UP:ImageButton

This property can be used as the source for data binding.

BTN_FILTERproperty 
public var BTN_FILTER:ImageButton

This property can be used as the source for data binding.

BTN_FIRST_PAGEproperty 
public var BTN_FIRST_PAGE:ImageButton

This property can be used as the source for data binding.

BTN_FOOTERproperty 
public var BTN_FOOTER:ImageButton

This property can be used as the source for data binding.

BTN_LAST_PAGEproperty 
public var BTN_LAST_PAGE:ImageButton

This property can be used as the source for data binding.

BTN_MCSproperty 
public var BTN_MCS:ImageButton

This property can be used as the source for data binding.

BTN_NEXT_PAGEproperty 
public var BTN_NEXT_PAGE:ImageButton

This property can be used as the source for data binding.

BTN_OPEN_PREFSproperty 
public var BTN_OPEN_PREFS:ImageButton

This property can be used as the source for data binding.

BTN_PDFproperty 
public var BTN_PDF:ImageButton

This property can be used as the source for data binding.

BTN_PREFERENCESproperty 
public var BTN_PREFERENCES:ImageButton

This property can be used as the source for data binding.

BTN_PREV_PAGEproperty 
public var BTN_PREV_PAGE:ImageButton

This property can be used as the source for data binding.

BTN_PRINTproperty 
public var BTN_PRINT:ImageButton

This property can be used as the source for data binding.

BTN_RUN_FILTERproperty 
public var BTN_RUN_FILTER:ImageButton

This property can be used as the source for data binding.

BTN_SAVE_PREFSproperty 
public var BTN_SAVE_PREFS:ImageButton

This property can be used as the source for data binding.

BTN_WORDproperty 
public var BTN_WORD:ImageButton

This property can be used as the source for data binding.

cbxPageproperty 
public var cbxPage:ComboBox

This property can be used as the source for data binding.

dispatchEventsproperty 
dispatchEvents:Boolean


Implementation
    public function get dispatchEvents():Boolean
    public function set dispatchEvents(value:Boolean):void
gridproperty 
grid:IExtendedDataGrid

This property can be used as the source for data binding.


Implementation
    public function get grid():IExtendedDataGrid
    public function set grid(value:IExtendedDataGrid):void
horizontalGapNumproperty 
public var horizontalGapNum:Number = 3

This property can be used as the source for data binding.

imgButtonproperty 
public var imgButton:Array

This property can be used as the source for data binding.

LBL_GOTO_PAGEproperty 
public var LBL_GOTO_PAGE:Label

This property can be used as the source for data binding.

levelproperty 
level:FlexDataGridColumnLevel

This property can be used as the source for data binding.


Implementation
    public function get level():FlexDataGridColumnLevel
    public function set level(value:FlexDataGridColumnLevel):void
nestedGridproperty 
nestedGrid:FlexDataGrid  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get nestedGrid():FlexDataGrid
pageCountproperty 
pageCount:int  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get pageCount():int
pageEndproperty 
pageEnd:int  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get pageEnd():int
pageIndexproperty 
pageIndex:int

This property can be used as the source for data binding.


Implementation
    public function get pageIndex():int
    public function set pageIndex(value:int):void
pagerPositionproperty 
pagerPosition:String


Implementation
    public function get pagerPosition():String
    public function set pagerPosition(value:String):void
pageSizeproperty 
pageSize:int


Implementation
    public function get pageSize():int
    public function set pageSize(value:int):void
pageStartproperty 
pageStart:int  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get pageStart():int
repeaterToolbarActionsproperty 
public var repeaterToolbarActions:Repeater

This property can be used as the source for data binding.

rowInfoproperty 
rowInfo:RowInfo

This property can be used as the source for data binding.


Implementation
    public function get rowInfo():RowInfo
    public function set rowInfo(value:RowInfo):void
totalRecordsproperty 
totalRecords:int

This property can be used as the source for data binding.


Implementation
    public function get totalRecords():int
    public function set totalRecords(value:int):void
widthproperty 
width:Number  [write-only] [override]


Implementation
    public function set width(value:Number):void
Constructor Detail
PagerControl()Constructor
public function PagerControl()

Constructor.

Method Detail
createToolbarActions()method
protected function createToolbarActions():void

initializePager()method 
public function initializePager():void

onClearFilter()method 
public function onClearFilter():void

Default handler for the Clear Filter Button. Calls grid.clearFilter()

onCreationComplete()method 
public function onCreationComplete(event:Event):void

Parameters

event:Event

onExcelExport()method 
public function onExcelExport():void

Default handler for the Word Export Button. Calls ExtendedExportController.instance().export(this.grid,ExportOptions.create())

onGridSelectionChange()method 
protected function onGridSelectionChange(event:FlexDataGridEvent):void

Parameters

event:FlexDataGridEvent

onImgFirstClick()method 
public function onImgFirstClick():void

Default handler for the First Page Navigation Button

onImgLastClick()method 
public function onImgLastClick():void

Default handler for the Last Page Navigation Button

onImgNextClick()method 
public function onImgNextClick():void

Default handler for the Next Page Navigation Button

onImgPreviousClick()method 
public function onImgPreviousClick():void

Default handler for the Previous Page Navigation Button

onOpenSettingsPopup()method 
public function onOpenSettingsPopup():void

Default handler for the Open Settings Popup Calls var popup:Object=nestedGrid.popupFactoryOpenSettingsPopup.newInstance();UIUtils.addPopUp(popup as IFlexDisplayObject,grid as DisplayObject,true,null,null,grid.useModuleFactory?grid.moduleFactory:null);popup.grid=grid;

onPageCbxChange()method 
public function onPageCbxChange():void

Default handler for the Page Change Combo Box

onPageChanged()method 
public function onPageChanged():void

Default handler for the Page Change Event

onPdf()method 
public function onPdf():void

Default handler for the Print Button. Calls var po:PrintOptions=PrintOptions.create(true); po.printOptionsViewrenderer = new ClassFactory(ExtendedPrintOptionsView); ExtendedPrintController.instance().print(this.grid,po)

onPrint()method 
public function onPrint():void

Default handler for the Print Button. Calls var po:PrintOptions=PrintOptions.create(); po.printOptionsViewrenderer = new ClassFactory(ExtendedPrintOptionsView); ExtendedPrintController.instance().print(this.grid,po)

onProcessFilter()method 
public function onProcessFilter():void

Default handler for the Process Filter Button. Calls grid.processFilter()

onSaveSettingsPopup()method 
public function onSaveSettingsPopup():void

Default handler for the Save Settings Popup Calls var popup:Object=nestedGrid.popupFactorySaveSettingsPopup.newInstance();UIUtils.addPopUp(popup as IFlexDisplayObject,grid as DisplayObject,null,null,grid.useModuleFactory?grid.moduleFactory:null);popup.grid=grid;

onShowHideFilter()method 
public function onShowHideFilter():void

Default handler for the Show Hide Filter Button. Calls this.grid.filterVisible=!this.grid.filterVisible;nestedGrid.placeSections()

onShowHideFooter()method 
public function onShowHideFooter():void

Default handler for the Show Hide Filter Button. Calls this.grid.filterVisible=!this.grid.filterVisible;nestedGrid.placeSections()

onShowSettingsPopup()method 
public function onShowSettingsPopup():void

Default handler for the Settings Popup Calls var popup:Object=nestedGrid.popupFactorySettingsPopup.newInstance();UIUtils.addPopUp(popup as IFlexDisplayObject,grid as DisplayObject,true,null,null,grid.useModuleFactory?grid.moduleFactory:null);popup.grid=grid;

onToolbarActionsChanged()method 
protected function onToolbarActionsChanged(event:Event):void

Parameters

event:Event

onToolbarButtonClick()method 
protected function onToolbarButtonClick(event:MouseEvent):void

Parameters

event:MouseEvent

onToolbarbuttonCreationComplete()method 
protected function onToolbarbuttonCreationComplete(event:FlexEvent):void

Parameters

event:FlexEvent

onWordExport()method 
public function onWordExport():void

Default handler for the Word Export Button. Calls ExtendedExportController.instance().export(this.grid,ExportOptions.create(ExportOptions.DOC_EXPORT))

reset()method 
public function reset():void

Sets the page index to 1(0), dispatches the reset event.

setActualSize()method 
override public function setActualSize(w:Number, h:Number):void

Parameters

w:Number
 
h:Number

Event Detail
pageChange Event
Event Object Type: com.flexicious.nestedtreedatagrid.events.ExtendedFilterPageSortChangeEvent

reset Event