Class: Timer

Source Location: /extctrls.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Timer

Timer encapsulates the javascript timer functions.

Author(s):

Inherited Variables

Class: Component

Component::$alreadycreated
Component::$components
Component::$lastresourceread
Component::$owner
Component::$reallastresourceread
Component::$_childnames
Component::$_controlstate
Component::$_name
Component::$_namepath
Component::$_tag

Class: Object

Object::$input

Inherited Methods

Class: Component

Component::__construct(): Component constructor
Component::ajaxCall(): Dumps the javascript code to make an ajax call to the server.
Component::callEvent(): Calls a server event.
Component::defaultName()
Component::defaultTag()
Component::dumpChildrenFormItems(): This method is called by the page just after dumping the starting form tag.
Component::dumpChildrenHeaderCode(): Dumps the header code for all the children
Component::dumpChildrenJavascript(): Dumps the javascript code for all the children
Component::dumpFormItems(): Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
Component::dumpHeaderCode(): Dumps header code required
Component::dumpHiddenKeyFields(): Dumps hidden field values for the key record
Component::dumpJavascript(): Dumps the javascript code needed by this component
Component::dumpJSEvent(): Dumps javascript code for an event
Component::fixupProperty(): Resolves the right reference to an object property
Component::generateAjaxEvent(): Returns the javascript code to generate an ajax call.
Component::getName(): Specifies the name for the component. The name is used as an identifier and should be unique.
Component::getTag(): A versatile property of every Component that can be used in any way you want
Component::hasValidDataField(): Returns true if a valid data field is attached to the component
Component::init(): Initializes a component
Component::insertComponent(): Inserts a component into the component's collection
Component::loaded(): Initializes the component after the form file has been read into memory.
Component::loadedChildren(): Calls childrens loaded
Component::loadResource(): Loads this component from a string
Component::preinit(): Method called before init()
Component::readAccessibility(): Provides accessibility info to the embedded RPC engine.
Component::readComponentCount(): Indicates the number of components owned by the component.
Component::readComponents(): Lists all the components owned by this component.
Component::readControlState(): A flag to know the state of the control, csLoading, csDesigning
Component::readDataFieldValue(): This property returns the value of the datafield if any.
Component::readFromResource(): Reads a component from a resource file
Component::readNamePath(): Specifies the path to uniquely identify a component, qualified by the owner when required.
Component::readOwner(): Indicates the component that is responsible for streaming and freeing this component.
Component::removeComponent(): Removes a component from the component's collection
Component::serializeChildren(): Serializes all children
Component::setName()
Component::setTag()
Component::unserializeChildren(): Unserializes all children by calling unserialize for all the components
Component::updateDataField(): Updates the field on the dataset attached, if any
Component::writeControlState()

Class: Persistent

Persistent::allowserialize(): This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign(): Assigns the source properties to this object.
Persistent::assignError(): Raises an assignation error.
Persistent::assignTo(): Assigns this object to another object.
Persistent::inSession(): This method determines if this object exists in the current session.
Persistent::readNamePath(): Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner(): Owner of the component.
Persistent::serialize(): Stores this object into the session.
Persistent::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.

Class: Object

Object::__construct(): Constructs an object and initializes its data before the object is first used.
Object::className(): Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs(): Determines whether an object is of a specific type.
Object::classParent(): Returns the type of the immediate ancestor of a class.
Object::inheritsFrom(): Determines the relationship of two object types.
Object::methodExists(): Check if a method exists declared on this object instance.
Object::readProperty(): Reads a property from the streams
Object::__get(): To virtualize properties
Object::__set(): To virtualize properties

Class Details

[line 2902]
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.

Tags:

link:	http://developer.mozilla.org/en/docs/DOM:window.clearTimeout
link:	http://developer.mozilla.org/en/docs/DOM:window.setTimeout

[ Top ]

Class Variables

$_enabled = true

[line 2905]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_interval = 1000

[line 2904]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_jsontimer = null

[line 2907]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

method defaultEnabled [line 2979]

void defaultEnabled(
)

[ Top ]

method defaultInterval [line 3000]

void defaultInterval(
)

[ Top ]

method defaultjsOnTimer [line 3016]

void defaultjsOnTimer(
)

[ Top ]

method dumpJavascript [line 2909]

void dumpJavascript(
)

Overrides Component::dumpJavascript() (Dumps the javascript code needed by this component)

[ Top ]

method getEnabled [line 2977]

boolean getEnabled(
)

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.

[ Top ]

method getInterval [line 2998]

integer getInterval(
)

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.

Tags:

see:

Timer::getjsOnTimer()

[ Top ]

method getjsOnTimer [line 3014]

mixed getjsOnTimer(
)

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.

Tags:

see:

Timer::getInterval()

[ Top ]

method setEnabled [line 2978]

void setEnabled(

$value)

Parameters:

$value

[ Top ]

method setInterval [line 2999]

void setInterval(

$value)

Parameters:

$value

[ Top ]

method setjsOnTimer [line 3015]

void setjsOnTimer(

$value)

Parameters:

$value

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:51:37 -0700 by phpDocumentor 1.4.1