import PagerControl from 'flexicious-react-datagrid/js/flexgrid/toolbar/PagerControlAS.js'

public class | source

PagerControl

Extends:

react~React.Component → EventDispatcher → UIComponent → PagerControl

A JavaScript only version of the Pager control that significantly cuts down on initialization time. It does so by using pure ActionScript opposed to MXML, not using as many nested HBoxes, and not using plain events instead databindings to modify appearance.

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	children: undefined[]
public	grid: *
public	level: *
public	linesep: number
public	rowInfo: *

Method Summary

Public Methods
public	addToolbarActionsHTML(): *
public	componentDidMountCustom()
public	createToolbarActions()
public	destroy()
public	destroyButtons(arr: *)
public	enableDisableButton(button: , enabled: )
public	getClassNames(): string[]
public	getPageCount(): *
public	getPageDropdown(): *
public	getPageEnd(): *
public	getPageIndex(): *
public	getPageSize(): *
public	getPageStart(): *
public	getTotalRecords(): *
public	initializeButtons(arr: *)
public	kill()
public	onClearFilter() Default handler for the Clear Filter Button.
public	onCreationComplete(event: *)
public	onExcelExport() Default handler for the Word Export Button.
public	onGridSelectionChange(event: *)
public	onImgFirstClick() Default handler for the First Page Navigation Button
public	onImgLastClick() Default handler for the Last Page Navigation Button
public	onImgNextClick() Default handler for the Next Page Navigation Button
public	onImgPreviousClick() Default handler for the Previous Page Navigation Button
public	onOpenSettingsPopup() Default handler for the OPen Settings Popup Calls var popup:OpenSettingsPopup=new OpenSettingsPopup();UIUtils.addPopUp(popup,grid as DisplayObject);popup.grid=grid;
public	onPageCbxChange(event: *) Default handler for the Page Change Combo Box
public	onPageChanged() Default handler for the Page Change Event
public	onPdf() Default handler for the Print Button.
public	onPrint() Default handler for the Print Button.
public	onProcessFilter() Default handler for the Process Filter Button.
public	onSaveSettingsPopup() Default handler for the Save Settings Popup Calls var popup:SaveSettingsPopup=new SaveSettingsPopup();UIUtils.addPopUp(popup,grid as DisplayObject);popup.grid=grid;
public	onShowHideFilter() Default handler for the Show Hide Filter Button.
public	onShowHideFooter() Default handler for the Show Hide Filter Button.
public	onShowSettingsPopup() Default handler for the Settings Popup Calls var popup:SaveSettingsPopup=new SaveSettingsPopup();UIUtils.addPopUp(popup,grid as DisplayObject);popup.grid=grid;
public	onToolbarActionsChanged(event: *)
public	onWordExport() Default handler for the Word Export Button.
public	processAction(code: *)
public	rebuild()
public	refresh()
public	render(): *
public	reset() Sets the page index to 1(0), dispatches the reset event.
public	setPageIndex(val: *)
public	setPageSize(val: *)
public	setTotalRecords(val: *)
public	toolbarActionFilterFunction(item: ):
public	updateDisplayList(w: , h: )

Inherited Summary

From class EventDispatcher
public	[prop]: *
public	dead: boolean
public	eventListeners: Array A list of event listeners for this event dispatcher object.
public	typeCache: {}
public	addEventListener(context: , type: , listener: *) Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
public	constructed()
public	dispatchEvent(event: *): boolean Dispatches an event into the event flow.
public	getClassNames(): string[]
public	getStyle(prop: ): Gets the value of the prop property on this object
public	hasEventListener(type: *): Boolean Returns true if an event listener exists
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.
public	kill() Removes all event listeners
public	killArray(arr: *) Given an array of event dispatchers, calls the kill method on each of them.
public	removeEventListener(type: , listener: ) Removes a listener from the EventDispatcher object.
public	setStyle(prop: , val: ) Sets the value of the prop property on this object

