Class TActivePager

Description

Implements interfaces:

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.

  • author: "gevik" (forum contributor) and Christophe Boulain (Christophe.Boulain@gmail.com)
  • version: $Id: TActivePager.php 3145 2012-05-19 11:08:20Z ctrlaltca $
  • since: 3.1.2

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)
void handleCallback (mixed $sender, TCallbackEventParameter $param)
void render ( $writer)
Variables

Inherited Variables

Inherited from TWebControl

TWebControl::$_decorator
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 90)

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

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 56)
  • return: client side request options.
  • access: public
TCallbackClientSide getClientSide ()
handleCallback (line 173)

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)
onCallback (line 81)

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)
raiseCallbackEvent (line 68)

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)
render (line 192)
  • access: public
void render ( $writer)
  • $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::getDecorator()
TWebControl::getDisplay()
TWebControl::getEnsureId()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::onPreRender()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setEnsureId()
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::getIsSkinApplied()
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::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()
Class Constants

Documentation generated on Mon, 25 Jun 2012 14:37:07 +0200 by phpDocumentor 1.4.3