Class TTimeTriggeredCallback

Description

TTimeTriggeredCallback class.

TTimeTriggeredCallback sends callback request every Interval seconds. Upon each callback request, the OnCallback event is raised.

The timer can be started by calling startTimer() and stopped using stopTimer(). The timer can be automatically started when StartTimerOnLoad is true.

  • since: 3.1
  • version: $Id: TTimeTriggeredCallback.php 1568 2006-12-09 09:17:22Z wei $
  • author: Wei Zhuo <weizhuo[at]gmail[dot]com>

Located in /Web/UI/ActiveControls/TTimeTriggeredCallback.php (line 33)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TCallback
            |
            --TTimeTriggeredCallback
Method Summary
string getClientClassName ()
float getInterval ()
boolean getStartTimerOnLoad ()
void render (THtmlWriter $writer)
void setInterval (float $value)
void setStartTimerOnLoad (boolean $value)
void startTimer ()
void stopTimer ()
Methods
getClientClassName (line 120)
  • return: corresponding javascript class name for TTimeTriggeredCallback.
  • access: protected
string getClientClassName ()
getInterval (line 38)
  • return: seconds between callback requests. Default is 1 second.
  • access: public
float getInterval ()
getStartTimerOnLoad (line 88)
  • return: true to start the timer when page loads.
  • access: public
boolean getStartTimerOnLoad ()
getTriggerOptions (line 96)
  • return: list of timer options for client-side.
  • access: protected
array getTriggerOptions ()
render (line 108)

Registers the javascript code for initializing the active control.

  • access: public
void render (THtmlWriter $writer)

Redefinition of:
TControl::render()
Renders the control.
setInterval (line 46)
  • access: public
void setInterval (float $value)
  • float $value: seconds between callback requests, must be a positive number, default is 1 second.
setStartTimerOnLoad (line 79)
  • access: public
void setStartTimerOnLoad (boolean $value)
  • boolean $value: true to start the timer when page loads.
startTimer (line 57)

Registers the javascript code to start the timer.

  • access: public
void startTimer ()
stopTimer (line 68)

Registers the javascript code to stop the timer.

  • access: public
void stopTimer ()

Inherited Methods

Inherited From TCallback

TCallback::__construct()
TCallback::getActiveControl()
TCallback::getClientSide()
TCallback::onCallback()
TCallback::raiseCallbackEvent()

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

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