## Class TActivePager

Description

Implements interfaces:

- IActiveControl
- ICallbackEventHandler

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
- version: $Id: TActivePager.php 2395 2008-03-10 15:30:37Z tof $
- author: "gevik" (forum contributor) and Christophe Boulain (Christophe.Boulain@gmail.com)

Located in /Web/UI/ActiveControls/TActivePager.php (line 32)

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

Method Summary
TActivePager __construct ()
void buildListPager ()
mixed createPagerButton (string $buttonType, boolean $enabled, string $text, string $commandName, string $commandParameter)
TBaseActiveControl getActiveControl ()
TCallbackClientSide getClientSide ()
void handleCallback (mixed $sender, TCallbackEventParameter $param)
void onCallback (TCallbackEventParameter $param)
void raiseCallbackEvent (TCallbackEventParameter $param)
void render (mixed $writer)
Methods
Constructor __construct (line 39)

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.

- access: public

TActivePager __construct ()

Redefinition of:

TControl::__construct()
  Constructor.

buildListPager (line 91)

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

- access: protected

void buildListPager ()

Redefinition of:

TPager::buildListPager()
  Builds a dropdown list pager

createPagerButton (line 120)

Creates a pager button.

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

- return: the button instance
- access: protected

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

- string $buttonType: button type, either LinkButton or PushButton
- boolean $enabled: whether the button should be enabled
- string $text: caption of the button
- string $commandName: CommandName corresponding to the OnCommand event of the button
- string $commandParameter: CommandParameter corresponding to the OnCommand event of the button

Redefinition of:

TPager::createPagerButton()
  Creates a pager button.

getActiveControl (line 48)

- return: standard active control options.
- access: public

TBaseActiveControl getActiveControl ()
getClientSide (line 57)

- return: client side request options.
- access: public

TCallbackClientSide getClientSide ()
handleCallback (line 174)

Event handler to the OnCallback active buttons or active dropdownlist.

This handler will raise the OnCallback event

- access: public

void handleCallback (mixed $sender, TCallbackEventParameter $param)

- mixed $sender
- TCallbackEventParameter $param

onCallback (line 82)

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.

- access: public

void onCallback (TCallbackEventParameter $param)

- TCallbackEventParameter $param: event parameter to be passed to the event handlers

raiseCallbackEvent (line 69)

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

This method is mainly used by framework and control developers.

- access: public

void raiseCallbackEvent (TCallbackEventParameter $param)

- TCallbackEventParameter $param: the event parameter

render (line 189)

- access: public

void render (mixed $writer)

Redefinition of:

TPager::render()
  Renders the control.

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

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

Inherited From TControl

> TControl::__construct()
> 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()

Inherited From TApplicationComponent

> TApplicationComponent::getApplication()
> TApplicationComponent::getRequest()
> TApplicationComponent::getResponse()
> TApplicationComponent::getService()
> TApplicationComponent::getSession()
> TApplicationComponent::getUser()
> TApplicationComponent::publishAsset()
> TApplicationComponent::publishFilePath()

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

Class Constants

#### Inherited Constants

Inherited from TPager

> TPager::CMD_PAGE
> TPager::CMD_PAGE_FIRST
> TPager::CMD_PAGE_LAST
> TPager::CMD_PAGE_NEXT
> TPager::CMD_PAGE_PREV

Inherited from TControl

> TControl::AUTOMATIC_ID_PREFIX
> TControl::CLIENT_ID_SEPARATOR
> TControl::CS_CHILD_INITIALIZED
> TControl::CS_CONSTRUCTED
> TControl::CS_INITIALIZED
> TControl::CS_LOADED
> TControl::CS_PRERENDERED
> TControl::CS_STATE_LOADED
> TControl::ID_FORMAT
> TControl::ID_SEPARATOR
> TControl::IS_CHILD_CREATED
> TControl::IS_CREATING_CHILD
> TControl::IS_DISABLE_THEMING
> TControl::IS_DISABLE_VIEWSTATE
> TControl::IS_ID_SET
> TControl::IS_SKIN_APPLIED
> TControl::IS_STYLESHEET_APPLIED
> TControl::RF_ADAPTER
> TControl::RF_AUTO_BINDINGS
> TControl::RF_CHILD_STATE
> TControl::RF_CONTROLS
> TControl::RF_CONTROLSTATE
> TControl::RF_DATA_BINDINGS
> TControl::RF_EVENTS
> TControl::RF_NAMED_CONTROLS
> TControl::RF_NAMED_CONTROLS_ID
> TControl::RF_NAMED_OBJECTS
> TControl::RF_SKIN_ID

Documentation generated on Mon, 21 Apr 2008 11:29:34 -0400 by phpDocumentor 1.3.0RC4