Class QPaginatorBase

This controls works together with a QPaginatedControl to implement a paginator for that control. Multiple paginators per QPaginatedControl can be declared.

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QPaginatorBase

Direct known subclasses

QPaginator

Abstract
Package: Controls
Located at includes/base_controls/QPaginatorBase.class.php

Methods summary
`public`	# `__construct( QControl\|QControlBase\|QForm $objParentObject, null\|string $strControlId = null )` Constructor method Constructor method Parameters `$objParentObject` `$strControlId` Throws Exception `QCallerException` Overrides `QControlBase::__construct()`
`protected`	# `Setup( )` Setup the proxy events. Setup the proxy events.
`public`	# `ParsePostData( )` ParsePostData parses the value of this control from FormState ParsePostData parses the value of this control from FormState This abstract method must be implemented by all controls. When utilizing formgen, the programmer should never access form variables directly (e.g. via the $_FORM array). It can be assumed that at ANY given time, a control's values/properties will be "up to date" with whatever the webuser has entered in. When a Form is Created via Form::Create(string), the form will go through to check and see if it is a first-run of a form, or if it is a post-back. If it is a postback, it will go through its own private array of controls and call ParsePostData on EVERY control it has. Each control is responsible for "knowing" how to parse the $_POST data to update its own values/properties based on what was returned to via the postback.
`public boolean`	# `Validate( )` Validates the control. Validates the control. For now, it simply returns true Returns boolean
`public`	# `Page_Click( string $strFormId, string $strControlId, string $strParameter )` Respond to the Page_Click event Respond to the Page_Click event Parameters `$strFormId` `$strControlId` `$strParameter`
`public`	# `SetPaginatedControl( QPaginatedControl $objPaginatedControl )` Assign a paginated control to the paginator. Assign a paginated control to the paginator. Parameters `$objPaginatedControl`
`protected string`	# `GetPreviousButtonsHtml( )` Renders the set of previous buttons. This would be whatever comes before the page numbers in the paginator. This particular implementation renders a "Previous" text button, with a separator, and a Rewind button that looks like a number followed by an ellipsis. Renders the set of previous buttons. This would be whatever comes before the page numbers in the paginator. This particular implementation renders a "Previous" text button, with a separator, and a Rewind button that looks like a number followed by an ellipsis. Returns string
`protected string`	# `GetPageButtonHtml( $intIndex )` Return the html for a particular page button. Return the html for a particular page button. Parameters `$intIndex` Returns string
`protected string`	# `GetNextButtonsHtml( )` Returns the HTML for the group of buttons that come after the group of page buttons. Returns the HTML for the group of buttons that come after the group of page buttons. Returns string
`public string`	# `GetControlHtml( )` Returns the HTML for rendering the control Returns the HTML for rendering the control Returns string HTML for the control Throws Exception `QCallerException`
`protected int[]`	# `CalcBunch( )` Calculates the start and end of the center bunch of the paginator. If the start is not 1, then we know we need to add a first page item too. If the end of the bunch is not the last page, then we need to add a last page item. Returns an array that has the start and end of the center bunch. Calculates the start and end of the center bunch of the paginator. If the start is not 1, then we know we need to add a first page item too. If the end of the bunch is not the last page, then we need to add a last page item. Returns an array that has the start and end of the center bunch. Returns int[]
`public`	# `LimitPageNumber( )` After adjusting the total item count, or page size, or other parameters, call this to adjust the page number to make sure it is not off the end. After adjusting the total item count, or page size, or other parameters, call this to adjust the page number to make sure it is not off the end.
`public float`	# `CalcPageCount( )` Calculates the total number of pages for the paginator Calculates the total number of pages for the paginator Returns float Number of pages
`public boolean\|float\|integer\|mixed\|string`	# `__get( string $strName )` PHP magic method to get property value PHP magic method to get property value Parameters `$strName` Name of the property Returns boolean\|float\|integer\|mixed\|string Throws Exception `QCallerException` Overrides `QControlBase::__get()`
`public mixed\|`	# `__set( string $strName, string $mixValue )` PHP magic method to set the value of property of class PHP magic method to set the value of property of class Parameters `$strName` `$mixValue` Returns mixed\| Throws Exception `QCallerException` `QInvalidCastException` Overrides `QControlBase::__set()`

Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetEndScript(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetModelConnectorParams(), GetNonWrappedHtml(), GetState(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), PutState(), Refresh(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderHtmlAttributes(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState()

Methods inherited from QHtmlAttributeManagerBase
`AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected string`	`$strLabelForPrevious` Label for the 'Previous' link Label for the 'Previous' link	#
`protected string`	`$strLabelForNext` Label for the 'Next' link Label for the 'Next' link	#
`protected integer`	`$intItemsPerPage` Default number of items per page Default number of items per page	# `15`
`protected integer`	`$intPageNumber` Default page number (to begin rendering with) Default page number (to begin rendering with)	# `1`
`protected integer`	`$intTotalItemCount` Default item count for the paginator Default item count for the paginator	# `0`
`protected boolean`	`$blnUseAjax` Should switching the pages happen over AJAX or Server call (page reload) Should switching the pages happen over AJAX or Server call (page reload)	# `true`
`protected QPaginatedControl`	`$objPaginatedControl` The control which is going to be paginated with the paginator The control which is going to be paginated with the paginator	#
`protected string`	`$objWaitIcon` Default Wait Icon to be used Default Wait Icon to be used	# `'default'`
`protected integer`	`$intIndexCount` Number of index items in the paginator to display Number of index items in the paginator to display	# `10`
`protected null\|QControlProxy`	`$prxPagination`	# `null`
`protected boolean`	`$blnIsBlockElement`	# `false`
`protected string`	`$strTag` The tag element inside which the paginator has to be rendered The tag element inside which the paginator has to be rendered	# `'span'`

Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strJavaScripts, $strName, $strPreferredRenderMethod, $strRenderMethod, $strStyleSheets, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Magic properties summary
`public integer`	`$ItemsPerPage` How many items you want to display per page when Pagination is enabled
`public integer`	`$PageNumber` The current page number you are viewing. 1 is the first page, there is no page zero.
`public integer`	`$TotalItemCount` The total number of items in the ENTIRE recordset -- only used when Pagination is enabled
`public boolean`	`$UseAjax` Whether to use ajax in the drawing.
`public mixed`	`$WaitIcon` The wait icon to display
`public integer`	`$IndexCount` The maximum number of page numbers to disply in the paginator
`public read-only integer`	`$PageCount` Current number of pages being represented
`public read-only mixed`	`$PaginatedControl` The paginated control linked to this control

Magic properties inherited from QControlBase
`$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified`

Magic properties inherited from QHtmlAttributeManagerBase
`$AccessKey, $AltText, $BackColor, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $HorizontalAlign, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign, $Width`

Packages

Classes

Traits

Exceptions

Functions

Class QPaginatorBase

Direct known subclasses

Parameters

Throws

Overrides

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Throws

Returns

Returns

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides