Class \Prado\Web\UI\ActiveControls\TTimeTriggeredCallback

TTimeTriggeredCallback class.

TTimeTriggeredCallback sends callback request every \Prado\Web\UI\ActiveControls\setInterval seconds. Upon each callback request, the \Prado\Web\UI\ActiveControls\onCallback event is raised.

The timer can be started by calling startTimer() and stopped using stopTimer(). The timer can be automatically started when \Prado\Web\UI\ActiveControls\setStartTimerOnLoad is true.

Class hierarchy

\Prado\Web\UI\ActiveControls\TTimeTriggeredCallback

\Prado\Web\UI\ActiveControls\TCallback implements IActiveControl, ICallbackEventHandler

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

\Prado\TApplicationComponent

\Prado\TComponent

Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.1

Methods summary
`public`	`getInterval() : float`
`public`	`getStartTimerOnLoad() : bool`
`public`	`render(THtmlWriter $writer) : mixed` Registers the javascript code for initializing the active control.
`public`	`setInterval(float $value) : mixed`
`public`	`setStartTimerOnLoad(bool $value) : mixed`
`public`	`startTimer() : mixed` Registers the javascript code to start the timer.
`public`	`stopTimer() : mixed` Registers the javascript code to stop the timer.
`protected`	`getClientClassName() : string`
`protected`	`getTriggerOptions() : array<string\|int, 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, clearViewState, convertUniqueIdToClientId, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getActiveControl, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getClientID, getClientSide, getControls, getCustomData, getEnabled, getEnableTheming, getEnableViewState, getEventHandlers, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getSubProperty, getTemplateControl, getUniqueID, getUser, getViewState, getVisible, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onCallback, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseCallbackEvent, raiseEvent, registerObject, removeAttribute, removedControl, render, renderChildren, renderControl, saveState, setAdapter, setAttribute, setCustomData, setEnabled, setEnableTheming, setEnableViewState, setID, setPage, setSkinID, setSubProperty, setTemplateControl, setViewState, setVisible, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

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\ActiveControls\TTimeTriggeredCallback

Class hierarchy