com.flexicious.nestedtreedatagrid.pager.PagerControlAS

	Property	Defined By
		dispatchEvents : Boolean During initialization, do not dispatch any events	PagerControlAS
		grid : IExtendedDataGrid The grid object associated with the pager	PagerControlAS
		height : Number [override] [write-only]	PagerControlAS
		iconCollapseAll : Class [static]	PagerControlAS
		iconCollapseOne : Class [static]	PagerControlAS
		iconExpandAll : Class [static]	PagerControlAS
		iconExpandOne : Class [static]	PagerControlAS
		iconExportExcel : Class [static]	PagerControlAS
		iconExportWord : Class [static]	PagerControlAS
		iconFilterClear : Class [static]	PagerControlAS
		iconFilterRun : Class [static]	PagerControlAS
		iconFilterShowHide : Class [static]	PagerControlAS
		iconFirstPage : Class [static]	PagerControlAS
		iconFooterShowHide : Class [static]	PagerControlAS
		iconLastPage : Class [static]	PagerControlAS
		iconMultiColumnSort : Class [static]	PagerControlAS
		iconNextPage : Class [static]	PagerControlAS
		iconOpenSettings : Class [static]	PagerControlAS
		iconPdf : Class [static]	PagerControlAS
		iconPrevPage : Class [static]	PagerControlAS
		iconPrint : Class [static]	PagerControlAS
		iconSaveSettings : Class [static]	PagerControlAS
		iconSettings : Class [static]	PagerControlAS
		level : FlexDataGridColumnLevel The level at which the pager appears	PagerControlAS
		nestedGrid : FlexDataGrid [read-only] The grid object casted as an Ultimate DataGrid	PagerControlAS
		pageCount : int [read-only] Returns the first total number of pages	PagerControlAS
		pageEnd : int [read-only] Returns the last record on the page	PagerControlAS
		pageIndex : int Returns the current page index	PagerControlAS
		pageSize : int Returns the number of records on each page	PagerControlAS
		pageStart : int [read-only] Returns the first record on the page	PagerControlAS
		rowInfo : RowInfo The row info associated with the pager	PagerControlAS
		seperatorFactory : IFactory Factory to use to add the separator UIComponent.	PagerControlAS
		totalRecords : int Returns the total records	PagerControlAS

	Method	Defined By
		PagerControlAS()	PagerControlAS
		dispatchEvent(event:Event):Boolean [override]	PagerControlAS
		initializePager():void	PagerControlAS
		onClearFilter():void Default handler for the Clear Filter Button.	PagerControlAS
		onCreationComplete(event:Event):void	PagerControlAS
		onExcelExport():void Default handler for the Word Export Button.	PagerControlAS
		onImgFirstClick():void Default handler for the First Page Navigation Button	PagerControlAS
		onImgLastClick():void Default handler for the Last Page Navigation Button	PagerControlAS
		onImgNextClick():void Default handler for the Next Page Navigation Button	PagerControlAS
		onImgPreviousClick():void Default handler for the Previous Page Navigation Button	PagerControlAS
		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;	PagerControlAS
		onPageCbxChange():void Default handler for the Page Change Combo Box	PagerControlAS
		onPageChanged():void Default handler for the Page Change Event	PagerControlAS
		onPdf():void Default handler for the Print Button.	PagerControlAS
		onPrint():void Default handler for the Print Button.	PagerControlAS
		onProcessFilter():void Default handler for the Process Filter Button.	PagerControlAS
		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;	PagerControlAS
		onShowHideFilter():void Default handler for the Show Hide Filter Button.	PagerControlAS
		onShowHideFooter():void Default handler for the Show Hide Filter Button.	PagerControlAS
		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;	PagerControlAS
		onWordExport():void Default handler for the Word Export Button.	PagerControlAS
		reBuild():void Removes all existing controls, creates new controls on basis of the various enableflags on the grid and builds the pager	PagerControlAS
		reset():void Sets the page index to 1(0), dispatches the reset event.	PagerControlAS
		setActualSize(x:Number, y:Number):void [override]	PagerControlAS

	Method	Defined By
		addSeparator():void Adds a new instance of the separator factory class.	PagerControlAS
		onMenuItemClick(event:MenuEvent):void	PagerControlAS
		setPageDropdown():void Sets up the goto page dropdown	PagerControlAS
		setPagingButtons():void Sets enabled/disabled on buttons	PagerControlAS
		setPagingLabel():void Sets the text of the paging label	PagerControlAS
		setToolbarActions():void Setsup the toolbar actions	PagerControlAS

	Style	Description	Defined By
		dropDownButtonStyleName	Style Name for the dropdown button	PagerControlAS
		dropDownStyleName	Style Name for the vertical box	PagerControlAS

