Class \Prado\Web\UI\WebControls\TPager

TPager class.

TPager creates a pager that provides UI for end-users to interactively specify which page of data to be rendered in a TDataBoundControl-derived control, such as TDataList, TRepeater, TCheckBoxList, etc. The target data-bound control is specified by \Prado\Web\UI\WebControls\setControlToPaginate, which must be the ID path of the target control reaching from the pager's naming container. Note, the target control must have its \Prado\Web\UI\WebControls\TDataBoundControl::setAllowPaging set to true.

TPager can display three different UIs, specified via \Prado\Web\UI\WebControls\setMode:

NextPrev: a next page and a previous page button are rendered.
Numeric: a list of page index buttons are rendered.
List: a dropdown list of page indices are rendered.

When the pager mode is either NextPrev or Numeric, the paging buttons may be displayed in three types by setting \Prado\Web\UI\WebControls\setButtonType:

LinkButton: a hyperlink button
PushButton: a normal button
ImageButton: an image button (please set XXXPageImageUrl properties accordingly to specify the button images.)

Since Prado 3.2.1, you can use the \Prado\Web\UI\WebControls\setButtonCssClass property to specify a css class that will be applied to each button created by the pager in NextPrev or Numeric mode.

TPager raises an \Prado\Web\UI\WebControls\onPageIndexChanged event when the end-user interacts with it and specifies a new page (e.g. clicking on a page button that leads to a new page.) The new page index may be obtained from the event parameter's property \Prado\Web\UI\WebControls\TPagerPageChangedEventParameter::getNewPageIndex. Normally, in the event handler, one can set the \Prado\Web\UI\WebControls\TDataBoundControl::getCurrentPageIndex to this new page index so that the new page of data is rendered.

Multiple pagers can be associated with the same data-bound control.

Class hierarchy

\Prado\Web\UI\WebControls\TPager implements INamingContainer

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0.2

Methods summary
`public`	`bubbleEvent(TControl $sender, TEventParameter $param) : bool` Processes a bubbled event. This method overrides parent's implementation by wrapping event parameter for OnCommand event with item information.
`public`	`getButtonCssClass() : string`
`public`	`getButtonType() : TPagerButtonType`
`public`	`getControlToPaginate() : string`
`public`	`getCurrentPageIndex() : int`
`public`	`getFirstPageImageUrl() : string`
`public`	`getFirstPageText() : string`
`public`	`getIsFirstPage() : bool`
`public`	`getIsLastPage() : bool`
`public`	`getLastPageImageUrl() : string`
`public`	`getLastPageText() : string`
`public`	`getMode() : TPagerMode`
`public`	`getNextPageImageUrl() : string`
`public`	`getNextPageText() : string`
`public`	`getNumericPageImageUrl() : string`
`public`	`getPageButtonCount() : int`
`public`	`getPageCount() : int`
`public`	`getPrevPageImageUrl() : string`
`public`	`getPrevPageText() : string`
`public`	`listIndexChanged(TDropDownList $sender, TEventParameter $param) : mixed` Event handler to the OnSelectedIndexChanged event of the dropdown list. This handler will raise \Prado\Web\UI\WebControls\onPageIndexChanged event.
`public`	`loadState() : mixed` Restores the pager state. This method overrides the parent implementation and is invoked when the control is loading persistent state.
`public`	`onPageIndexChanged(TPagerPageChangedEventParameter $param) : mixed` This event is raised when page index is changed due to a page button click.
`public`	`onPreRender(Traversable $param) : mixed` Performs databinding to populate data items from data source. This method is invoked by dataBind(). You may override this function to provide your own way of data population.
`public`	`render(THtmlWriter $writer) : mixed` Renders the control. The method overrides the parent implementation by rendering the pager only when there are two or more pages.
`public`	`setButtonCssClass(string $value) : mixed`
`public`	`setButtonType(TPagerButtonType $value) : mixed`
`public`	`setControlToPaginate(string $value) : mixed` Sets the ID path of the control whose content would be paginated. The ID path is the dot-connected IDs of the controls reaching from the pager's naming container to the target control.
`public`	`setFirstPageImageUrl(string $value) : mixed`
`public`	`setFirstPageText(string $value) : mixed`
`public`	`setLastPageImageUrl(string $value) : mixed`
`public`	`setLastPageText(string $value) : mixed`
`public`	`setMode(TPagerMode $value) : mixed`
`public`	`setNextPageImageUrl(string $value) : mixed`
`public`	`setNextPageText(string $value) : mixed`
`public`	`setNumericPageImageUrl(string $value) : mixed` Sets the image URL for the numeric page buttons. This is actually a template for generating a set of URLs corresponding to numeric button 1, 2, 3, .., etc. Use {0} as the placeholder for the numbers. For example, the image URL http://example.com/images/button{0}.gif will be replaced as http://example.com/images/button1.gif, http://example.com/images/button2.gif, etc.
`public`	`setPageButtonCount(int $value) : mixed`
`public`	`setPrevPageImageUrl(string $value) : mixed`
`public`	`setPrevPageText(string $value) : mixed`
`protected`	`buildListPager() : mixed` Builds a dropdown list pager
`protected`	`buildNextPrevPager() : mixed` Builds a next-prev pager
`protected`	`buildNumericPager() : mixed` Builds a numeric pager
`protected`	`buildPager() : mixed` Builds the pager content based on the pager mode. Current implementation includes building 'NextPrev', 'Numeric' and 'DropDownList' pagers. Derived classes may override this method to provide additional pagers.
`protected`	`createPagerButton(string $buttonType, bool $enabled, string $text, string $commandName, string $commandParameter) : mixed` Creates a pager button. Depending on the button type, a TLinkButton or a TButton may be created. If it is enabled (clickable), its command name and parameter will also be set. Derived classes may override this method to create additional types of buttons, such as TImageButton.
`protected`	`getPageImageUrl(string $text, string $commandName) : mixed`
`protected`	`setCurrentPageIndex(int $value) : mixed`
`protected`	`setPageCount(int $value) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`CMD_PAGE` Command name that TPager understands.	`'Page'`
`public mixed`	`CMD_PAGE_FIRST`	`'First'`
`public mixed`	`CMD_PAGE_LAST`	`'Last'`
`public mixed`	`CMD_PAGE_NEXT`	`'Next'`
`public mixed`	`CMD_PAGE_PREV`	`'Previous'`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TPager

Class hierarchy