Packages:
default
System
System.Caching
System.Collections
System.Data
System.Data.ActiveRecord
System.Data.ActiveRecord.Relations
System.Data.ActiveRecord.Scaffold
System.Data.ActiveReecord.Scaffold.InputBuilder
System.Data.Commom.Sqlite
System.Data.Common
System.Data.Common.Mssql
System.Data.Common.Mysql
System.Data.Common.Oracle
System.Data.Common.Pgsql
System.Data.Common.Sqlite
System.Data.DataGateway
System.Data.SqlMap
System.Data.SqlMap.Configuration
System.Data.SqlMap.Statements
System.Exceptions
System.I18N
System.IO
System.Security
System.Util
System.Web
System.Web.Services
System.Web.UI
System.Web.UI.ActiveControls
System.Web.UI.WebControls
System.Web.UI.WebControls.assets
System.Xml


Classes:
Keyword

Class TActivePager

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TPager
               |
               --TActivePager

TActivePager is the active control counter part of TPager.

When a page change is requested, TActivePager raises a callback instead of the traditional postback.

The OnCallback event is raised during a callback request and it is raise after the OnPageIndexChanged event.

Since: 3.1.2
Author: "gevik" (forum contributor) and Christophe Boulain (Christophe.Boulain@gmail.com)
Constants Inherited From TPager
CMD_PAGE, CMD_PAGE_FIRST, CMD_PAGE_LAST, CMD_PAGE_NEXT, CMD_PAGE_PREV,
Constants Inherited From TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID,

Constructor Summary
public
Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

Method Summary
protected  void
Builds a dropdown list pager Override parent implementation to build Active dropdown lists.
protected  mixed
createPagerButton ( string $buttonType, boolean $enabled, string $text, string $commandName, string $commandParameter)
Creates a pager button.
TBaseActiveControl
TCallbackClientSide
void
handleCallback ( mixed $sender, TCallbackEventParameter $param)
Event handler to the OnCallback active buttons or active dropdownlist.
void
This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.
void
Raises the callback event. This method is required by ICallbackEventHandler interface.
void
render ( mixed $writer)
Methods Inherited From TPager
TPager::bubbleEvent(), TPager::buildListPager(), TPager::buildNextPrevPager(), TPager::buildNumericPager(), TPager::buildPager(), TPager::createPagerButton(), TPager::getButtonType(), TPager::getControlToPaginate(), TPager::getCurrentPageIndex(), TPager::getFirstPageImageUrl(), TPager::getFirstPageText(), TPager::getIsFirstPage(), TPager::getIsLastPage(), TPager::getLastPageImageUrl(), TPager::getLastPageText(), TPager::getMode(), TPager::getNextPageImageUrl(), TPager::getNextPageText(), TPager::getNumericPageImageUrl(), TPager::getPageButtonCount(), TPager::getPageCount(), TPager::getPageImageUrl(), TPager::getPrevPageImageUrl(), TPager::getPrevPageText(), TPager::listIndexChanged(), TPager::loadState(), TPager::onPageIndexChanged(), TPager::onPreRender(), TPager::render(), TPager::setButtonType(), TPager::setControlToPaginate(), TPager::setCurrentPageIndex(), TPager::setFirstPageImageUrl(), TPager::setFirstPageText(), TPager::setLastPageImageUrl(), TPager::setLastPageText(), TPager::setMode(), TPager::setNextPageImageUrl(), TPager::setNextPageText(), TPager::setNumericPageImageUrl(), TPager::setPageButtonCount(), TPager::setPageCount(), TPager::setPrevPageImageUrl(), TPager::setPrevPageText()
Methods Inherited From TWebControl
TWebControl::addAttributesToRender(), TWebControl::clearStyle(), TWebControl::copyBaseAttributes(), TWebControl::createStyle(), TWebControl::getAccessKey(), TWebControl::getBackColor(), TWebControl::getBorderColor(), TWebControl::getBorderStyle(), TWebControl::getBorderWidth(), TWebControl::getCssClass(), TWebControl::getDisplay(), TWebControl::getFont(), TWebControl::getForeColor(), TWebControl::getHasStyle(), TWebControl::getHeight(), TWebControl::getStyle(), TWebControl::getTabIndex(), TWebControl::getTagName(), TWebControl::getToolTip(), TWebControl::getWidth(), TWebControl::render(), TWebControl::renderBeginTag(), TWebControl::renderContents(), TWebControl::renderEndTag(), TWebControl::setAccessKey(), TWebControl::setBackColor(), TWebControl::setBorderColor(), TWebControl::setBorderStyle(), TWebControl::setBorderWidth(), TWebControl::setCssClass(), TWebControl::setDisplay(), TWebControl::setForeColor(), TWebControl::setHeight(), TWebControl::setStyle(), TWebControl::setTabIndex(), TWebControl::setToolTip(), TWebControl::setWidth()
Methods Inherited From TControl
TControl::addedControl(), TControl::addParsedObject(), TControl::addToPostDataLoader(), TControl::applyStyleSheetSkin(), TControl::autoBindProperty(), TControl::autoDataBindProperties(), TControl::bindProperty(), TControl::broadcastEvent(), TControl::bubbleEvent(), TControl::clearChildState(), TControl::clearControlState(), TControl::clearNamingContainer(), TControl::clearViewState(), TControl::convertUniqueIdToClientId(), TControl::createChildControls(), TControl::createControlCollection(), TControl::dataBind(), TControl::dataBindChildren(), TControl::dataBindProperties(), TControl::ensureChildControls(), TControl::findControl(), TControl::findControlsByID(), TControl::findControlsByType(), TControl::focus(), TControl::getAdapter(), TControl::getAllowChildControls(), TControl::getAttribute(), TControl::getAttributes(), TControl::getChildControlsCreated(), TControl::getClientID(), TControl::getControls(), TControl::getControlStage(), TControl::getControlState(), TControl::getCustomData(), TControl::getEnabled(), TControl::getEnableTheming(), TControl::getEnableViewState(), TControl::getHasAdapter(), TControl::getHasAttributes(), TControl::getHasChildInitialized(), TControl::getHasControls(), TControl::getHasInitialized(), TControl::getHasLoaded(), TControl::getHasLoadedPostData(), TControl::getHasPreRendered(), TControl::getID(), TControl::getNamingContainer(), TControl::getPage(), TControl::getParent(), TControl::getRegisteredObject(), TControl::getSkinID(), TControl::getSourceTemplateControl(), TControl::getTemplateControl(), TControl::getUniqueID(), TControl::getViewState(), TControl::getVisible(), TControl::hasAttribute(), TControl::initRecursive(), TControl::isDescendentOf(), TControl::isObjectRegistered(), TControl::loadRecursive(), TControl::loadState(), TControl::loadStateRecursive(), TControl::onDataBinding(), TControl::onInit(), TControl::onLoad(), TControl::onPreRender(), TControl::onUnload(), TControl::preRenderRecursive(), TControl::raiseBubbleEvent(), TControl::registerObject(), TControl::removeAttribute(), TControl::removedControl(), TControl::render(), TControl::renderChildren(), TControl::renderControl(), TControl::saveState(), TControl::saveStateRecursive(), TControl::setAdapter(), TControl::setAttribute(), TControl::setChildControlsCreated(), TControl::setControlStage(), TControl::setControlState(), TControl::setCustomData(), TControl::setEnabled(), TControl::setEnableTheming(), TControl::setEnableViewState(), TControl::setID(), TControl::setPage(), TControl::setSkinID(), TControl::setTemplateControl(), TControl::setViewState(), TControl::setVisible(), TControl::trackViewState(), TControl::traverseChildControls(), TControl::unbindProperty(), TControl::unloadRecursive(), TControl::unregisterObject(), TControl::__get()
Methods Inherited From TApplicationComponent
TApplicationComponent::getApplication(), TApplicationComponent::getRequest(), TApplicationComponent::getResponse(), TApplicationComponent::getService(), TApplicationComponent::getSession(), TApplicationComponent::getUser(), TApplicationComponent::publishAsset(), TApplicationComponent::publishFilePath()
Methods Inherited From TComponent
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()

