Description
Object | --Persistent | --Component | --Timer
Located in File: /extctrls.inc.php
Timer encapsulates the javascript timer functions.
Timer is used to simplify calling the javascript timer functions settimeout() and cleartimeout(), and to simplify processing the timer events. Use one timer component for each timer in the application.
The execution of the timer occurs through its OnTimer event. Timer has an Interval property that determines how often the timer’s OnTimer event occurs. Interval corresponds to the parameter for the javascript settimeout() function.
- link: - http://developer.mozilla.org/en/docs/DOM:window.clearTimeout
- link: - http://developer.mozilla.org/en/docs/DOM:window.setTimeout
Properties
Summary: | Enabled | Controls whether the timer generates OnTimer events periodically, so you can react to them programatically |
| Interval | Determines the amount of time, in milliseconds, that passes before the timer component initiates another OnTimer event. |
Defined in class Component |
||
| Name | Specifies the name for the component. The name is used as an identifier and should be unique. |
| Tag | A versatile property of every Component that can be used in any way you want |
 | ComponentCount | Indicates the number of components owned by the component. |
| Components | Lists all the components owned by this component. |
| ControlState | A flag to know the state of the control, csLoading, csDesigning |
| DataFieldValue | This property returns the value of the datafield if any. |
| NamePath | Specifies the path to uniquely identify a component, qualified by the owner when required. |
| Owner | Indicates the component that is responsible for streaming and freeing this component. |
Defined in class Persistent |
||
| NamePath | Used to serialize/unserialize. It returns the full path to identify this component. |
| Owner | Owner of the component. |
property Enabled (line 2977)
boolean Enabled
Controls whether the timer generates OnTimer events periodically, so you can react to them programatically
Use Enabled to enable or disable the timer. If Enabled is true, the timer responds normally. If Enabled is false, the timer does not generate OnTimer events. The default is true.
property Interval (line 2998)
integer Interval
Determines the amount of time, in milliseconds, that passes before the timer component initiates another OnTimer event.
Interval determines how frequently the OnTimer event occurs. Each time the specified interval passes, the OnTimer event occurs.
Use Interval to specify any cardinal value as the interval between OnTimer events. The default value is 1000 (one second).
Note: A 0 value is valid, however the timer will not call an OnTimer event for a value of 0.
Info
- see - Timer::OnTimer
property Name
Specifies the name for the component. The name is used as an identifier and should be unique.
This property is implemented in Component::Name
property Tag
A versatile property of every Component that can be used in any way you want
This property is implemented in Component::Tag
property ComponentCount
Indicates the number of components owned by the component.
This property is implemented in Component::ComponentCount
property Components
Lists all the components owned by this component.
This property is implemented in Component::Components
property ControlState
A flag to know the state of the control, csLoading, csDesigning
This property is implemented in Component::ControlState
property DataFieldValue
This property returns the value of the datafield if any.
This property is implemented in Component::DataFieldValue
property NamePath
Specifies the path to uniquely identify a component, qualified by the owner when required.
This property is implemented in Component::NamePath
property Owner
Indicates the component that is responsible for streaming and freeing this component.
This property is implemented in Component::Owner
property NamePath
Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePathMethods
Summary: | dumpJavascript | Dumps the javascript code needed by this component [Overrides Component::dumpJavascript()] |
Defined in class Component |
||
| dumpChildrenJavascript | Dumps the javascript code for all the children |
| dumpFormItems | Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components |
| dumpHeaderCode | Dumps header code required |
| dumpJavascript | Dumps the javascript code needed by this component |
| hasValidDataField | Returns true if a valid data field is attached to the component |
| init | Initializes a component |
| loaded | Initializes the component after the form file has been read into memory. |
| loadedChildren | Calls childrens loaded |
| preinit | Method called before init() |
| serializeChildren | Serializes all children |
| unserializeChildren | Unserializes all children by calling unserialize for all the components |
Defined in class Persistent |
||
| serialize | Stores this object into the session. |
| unserialize | This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call. |
Defined in class Object |
||
| __construct | Constructs an object and initializes its data before the object is first used. |
| className | Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument). |
| classParent | Returns the type of the immediate ancestor of a class. |
Method dumpJavascript (line 2909)
void dumpJavascript( )
Overrides : Component::dumpJavascript() Dumps the javascript code needed by this component
Javascript Events
Summary: | OnTimer | Occurs when a specified amount of time, determined by the Interval property, has passed. |
property OnTimer (line 3014)
mixed OnTimer
Occurs when a specified amount of time, determined by the Interval property, has passed.
Write an OnTimer event handler to execute an action at regular intervals. The Interval property of a timer determines how frequently the OnTimer event occurs. Each time the specified interval passes, the OnTimer event occurs.
Info
- see - Timer::Interval