From class UIComponent
public static	clearPendingUpdates()
public static	flushPendingUpdates()
public	childIndex: number
public	children: *[]
public	childrenWithProps: *[]
public	data: * This is a getter/setter for the data property.
public	domElement: HTMLElement The dom element associated with this UIComponent.
public	domListeners: Array A list of event listeners that are added to the domElement (these create html dom event listeners as opposed to js only event listeners)
public	enabled: boolean Whether or not this control is enabled.
public	errorString: *
public	handCursor: *
public	height: number
public	horizontalScrollPolicy: *
public	includeInLayout: boolean
public	initialized: boolean
public	innerHTML: string
public	invalid: Boolean A flag to store if this object has been marked for invalidation.
public	oldDisplay: *
public	parent: *
public	propertyBag: {}
public	props: *
public	reactElement: ReactElement The react element associated with this UIComponent.
public	state: *
public	tagName: *
public	toolTip: *
public	verticalScrollPolicy: *
public	visible: boolean Whether or not this control is enabled.
public	width: number
public	x: *
public	y: *
public	addChild(child: *) This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
public	addChildAt(child: , idx: ) This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
public	addDomEventListener(evt: , f: ) When you call addEventListener on a UIComponent, certain events, defined by the domEvents array are also associated with the corresponding domElement.
public	addEventListener(context: , type: , listener: *) Calls super.addEventListener, and for dom based events, also adds a HTML Event listener
public	attachClass(newClass: *)
public	componentDidMount()
public	componentWillMount()
public	componentWillReceiveProps(nextProps: *)
public	componentWillUnmount()
public	componentWillUpdate()
public	detachClass(newClass: *)
public	domEventFired(event: *) The event handler that gets triggered from the HTML DOM.
public	focus()
public	getAllChildren(): *
public	getAttribute(attr: ):
public	getAutomationName(): *
public	getChildAt(idx: ): Returns the child of the domElement at the specified index.
public	getClassNames(): string[]
public	getComponentStyleAttribute(attr: ):
public	getData(): * This is a getter/setter for the data property.
public	getElementByTagName(tag: ):
public	getEnabled(): * Sets the enabled flag
public	getErrorString(val: ):
public	getHandCursor(): *
public	getHandCursor(): *
public	getHeight(): *
public	getHorizontalScrollPolicy(): *
public	getHorizontalScrollPosition(): *
public	getIncludeInLayout(val: ):
public	getInnerHTML(): * Getter for the innerHTML property
public	getPixelHeight(): *
public	getStyleAttribute(attr: ):
public	getText(): * Getter for the text property
public	getVerticalScrollPolicy(): *
public	getVerticalScrollPosition(): *
public	getVisible(val: ): Sets the visible flag
public	getWidth(): *
public	getX(): * Gets the X co ordinate
public	getY(): * Gets the Y co ordinate
public	globalToLocal(ptIn: *): flexiciousNmsp.Point Converts the given global Point to local co-ordinates.
public	initFromProps(props: *)
public	initialize() Any initialization code is supposed to go in this method.
public	invalidateDisplayList() This method will queue the component so the display list will render it once the current frame of execution is over.
public	kill() First, calls super.kill(), which takes out all event listeners.
public	localToGlobal(ptIn: *): flexiciousNmsp.Point Converts the given local Point to global co-ordinates.
public	measureText(textToMeasure: ): {"width": } Returns the width of the given text.
public	mergeObjects(obj1: , obj2: ): *
public	move(x: , y: ) Sets the X and Y co ordinates of the current dom element
public	numChildren(): * Gets the number of children of the dom element associated with this UIComponent.
public	owns(elem: *): Boolean Recursively iterates through the parent hierarchy of the given element to check to see if the current node is in its parent hierarchy.
public	ownsPoint(pt: *): boolean
public	removeAllChildren(child: *)
public	removeChild(child: *) This methods takes another UIComponent object, and removes it from the dom.
public	removeChildAt(idx: *) This methods takes another UIComponent object, and removes it from the dom.
public	removeComponentAttribute(attr: *)
public	removeDomEventListener(evt: , f: ) Removes a previously attached DOM event listener.
public	removeEventListener(type: , listener: ) Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
public	removeEventListenerKeepDomListener(type: , listener: ) Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
public	render(): *
public	setActualSize(w: , h: )
public	setActualSizeFromDomElement()
public	setAttribute(attr: , val: )
public	setAutomationName(val: *)
public	setChildIndex(child: , index: ) Sets the visible flag
public	setComponentStyleAttribute(attr: , val: )
public	setData(val: *) This is important, because the grid looks for a "setData" method on the renderer.
public	setDomElement(elem: *) Sets the domElement of this UIComponent to the specified element, and creates a property on the dom element called component to this.
public	setEnabled(val: *) Sets the enabled flag
public	setErrorString(val: *)
public	setHandCursor(val: *)
public	setHeight(val: ):
public	setHorizontalScrollPolicy(policy: *)
public	setHorizontalScrollPosition(val: ):
public	setIncludeInLayout(val: *)
public	setInnerHTML(val: *) Setter for the innerHTML property
public	setState(newState: *)
public	setStateIfDomPresent(state: , db: )
public	setStateInternal(newState: *)
public	setStyleAttribute(attr: , val: )
public	setText(val: *) Setter for the text property
public	setToolTip(val: *)
public	setVerticalScrollPolicy(policy: *)
public	setVerticalScrollPosition(val: ):
public	setVisible(val: *) Sets the visible flag
public	setWidth(val: ):
public	setX(val: ): Sets the X co ordinate
public	setY(val: ): Sets the Y co ordinate
public	updateDisplayList(w: , h: ) Called as a part of render phase.
public	validateNow()
public	validateNowIfValid()

Public Constructors

public constructor() source

Override:

UIComponent#constructor

Public Members

public children: undefined[] source

Override:

UIComponent#children

public grid: * source

public level: * source

public linesep: number source

public rowInfo: * source

Public Methods

public addToolbarActionsHTML(): * source

Return:

public componentDidMountCustom() source

public createToolbarActions() source

