Class TAutoIFrameRotator

The TAutoIFrameRotator object is used to manage several TIFrameRotator objects, calling their TIFrameRotator#Rotate methods at specified intervals. This is often used to rotate banners from several 3rd party providers within IFRAMES.
Defined in: <class.iframerotator.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	TAutoIFrameRotator() Construct a new TAutoIFrameRotator object.

Field Summary
Field Attributes	Field Name and Description
	interval Interval of how often to rotate IFRAMEs, specified in milliseconds.

Method Summary
Method Attributes	Method Name and Description
	Add(item) Add an TIFrameRotator object to manage.
	getStarted() Returns whether automatic rotation is running.
	Rotate() Calls TIFrameRotator#Rotate method of all registered TIFrameRotator objects.
	Start(doNow) Starts automatic rotation.
	Stop() Stops automatic rotation.

Class Detail

TAutoIFrameRotator()

Construct a new TAutoIFrameRotator object.

Field Detail

{array} interval

Interval of how often to rotate IFRAMEs, specified in milliseconds. (Default is 300000, i.e. 5min)

Default Value:: 300000

Method Detail

Add(item)

Add an TIFrameRotator object to manage.

Parameters:
{TIFrameRotator} item: Instance of TIFrameRotator object.

getStarted()

Returns whether automatic rotation is running.

Returns:: Returns TRUE of object is automatically rotating, otherwise FALSE.

Rotate()

Calls TIFrameRotator#Rotate method of all registered TIFrameRotator objects.

Start(doNow)

Starts automatic rotation.

Parameters:
{bool} doNow: If TRUE, immediately rotates. If FALSE, first rotate will only happen after specified #interval.

Stop()

Stops automatic rotation.

Classes

Class TAutoIFrameRotator