Class: PhpExt_ProgressBarWaitConfig

Source Location: /PhpExt/ProgressBarWaitConfig.php

Class PhpExt_ProgressBarWaitConfig

Class Overview

Located in /PhpExt/ProgressBarWaitConfig.php [line 23]

PhpExt_Object
   |
   --PhpExt_Config_ConfigObject
      |
      --PhpExt_ProgressBarWaitConfig

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::$_options

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::__construct()

PhpExt_Config_ConfigObject::getJavascript()

Inherited From PhpExt_Object

PhpExt_Object::__construct()

PhpExt_Object::addValidConfigProperties()

PhpExt_Object::createMethodSignature()

PhpExt_Object::getConfigParams()

PhpExt_Object::getExtConfigProperty()

PhpExt_Object::getJavascript()

PhpExt_Object::getMethodInvokeStm()

PhpExt_Object::isExtObject()

PhpExt_Object::paramToString()

PhpExt_Object::setExtClassInfo()

PhpExt_Object::setExtConfigProperty()

PhpExt_Object::__get()

PhpExt_Object::__set()

[ Top ]

Method Summary

static PhpExt_ProgressBarWaitConfig	createWaitConfig()	Helper function to easily create an instance to add configuration properties inline
PhpExt_ProgressBarWaitConfig	__construct()
int	getDuration()	The length of time in milliseconds that the progress bar should run before resetting itself (defaults to undefined, in which case it will run indefinitely until reset is called)
PhpExt_JavascriptStm	getFn()	A callback function to execute after the progress bar finishes auto-
int	getIncrement()	The number of progress update segments to display within the progress bar (defaults to 10). If the bar reaches the end and is still updating, it will automatically wrap back to the beginning.
int	getInterval()	The length of time in milliseconds between each progress update (default to 1000)
PhpExt_JavascriptStm	getScope()	The scope that is passed to the callback function (only applies when duration and fn are both passed).
PhpExt_ProgressBarWaitConfig	setDuration()	The length of time in milliseconds that the progress bar should run before resetting itself (defaults to undefined, in which case it will run indefinitely until reset is called)
PhpExt_ProgressBarWaitConfig	setFn()	A callback function to execute after the progress bar finishes auto-
PhpExt_ProgressBarWaitConfig	setIncrement()	The number of progress update segments to display within the progress bar (defaults to 10). If the bar reaches the end and is still updating, it will automatically wrap back to the beginning.
PhpExt_ProgressBarWaitConfig	setInterval()	The length of time in milliseconds between each progress update (default to 1000)
PhpExt_ProgressBarWaitConfig	setScope()	The scope that is passed to the callback function (only applies when duration and fn are both passed).

[ Top ]

Properties

Methods

static method createWaitConfig [line 144]

static PhpExt_ProgressBarWaitConfig createWaitConfig(
)

Helper function to easily create an instance to add configuration properties inline

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 125]

PhpExt_ProgressBarWaitConfig __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Config_ConfigObject::__construct()

[ Top ]

getDuration [line 39]

int getDuration(
)

The length of time in milliseconds that the progress bar should run before resetting itself (defaults to undefined, in which case it will run indefinitely until reset is called)

API Tags:

Access:

public

[ Top ]

getFn [line 101]

PhpExt_JavascriptStm getFn(
)

A callback function to execute after the progress bar finishes auto-

updating. The function will be called with no arguments. This function will be ignored if duration is not specified since in that case the progress bar can only be stopped programmatically, so any required function should be called by the same code after it resets the progress bar.

API Tags:

Access:

public

[ Top ]

getIncrement [line 75]

int getIncrement(
)

The number of progress update segments to display within the progress bar (defaults to 10). If the bar reaches the end and is still updating, it will automatically wrap back to the beginning.

API Tags:

Access:

public

[ Top ]

getInterval [line 57]

int getInterval(
)

The length of time in milliseconds between each progress update (default to 1000)

API Tags:

Access:

public

[ Top ]

getScope [line 121]

PhpExt_JavascriptStm getScope(
)

The scope that is passed to the callback function (only applies when duration and fn are both passed).

API Tags:

Access:

public

[ Top ]

setDuration [line 31]

PhpExt_ProgressBarWaitConfig setDuration(
int
$value 
)

The length of time in milliseconds that the progress bar should run before resetting itself (defaults to undefined, in which case it will run indefinitely until reset is called)

Parameters:

int

$value:

API Tags:

Access:

public

[ Top ]

setFn [line 89]

PhpExt_ProgressBarWaitConfig setFn(
PhpExt_JavascriptStm
$value 
)

A callback function to execute after the progress bar finishes auto-

Parameters:

PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

setIncrement [line 67]

PhpExt_ProgressBarWaitConfig setIncrement(
int
$value 
)

The number of progress update segments to display within the progress bar (defaults to 10). If the bar reaches the end and is still updating, it will automatically wrap back to the beginning.

Parameters:

int

$value:

API Tags:

Access:

public

[ Top ]

setInterval [line 49]

PhpExt_ProgressBarWaitConfig setInterval(
int
$value 
)

The length of time in milliseconds between each progress update (default to 1000)

Parameters:

int

$value:

API Tags:

Access:

public

[ Top ]

setScope [line 112]

PhpExt_ProgressBarWaitConfig setScope(
PhpExt_JavascriptStm
$value 
)

The scope that is passed to the callback function (only applies when duration and fn are both passed).

Parameters:

PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:58:09 -0500 by phpDocumentor 1.4.0