public destroy() source

public destroyButtons(arr: *) source

Params:

Name	Type	Attribute	Description
arr	*

public enableDisableButton(button: , enabled: ) source

Params:

Name	Type	Attribute	Description
button	*
enabled	*

public getClassNames(): string[] source

Override:

UIComponent#getClassNames

Return:

string[]

public getPageCount(): * source

Return:

public getPageDropdown(): * source

Return:

public getPageEnd(): * source

Return:

public getPageIndex(): * source

Return:

public getPageSize(): * source

Return:

public getPageStart(): * source

Return:

public getTotalRecords(): * source

Return:

public initializeButtons(arr: *) source

Params:

Name	Type	Attribute	Description
arr	*

public kill() source

First, calls super.kill(), which takes out all event listeners. Then, removes all the dom event listeners that we add. Then, wipes out the reference on the domElement. Then, wipes out the domElement reference. Finally, removes itself from the display list if its pending validation.

Override:

UIComponent#kill

public onClearFilter() source

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

public onCreationComplete(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public onExcelExport() source

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

public onGridSelectionChange(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public onImgFirstClick() source

Default handler for the First Page Navigation Button

public onImgLastClick() source

Default handler for the Last Page Navigation Button

public onImgNextClick() source

Default handler for the Next Page Navigation Button

public onImgPreviousClick() source

Default handler for the Previous Page Navigation Button

public onOpenSettingsPopup() source

Default handler for the OPen Settings Popup Calls var popup:OpenSettingsPopup=new OpenSettingsPopup();UIUtils.addPopUp(popup,grid as DisplayObject);popup.grid=grid;

public onPageCbxChange(event: *) source

Default handler for the Page Change Combo Box

Params:

Name	Type	Attribute	Description
event	*

public onPageChanged() source

Default handler for the Page Change Event

public onPdf() source

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

public onPrint() source

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

public onProcessFilter() source

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

public onSaveSettingsPopup() source

Default handler for the Save Settings Popup Calls var popup:SaveSettingsPopup=new SaveSettingsPopup();UIUtils.addPopUp(popup,grid as DisplayObject);popup.grid=grid;

public onShowHideFilter() source

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

public onShowHideFooter() source

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

public onShowSettingsPopup() source

Default handler for the Settings Popup Calls var popup:SaveSettingsPopup=new SaveSettingsPopup();UIUtils.addPopUp(popup,grid as DisplayObject);popup.grid=grid;

public onToolbarActionsChanged(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public onWordExport() source

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

public processAction(code: *) source

Params:

Name	Type	Attribute	Description
code	*

public rebuild() source

public refresh() source

public render(): * source

Override:

UIComponent#render

Return:

public reset() source

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

public setPageIndex(val: *) source

Params:

Name	Type	Attribute	Description
val	*

public setPageSize(val: *) source

Params:

Name	Type	Attribute	Description
val	*

public setTotalRecords(val: *) source

Params:

Name	Type	Attribute	Description
val	*

public toolbarActionFilterFunction(item: ): source

Params:

Name	Type	Attribute	Description
item	*

Return:

public updateDisplayList(w: , h: ) source

Called as a part of render phase.

Override:

UIComponent#updateDisplayList

Params:

Name	Type	Attribute	Description
w	*
h	*

PagerControl

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public children: undefined[] source

Override:

public grid: * source

public level: * source

public linesep: number source

public rowInfo: * source

Public Methods

public addToolbarActionsHTML(): * source

Return:

public componentDidMountCustom() source

public createToolbarActions() source

public destroy() source

public destroyButtons(arr: *) source

Params:

public enableDisableButton(button: *, enabled: *) source

Params:

public getClassNames(): string[] source

Override:

Return:

public getPageCount(): * source

Return:

public getPageDropdown(): * source

Return:

public getPageEnd(): * source

Return:

public getPageIndex(): * source

Return:

public getPageSize(): * source

Return:

public getPageStart(): * source

Return:

public getTotalRecords(): * source

Return:

public initializeButtons(arr: *) source

Params:

public kill() source

Override:

public onClearFilter() source

public onCreationComplete(event: *) source

Params:

public onExcelExport() source

public onGridSelectionChange(event: *) source

Params:

public onImgFirstClick() source

public onImgLastClick() source

public onImgNextClick() source

public onImgPreviousClick() source

public onOpenSettingsPopup() source

public onPageCbxChange(event: *) source

Params:

public onPageChanged() source

public onPdf() source

public onPrint() source

public onProcessFilter() source

public onSaveSettingsPopup() source

public onShowHideFilter() source

public onShowHideFooter() source

public onShowSettingsPopup() source

public onToolbarActionsChanged(event: *) source

Params:

public onWordExport() source

public processAction(code: *) source

Params:

public rebuild() source

public refresh() source

public render(): * source

Override:

Return:

public reset() source

public setPageIndex(val: *) source

public enableDisableButton(button: , enabled: ) source

public toolbarActionFilterFunction(item: ): source

public updateDisplayList(w: , h: ) source