Constant Summary

Constructor Details

__construct

public __construct

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.


Method Details

buildListPager

protected void buildListPager ()

Builds a dropdown list pager Override parent implementation to build Active dropdown lists.

Output
Exception

createPagerButton

protected mixed createPagerButton (string $buttonType , boolean $enabled , string $text , string $commandName , string $commandParameter )

Creates a pager button.

Override parent implementation to create, depending on the button type, a TActiveLinkButton, a TActiveButton or a TActiveImageButton may be created.

Input
string$buttonTypebutton type, either LinkButton or PushButton
boolean$enabledwhether the button should be enabled
string$textcaption of the button
string$commandNameCommandName corresponding to the OnCommand event of the button
string$commandParameterCommandParameter corresponding to the OnCommand event of the button
Output
mixed the button instance
Exception

getActiveControl

public TBaseActiveControl getActiveControl ()

Output
TBaseActiveControl standard active control options.
Exception

getClientSide

public TCallbackClientSide getClientSide ()

Output
TCallbackClientSide client side request options.
Exception

handleCallback

public void handleCallback (mixed $sender , TCallbackEventParameter $param )

Event handler to the OnCallback active buttons or active dropdownlist.

This handler will raise the OnCallback event

Input
mixed$sender
TCallbackEventParameter$param
Output
Exception

onCallback

public void onCallback (TCallbackEventParameter $param )

This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.

Input
TCallbackEventParameter$paramevent parameter to be passed to the event handlers
Output
Exception

raiseCallbackEvent

public void raiseCallbackEvent (TCallbackEventParameter $param )

Raises the callback event. This method is required by ICallbackEventHandler interface.

This method is mainly used by framework and control developers.

Input
TCallbackEventParameter$paramthe event parameter
Output
Exception

render

public void render (mixed $writer )

Input
mixed$writer
Output
Exception