Property Detail

dispatchEvents

property

dispatchEvents:Boolean

During initialization, do not dispatch any events

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

grid

property

grid:IExtendedDataGrid

The grid object associated with the pager

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

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

height

property

height:Number [write-only] [override]

Implementation
public function set height(value:Number):void

iconCollapseAll

property

public static var iconCollapseAll:Class

iconCollapseOne

property

public static var iconCollapseOne:Class

iconExpandAll

property

public static var iconExpandAll:Class

iconExpandOne

property

public static var iconExpandOne:Class

iconExportExcel

property

public static var iconExportExcel:Class

iconExportWord

property

public static var iconExportWord:Class

iconFilterClear

property

public static var iconFilterClear:Class

iconFilterRun

property

public static var iconFilterRun:Class

iconFilterShowHide

property

public static var iconFilterShowHide:Class

iconFirstPage

property

public static var iconFirstPage:Class

iconFooterShowHide

property

public static var iconFooterShowHide:Class

iconLastPage

property

public static var iconLastPage:Class

iconMultiColumnSort

property

public static var iconMultiColumnSort:Class

iconNextPage

property

public static var iconNextPage:Class

iconOpenSettings

property

public static var iconOpenSettings:Class

iconPdf

property

public static var iconPdf:Class

iconPrevPage

property

public static var iconPrevPage:Class

iconPrint

property

public static var iconPrint:Class

iconSaveSettings

property

public static var iconSaveSettings:Class

iconSettings

property

public static var iconSettings:Class

level

property

level:FlexDataGridColumnLevel

The level at which the pager appears

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

Implementation
public function get level():FlexDataGridColumnLevel
public function set level(value:FlexDataGridColumnLevel):void

nestedGrid

property

nestedGrid:FlexDataGrid [read-only]

The grid object casted as an Ultimate DataGrid

Implementation
public function get nestedGrid():FlexDataGrid

pageCount

property

pageCount:int [read-only]

Returns the first total number of pages

Implementation
public function get pageCount():int

pageEnd

property

pageEnd:int [read-only]

Returns the last record on the page

Implementation
public function get pageEnd():int

pageIndex

property

pageIndex:int

Returns the current page index

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

pageSize

property

pageSize:int

Returns the number of records on each page

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

pageStart

property

pageStart:int [read-only]

Returns the first record on the page

Implementation
public function get pageStart():int

rowInfo

property

rowInfo:RowInfo

The row info associated with the pager

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

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

seperatorFactory

property

public var seperatorFactory:IFactory

Factory to use to add the separator UIComponent. Defaults to a label with a pipe

totalRecords

property

totalRecords:int

Returns the total records

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

Constructor Detail

PagerControlAS

()

Constructor

public function PagerControlAS()

Method Detail

addSeparator

()

method

protected function addSeparator():void

Adds a new instance of the separator factory class.

dispatchEvent

()

method

override public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns

Boolean

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())

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

onMenuItemClick

()

method

protected function onMenuItemClick(event:MenuEvent):void

Parameters

event:MenuEvent

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;

onWordExport

()

method

public function onWordExport():void

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

reBuild

()

method

public function reBuild():void

Removes all existing controls, creates new controls on basis of the various enableflags on the grid and builds the pager

reset

()

method

public function reset():void

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

setActualSize

()

method

override public function setActualSize(x:Number, y:Number):void

Parameters

	`x:Number`

	`y:Number`

setPageDropdown

()

method

protected function setPageDropdown():void

Sets up the goto page dropdown

setPagingButtons

()

method

protected function setPagingButtons():void

Sets enabled/disabled on buttons

setPagingLabel

()

method

protected function setPagingLabel():void

Sets the text of the paging label

setToolbarActions

()

method

protected function setToolbarActions():void

Setsup the toolbar actions

Mon Jun 24 2013, 11:00 PM -04:00

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
PagerControlAS	Properties \| Methods \| Styles

Package	com.flexicious.nestedtreedatagrid.pager
Class	public class PagerControlAS
Inheritance	PagerControlAS mx.containers.HBox
Implements	IExtendedPager