Class QJsTimerBase

Timer Control: This control uses a javascript timer to execute Actions after a defined time Periodic or one shot timers are possible. You can add only one type of Event to to this control: QTimerExpiredEvent but multiple actions can be registered for this event

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QJsTimerBase

Direct known subclasses

QJsTimer

Package: Controls
Notes:

ul>

You do not need to render this control!

QTimerExpiredEvent - condition and delay parameters of the constructor are ignored (for now)

Located at includes/base_controls/QJsTimerBase.class.php

Methods summary
`public QJsTimer`	# `__construct( QForm\|QControl $objParentObject, integer $intTime = 0, boolean $blnPeriodic = true, boolean $blnStartNow = true, string $strTimerId = null )` Parameters `$objParentObject` the form or parent control `$intTime` timer interval in ms `$blnPeriodic` if true the timer is "restarted" automatically after it has fired `$blnStartNow` starts the timer automatically after adding the first action `$strTimerId` Returns `QJsTimer` Throws `QCallerException` Overrides `QControlBase::__construct()`
`public`	# `Start( integer $intTime = null )` Parameters `$intTime` (optional) sets the interval/delay, after that the timer executes the registered actions if no parameter is given the time stored in $intDeltaTime is used Throws `QCallerException`
`public`	# `Stop( )` stops the timer stops the timer
`public`	# `AddAction( QEvent $objEvent, QAction $objAction )` Adds an action to the control Adds an action to the control Parameters `$objEvent` has to be an instance of QTimerExpiredEvent `$objAction` Only a QTimerExpiredEvent can be added, but multiple Actions using the same event are possible! Throws `QCallerException` Overrides `QControlBase::AddAction()`
`public array`	# `GetAllActions( string $strEventType, null $strActionType = null )` Returns all actions connected/attached to the timer Returns all actions connected/attached to the timer Parameters `$strEventType` `$strActionType` Returns array Overrides `QControlBase::GetAllActions()`
`public`	# `RemoveAllActions( null $strEventName = null )` Remove all actions attached to the timer Remove all actions attached to the timer Parameters `$strEventName` Overrides `QControlBase::RemoveAllActions()`
`public null\|`	# `GetEvent( )` Returns null\|
`public string`	# `RenderActionScripts( )` Returns all action attributes Returns all action attributes Returns string Overrides `QControlBase::RenderActionScripts()`
`public string`	# `GetEndScript( )` Returns all Javscript that needs to be executed after rendering of this control (It overrides the GetEndScript of the parent to handle specific case of QJsTimers) Returns all Javscript that needs to be executed after rendering of this control (It overrides the GetEndScript of the parent to handle specific case of QJsTimers) Returns string Overrides `QControlBase::GetEndScript()`
`public array\|boolean\|integer\|mixed\|null\|QControl\|QForm\|string`	# `__get( string $strName )` PHP magic function to get value of properties of an object of this class PHP magic function to get value of properties of an object of this class Parameters `$strName` Name of the properties Returns array\|boolean\|integer\|mixed\|null\|`QControl`\|`QForm`\|string Throws `QCallerException` Overrides `QControlBase::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP Magic function to set property values for an object of this class PHP Magic function to set property values for an object of this class Parameters `$strName` Name of the property `$mixValue` Value of the property Returns mixed Throws `QCallerException` `QInvalidCastException` Overrides `QControlBase::__set()`
`public string\|`	# `Render( boolean $blnDisplayOutput = true )` Render function for the Control (must not be called becasue QJsTimer is not for being rendered) Render function for the Control (must not be called becasue QJsTimer is not for being rendered) Parameters `$blnDisplayOutput` useless in this case Returns string\| Throws `QCallerException` Overrides `QControlBase::Render()`
`public`	# `AddChildControl( QControl $objControl )` Add a child control to the current control (useless because QJsTimer cannot have children) Add a child control to the current control (useless because QJsTimer cannot have children) Parameters `$objControl` Throws `QCallerException` Overrides `QControlBase::AddChildControl()`
`public`	# `RemoveChildControl( string $strControlId, boolean $blnRemoveFromForm )` Remove the child controls (useless) Since QJsTimer cannot have children, removing child controls does not yeild anything Remove the child controls (useless) Since QJsTimer cannot have children, removing child controls does not yeild anything Parameters `$strControlId` `$blnRemoveFromForm` Overrides `QControlBase::RemoveChildControl()`
`protected string`	# `GetControlHtml( )` Get the HTML for the control (blank in this case becuase QJsTimer cannot be rendered) Get the HTML for the control (blank in this case becuase QJsTimer cannot be rendered) Returns string
`public`	# `ParsePostData( )` This function would typically parse the data posted back by the control. This function would typically parse the data posted back by the control.
`public boolean`	# `Validate( )` Validation logic for control. Since we never render, we must return true to continue using the control. Validation logic for control. Since we never render, we must return true to continue using the control. Returns boolean

Methods inherited from QControlBase
AddActionArray(), AddAttributeScript(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetModelConnectorParams(), GetNonWrappedHtml(), GetState(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), PutState(), Refresh(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderHtmlAttributes(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState()

Methods inherited from QHtmlAttributeManagerBase
`AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Constants summary
`integer`	`Stopped` Constant used to indicate that the timer has stopped Constant used to indicate that the timer has stopped	# `0`
`integer`	`Started` Constant used to indicate that the timer has started Constant used to indicate that the timer has started	# `1`
`integer`	`AutoStart` Constant used to indicate that the timer has autostart enabled (starts with the page load) Constant used to indicate that the timer has autostart enabled (starts with the page load)	# `2`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected boolean`	`$blnPeriodic` does the timer run periodically once started? does the timer run periodically once started?	# `true`
`protected integer`	`$intDeltaTime` The duration after which the timer will fire (in milliseconds) The duration after which the timer will fire (in milliseconds)	# `0`
`protected integer`	`$intState` default state in which timer will be (stopped) default state in which timer will be (stopped)	# `QJsTimerBase::Stopped`
`protected boolean`	`$blnRestartOnServerAction` should the timer start after a QServerAction occurrs. should the timer start after a QServerAction occurrs.	# `false`

Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnIsBlockElement, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strJavaScripts, $strName, $strPreferredRenderMethod, $strRenderMethod, $strStyleSheets, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Magic properties summary
`public integer`	`$DeltaTime` Time till the timer fires and executes the Actions added.
`public boolean`	`$Periodic` true: timer is restarted after firing false: you have to restart the timer by calling Start()
`public boolean`	`$Started` true: timer is running / false: stopped
`public boolean`	`$RestartOnServerAction` After a 'Server Action' (QServerAction) the executed java script (including the timer) is stopped! Set this parameter to true to restart the timer automatically.

Magic properties inherited from QControlBase
`$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified`

Magic properties inherited from QHtmlAttributeManagerBase
`$AccessKey, $AltText, $BackColor, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $HorizontalAlign, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign, $Width`

Packages

Classes

Traits

Exceptions

Functions

Class QJsTimerBase

Direct known subclasses

Parameters

Returns

Throws

Overrides

Parameters

Throws

Parameters

Throws

Overrides

Parameters

Returns

Overrides

Parameters

Overrides

Returns

Returns

Overrides

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Throws

Overrides

Parameters

Overrides

Returns

Returns