🌐 Docs For Class HTML_Progress2

$animSpeed =

[line 186]

Delay in milisecond before each progress cells display.

1000 ms === sleep(1) <strong>usleep()</strong> function does not run on Windows platform.

See: HTML_Progress2::setAnimSpeed()
Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$border = array()

[line 382]

Progress bar border properties

 $border = array(

    'class' => 'progressBorder%s',    # css class selector
    'width' => 0,                     # width size in pixel
    'style' => 'solid',               # style (solid, dashed, dotted ...)
    'color' => '#000000'              # color
 );

See: HTML_Progress2::getBorderAttributes(), HTML_Progress2::setBorderAttributes()
Since: 2.0.0
Access: public

Type:

array

[ Top ]

$cell = array()

[line 408]

Progress bar cells properties

 $cell = array(

    'id' => 'pcel%01s',                    # cell identifier mask
    'class' => 'cell%s',                   # css class selector
    'active-color' => '#006600',           # active color
    'inactive-color' => '#CCCCCC',         # inactive color
    'font-family' => 'Courier, Verdana',   # font family
    'font-size' => 8,                      # font size
    'color' => '#000000',                  # foreground color
    'background-color' => '#FFFFFF',       # background color
    'width' => 15,                         # cell width
    'height' => 20,                        # cell height
    'spacing' => 2                         # cell spacing
 );

See: HTML_Progress2::getCellAttributes(), HTML_Progress2::setCellAttributes()
Since: 2.0.0
Access: public

Type:

array

[ Top ]

$cellCount =

[line 286]

The cell count of the progress bar. The default is 10.

See: HTML_Progress2::getCellCount(), HTML_Progress2::setCellCount()
Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$fillWay =

[line 276]

Whether the progress bar is filled in 'natural' or 'reverse' way.

The default fill way is 'natural'.

'way' = bar fill way
- with Progress Bar Horizontal, natural way is : left to right
  reverse way is : right to left
- with Progress Bar Vertical, natural way is : down to up
  reverse way is : up to down
- with Progress Circle or Polygonal, natural way is : clockwise
  reverse way is : anticlockwise

See: HTML_Progress2::getFillWay(), HTML_Progress2::setFillWay()
Since: 2.0.0
Access: public

Type:

string

[ Top ]

$frame = array()

[line 363]

Progress bar frame properties

 $frame = array(

    'show' => false,      # frame show (true/false)
    'left' => 200,        # position from left
    'top' => 100,         # position from top
    'width' => 320,       # width
    'height' => 90,       # height
    'color' => '#C0C0C0', # color
    'border' => 2,                                         # border width
    'border-style' => 'solid',                             # border style
                                                           # (solid, dashed, dotted ...)
    'border-color' => '#DFDFDF #404040 #404040 #DFDFDF'    # border color (3dfx)
 );

See: HTML_Progress2::getFrameAttributes(), HTML_Progress2::setFrameAttributes()
Since: 2.0.0
Access: public

Type:

array

[ Top ]

$ident =

[line 164]

The label that uniquely identifies this progress object.

See: HTML_Progress2::getIdent(), HTML_Progress2::setIdent()
Since: 2.0.0
Access: public

Type:

string

[ Top ]

$increment =

[line 229]

The progress bar's increment value.

The default is +1.

See: HTML_Progress2::getIncrement(), HTML_Progress2::setIncrement()
Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$indeterminate =

[line 143]

Whether the progress bar is in determinate or indeterminate mode.

The default is false. An indeterminate progress bar continuously displays animation indicating that an operation of unknown length is occuring.

See: HTML_Progress2::setIndeterminate(), HTML_Progress2::isIndeterminate()
Since: 2.0.0
Access: public

Type:

boolean

[ Top ]

$label = array()

[line 438]

Progress bar labels properties

 $label = array(

    'name' => array(                  # label name
      'type' => 'text',               # label type
                                      # (text,button,step,percent,crossbar)
      'value' => '&nbsp;',            # label value
      'left' => ($left),              # label position from left
      'top' => ($top - 16),           # label position from top
      'width' => 0,                   # label width
      'height' => 0,                  # label height
      'align' => 'left',              # label align
      'background-color' => '',       # label background color
      'font-family' => 'Verdana, Tahoma, Arial',    # label font family
      'font-size' => 11,                            # label font size
      'font-weight' => 'normal',                    # label font weight
      'color' => '#000000',                         # label font color
      'class' => 'progressPercentLabel%s'           # css class selector
 );

See: HTML_Progress2::getLabelAttributes(), HTML_Progress2::setLabelAttributes()
Since: 2.0.0
Access: public

Type:

array

[ Top ]

$maximum =

[line 218]

The progress bar's maximum value.

The default is 100.

See: HTML_Progress2::getMaximum(), HTML_Progress2::setMaximum()
Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$minimum =

[line 207]

The progress bar's minimum value.

The default is 0.

See: HTML_Progress2::getMinimum(), HTML_Progress2::setMinimum()
Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$orientation =

[line 250]

Whether the progress bar is horizontal, vertical, polygonal or circle.

The default is horizontal.

See: HTML_Progress2::getOrientation(), HTML_Progress2::setOrientation()
Since: 2.0.0
Access: public

Type:

integer

[ Top ]

$script =

[line 448]

External Javascript file to override internal default code

See: HTML_Progress2::getScript(), HTML_Progress2::setScript()
Since: 2.0.0
Access: public

Type:

string

[ Top ]

$value =

[line 239]

The progress bar's current value.

See: HTML_Progress2::getValue(), setvalue(), HTML_Progress2::incValue()
Since: 2.0.0
Access: public

Type:

integer

[ Top ]

__construct (Constructor) [line 555]

HTML_Progress2 __construct(
[array
$errorPrefs = array()], [int
$orient = HTML_PROGRESS2_BAR_HORIZONTAL], [int
$min = 0], [int
$max = 100], [mixed
$percentLabel = 'pct1'])

Constructor (ZE2) Summary

Creates a natural horizontal progress bar that displays ten separated cells with no border and no labels. The initial and minimum values are 0, and the maximum is 100.

   $bar = new HTML_Progress2();

See: HTML_Progress2::setIndeterminate(), HTML_Progress2::setIdent(), HTML_Progress2::setAnimSpeed(), HTML_Progress2::setOrientation(), HTML_Progress2::setMinimum(), HTML_Progress2::setMaximum(), HTML_Progress2::addLabel()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: protected

Parameters:

array	`$errorPrefs`	—	(optional) Hash of params to configure error handler
int	`$orient`	—	(optional) Orientation of progress bar
int	`$min`	—	(optional) Minimum value of progress bar
int	`$max`	—	(optional) Maximum value of progress bar
mixed	`$percentLabel`	—	(optional) Progress bar percent label id.

[ Top ]

HTML_Progress2 (Constructor) [line 524]

HTML_Progress2 HTML_Progress2(
[
$errorPrefs = array()], [
$orient = HTML_PROGRESS2_BAR_HORIZONTAL], [
$min = 0], [
$max = 100], [
$percentLabel = 'pct1'])

Constructor (ZE1)

Since: 2.0.0
Access: public

Parameters:

	`$errorPrefs`	—
	`$orient`	—
	`$min`	—
	`$max`	—
	`$percentLabel`	—

[ Top ]

addLabel [line 1778]

void addLabel(
string
$type, string
$name, [string
$value = '&nbsp;'])

Add a new label to the progress bar.

Tutorial: progress.addlabel.pkg
See: HTML_Progress2::setLabelAttributes(), HTML_Progress2::removeLabel()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

string	`$type`	—	Label type (text,button,step,percent,crossbar)
string	`$name`	—	Label name
string	`$value`	—	(optional) default label value

[ Top ]

addListener [line 2819]

boolean addListener(
object
$observer)

Adds a HTML_Progress2_Observer instance to the list of observers that are listening for messages emitted by this HTML_Progress2 instance.

Returns TRUE if the observer is successfully attached.

Tutorial: progress.addlistener.pkg
See: HTML_Progress2::getListeners(), HTML_Progress2::removeListener()
Since: 2.0.0
Access: public

Parameters:

object $observer — The HTML_Progress2_Observer instance to attach as a listener.

[ Top ]

apiVersion [line 659]

string apiVersion(
)

Returns the current API version compatible with php.version_compare()

Tutorial: progress.apiversion.pkg
Since: 2.0.0
Access: public

[ Top ]

display [line 2641]

void display(
)

Renders the new value of progress bar.

Tutorial: progress.display.pkg
Since: 2.0.0
Access: public

[ Top ]

drawCircleSegments [line 2145]

array drawCircleSegments(
[string
$dir = '.'], [string
$fileMask = 'c%s.png'])

Draw all circle segment pictures

Tutorial: progress.drawcirclesegments.pkg
See: HTML_Progress2::setCellAttributes()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

string	`$dir`	—	(optional) Directory where pictures should be created
string	`$fileMask`	—	(optional) sprintf format for pictures filename

[ Top ]

getAnimSpeed [line 2218]

integer getAnimSpeed(
)

Returns delay execution of the progress bar

Tutorial: progress.getanimspeed.pkg
See: HTML_Progress2::setAnimSpeed()
Since: 2.0.0
Access: public

[ Top ]

getBorderAttributes [line 1555]

mixed getBorderAttributes(
[bool
$asString = false])

Returns the progress bar's border attributes. Assoc array (defaut) or string.

Tutorial: progress.getborderattributes.pkg
See: HTML_Progress2::setBorderAttributes()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

bool $asString — (optional) whether to return the attributes as string

[ Top ]

getCellAttributes [line 1340]

mixed getCellAttributes(
[bool
$asString = false])

Returns the common and private cell attributes. Assoc array (defaut) or string

Tutorial: progress.getcellattributes.pkg
See: HTML_Progress2::setCellAttributes()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

bool $asString — (optional) whether to return the attributes as string

[ Top ]

getCellCoordinates [line 1448]

array getCellCoordinates(
)

Returns the coordinates of each cell for a polygonal progress shape.

Tutorial: progress.getcellcoordinates.pkg
See: HTML_Progress2::setCellCoordinates()
Since: 2.0.0
Access: public

[ Top ]

getCellCount [line 1290]

integer getCellCount(
)

Returns the number of cell in the progress bar. The default value is 10.

Tutorial: progress.getcellcount.pkg
See: HTML_Progress2::setCellCount()
Since: 2.0.0
Access: public

[ Top ]

getError [line 3539]

false|array|PEAR_Error getError(
)

Pop an error off of the HTML_Progress2 stack

Tutorial: progress.geterror.pkg
See: HTML_Progress2::hasErrors(), HTML_Progress2::raiseError()
Since: 2.0.0
Access: public

[ Top ]

getFillWay [line 1243]

string getFillWay(
)

Returns 'natural' or 'reverse', depending of the fill way of progress bar.

For horizontal progress bar, natural way is from left to right, and reverse way is from right to left. For vertical progress bar, natural way is from down to up, and reverse way is from up to down. The default fill way is 'natural'.

Tutorial: progress.getfillway.pkg
See: HTML_Progress2::setFillWay()
Since: 2.0.0
Access: public

[ Top ]

getFrameAttributes [line 1612]

mixed getFrameAttributes(
[bool
$asString = false])

Returns the frame attributes. Assoc array (defaut) or string.

Tutorial: progress.setframeattributes.pkg
See: HTML_Progress2::setFrameAttributes()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

bool $asString — (optional) whether to return the attributes as string

[ Top ]

getIdent [line 2767]

string getIdent(
)

Returns the current identification string.

Tutorial: progress.getident.pkg
See: HTML_Progress2::setIdent()
Since: 2.0.0
Access: public

[ Top ]

getIncrement [line 884]

integer getIncrement(
)

Returns the progress bar's increment value. The default value is +1.

Tutorial: progress.getincrement.pkg
See: HTML_Progress2::setIncrement()
Since: 2.0.0
Access: public

[ Top ]

getLabelAttributes [line 1692]

mixed getLabelAttributes(
string
$name, [bool
$asString = false])

Returns the label attributes. Assoc array (defaut) or string.

Tutorial: progress.getlabelattributes.pkg
See: HTML_Progress2::setLabelAttributes()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

string	`$name`	—	progress label id.
bool	`$asString`	—	(optional) whether to return the attributes as string

[ Top ]

getListeners [line 2800]

array getListeners(
)

Returns an array of all the listeners added to this progress bar.

Tutorial: progress.getlisteners.pkg
See: HTML_Progress2::addListener(), HTML_Progress2::removeListener()
Since: 2.0.0
Access: public

[ Top ]

getMaximum [line 820]

integer getMaximum(
)

Returns the progress bar's maximum value. The default value is 100.

Tutorial: progress.getmaximum.pkg
See: HTML_Progress2::setMaximum()
Since: 2.0.0
Access: public

[ Top ]

getMinimum [line 756]

integer getMinimum(
)

Returns the progress bar's minimum value. The default value is 0.

Tutorial: progress.getminimum.pkg
See: HTML_Progress2::setMinimum()
Since: 2.0.0
Access: public

[ Top ]

getOrientation [line 1172]

integer getOrientation(
)

Returns HTML_PROGRESS2_BAR_HORIZONTAL or HTML_PROGRESS2_BAR_VERTICAL, depending on the orientation of the progress bar.

The default orientation is HTML_PROGRESS2_BAR_HORIZONTAL.

Tutorial: progress.getorientation.pkg
See: HTML_Progress2::setOrientation()
Since: 2.0.0
Access: public

[ Top ]

getPercentComplete [line 1138]

float getPercentComplete(
[boolean
$float = true])

Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00.

Tutorial: progress.getpercentcomplete.pkg
See: HTML_Progress2::getValue(), HTML_Progress2::getMaximum()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

boolean $float — (optional) float or integer format

[ Top ]

getProgressAttributes [line 1954]

mixed getProgressAttributes(
[bool
$asString = false])

Returns the progress attributes. Assoc array (defaut) or string.

Tutorial: progress.getprogressattributes.pkg
See: HTML_Progress2::setProgressAttributes()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

bool $asString — (optional) whether to return the attributes as string

[ Top ]

getScript [line 2014]

string getScript(
)

Get the javascript URL or inline code to manage progress bar.

Tutorial: progress.getscript.pkg
See: HTML_Progress2::setScript()
Since: 2.0.0
Access: public

[ Top ]

getStyle [line 2269]

string getStyle(
)

Get the cascading style sheet to put inline on HTML document

Tutorial: progress.getstyle.pkg
Since: 2.0.0
Access: public

[ Top ]

getValue [line 931]

integer getValue(
)

Returns the progress bar's current value. The value is always between the minimum and maximum values, inclusive.

By default, the value is initialized with the minimum value.

Tutorial: progress.getvalue.pkg
See: HTML_Progress2::setValue(), HTML_Progress2::incValue()
Since: 2.0.0
Access: public

[ Top ]

hasErrors [line 3525]

integer hasErrors(
)

Determine whether there are errors into the HTML_Progress2 stack

Tutorial: progress.haserrors.pkg
See: HTML_Progress2::getError(), HTML_Progress2::raiseError()
Since: 2.0.0
Access: public

[ Top ]

hide [line 2655]

void hide(
)

Hides the progress bar.

Tutorial: progress.hide.pkg
Since: 2.0.0
Access: public

[ Top ]

incValue [line 991]

void incValue(
)

Updates the progress bar's current value by adding increment value.

All change listeners are notified.

Tutorial: progress.incvalue.pkg
See: HTML_Progress2::getValue(), HTML_Progress2::setValue()
Since: 2.0.0
Access: public

[ Top ]

isBorderPainted [line 716]

boolean isBorderPainted(
)

Determines whether the progress bar border is painted or not.

The default is false.

Tutorial: progress.isborderpainted.pkg
See: HTML_Progress2::setBorderPainted()
Since: 2.0.0
Access: public

[ Top ]

isIndeterminate [line 673]

boolean isIndeterminate(
)

Returns mode of the progress bar (determinate or not).

Tutorial: progress.isindeterminate.pkg
See: HTML_Progress2::setIndeterminate()
Since: 2.0.0
Access: public

[ Top ]

moveNext [line 1119]

void moveNext(
)

Changes value of the progress bar to the next step.

All change listeners are notified.

Tutorial: progress.movenext.pkg
See: HTML_Progress2::moveStep(), HTML_Progress2::getValue(), HTML_Progress2::getIncrement()
Since: 2.0.0
Access: public

[ Top ]

moveStep [line 1013]

void moveStep(
integer
$step)

Changes new step value of the progress bar.

All change listeners are notified.

Tutorial: progress.movestep.pkg
See: HTML_Progress2::setValue()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer $step — new step value

[ Top ]

process [line 2722]

void process(
)

Performs the progress actions

Tutorial: progress.process.pkg
See: HTML_Progress2::sleep(), HTML_Progress2::setProgressHandler()
Since: 2.0.0
Access: public

[ Top ]

raiseError [line 3505]

mixed raiseError(
)

A basic wrapper around the default PEAR_Error object

Tutorial: progress.raiseerror.pkg
See: _errorHandler()
Since: 2.0.0
Access: public

[ Top ]

removeLabel [line 1921]

void removeLabel(
string
$name)

Removes a label to the progress bar.

Tutorial: progress.removelabel.pkg
See: HTML_Progress2::addLabel()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

string $name — Label name

[ Top ]

removeListener [line 2842]

boolean removeListener(
object
$observer)

Removes a HTML_Progress2_Observer instance from the list of observers.

Returns TRUE if the observer is successfully detached.

Tutorial: progress.removelistener.pkg
See: HTML_Progress2::getListeners(), HTML_Progress2::addListener()
Since: 2.0.0
Access: public

Parameters:

object $observer — The HTML_Progress2_Observer instance to detach from the list of listeners.

[ Top ]

run [line 2743]

void run(
)

Runs the progress bar (both modes: indeterminate and determinate), and execute all actions defined in user callback identified by method setProgressHandler.

Tutorial: progress.run.pkg
See: HTML_Progress2::process(), HTML_Progress2::setProgressHandler()
Since: 2.0.0
Access: public

[ Top ]

setAnimSpeed [line 2235]

void setAnimSpeed(
integer
$delay)

Set the delays progress bar execution for the given number of miliseconds.

Tutorial: progress.setanimspeed.pkg
See: HTML_Progress2::getAnimSpeed()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer $delay — Delay in milisecond.

[ Top ]

setBorderAttributes [line 1593]

void setBorderAttributes(
mixed
$attributes)

Sets the progress bar's border attributes.

Defaults are:

class = progressBorder%s
width = 0
style = solid
color = #000000

Tutorial: progress.setborderattributes.pkg
See: HTML_Progress2::getBorderAttributes()
Since: 2.0.0
Access: public

Parameters:

mixed $attributes — Associative array or string of HTML tag attributes

[ Top ]

setBorderPainted [line 734]

void setBorderPainted(
boolean
$paint)

Sets the value of $_paintBorder property, which determines whether the progress bar should paint its border. The default is false.

Tutorial: progress.setborderpainted.pkg
See: HTML_Progress2::isBorderPainted()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

boolean $paint — whether the progress bar should paint its border

[ Top ]

setCellAttributes [line 1398]

void setCellAttributes(
mixed
$attributes, [int
$cell = null])

Sets the cell attributes for an existing cell.

Defaults are:

Common :
- id = pcel%01s
- class = cell
- spacing = 2
- active-color = #006600
- inactive-color = #CCCCCC
- font-family = Courier, Verdana
- font-size = lowest value from cell width, cell height, and font size
- color = #000000
- background-color = #FFFFFF (added for progress circle shape on release 1.2.0)
- Horizontal Bar :
  - width = 15
  - height = 20
- Vertical Bar :
  - width = 20
  - height = 15

Tutorial: progress.setcellattributes.pkg
See: HTML_Progress2::getCellAttributes()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

mixed	`$attributes`	—	Associative array or string of HTML tag attributes
int	`$cell`	—	(optional) Cell index

[ Top ]

setCellCoordinates [line 1467]

void setCellCoordinates(
integer
$xgrid, integer
$ygrid, [array
$coord = array()])

Set the coordinates of each cell for a polygonal progress shape.

Tutorial: progress.setcellcoordinates.pkg
See: HTML_Progress2::getCellCoordinates()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer	`$xgrid`	—	The grid width in cell size
integer	`$ygrid`	—	The grid height in cell size
array	`$coord`	—	(optional) Coordinates (x,y) in the grid, of each cell

[ Top ]

setCellCount [line 1307]

void setCellCount(
integer
$cells)

Sets the number of cell in the progress bar

Tutorial: progress.setcellcount.pkg
See: HTML_Progress2::getCellCount()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer $cells — Cell count on progress bar

[ Top ]

setFillWay [line 1261]

void setFillWay(
string
$way)

Sets the progress bar's fill way, which must be 'natural' or 'reverse'.

The default fill way is 'natural'.

Tutorial: progress.setfillway.pkg
See: HTML_Progress2::getFillWay()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

string $way — fill direction (natural or reverse)

[ Top ]

setFrameAttributes [line 1643]

void setFrameAttributes(
[null|array
$attributes = array()])

Build a frame around the progress bar.

Tutorial: progress.setframeattributes.pkg
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT, HTML_PROGRESS2_ERROR_INVALID_OPTION
Since: 2.0.0
Access: public

Parameters:

null|array $attributes — (optional) hash of style parameters

[ Top ]

setIdent [line 2782]

void setIdent(
[mixed
$ident = null])

Sets this Progress instance's identification string.

Tutorial: progress.setident.pkg
See: HTML_Progress2::getIdent()
Since: 2.0.0
Access: public

Parameters:

mixed $ident — (optional) the new identification string.

[ Top ]

setIncrement [line 901]

void setIncrement(
integer
$inc)

Sets the progress bar's increment value.

Tutorial: progress.setincrement.pkg
See: HTML_Progress2::getIncrement()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer $inc — progress bar's increment value

[ Top ]

setIndeterminate [line 694]

void setIndeterminate(
boolean
$continuous)

Sets the $indeterminate property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode.

An indeterminate progress bar continuously displays animation indicating that an operation of unknown length is occuring. By default, this property is false.

Tutorial: progress.setindeterminate.pkg
See: HTML_Progress2::isIndeterminate()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

boolean $continuous — whether countinuously displays animation

[ Top ]

setLabelAttributes [line 1745]

void setLabelAttributes(
string
$name, mixed
$attributes)

Sets label attributes.

Defaults are:

class = progressPercentLabel%s
width = 50
height = 0
font-size = 11
font-family = Verdana, Tahoma, Arial
font-weight = normal
color = #000000
background-color =
align = right
valign = right

Tutorial: progress.setlabelattributes.pkg
See: HTML_Progress2::getLabelAttributes(), HTML_Progress2::addLabel()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

string	`$name`	—	progress label id.
mixed	`$attributes`	—	Associative array or string of HTML tag attributes

[ Top ]

setMaximum [line 839]

void setMaximum(
integer
$max)

Sets the progress bar's maximum value.

If the maximum value is different from previous maximum, all change listeners are notified.

Tutorial: progress.setmaximum.pkg
See: HTML_Progress2::getMaximum()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer $max — progress bar's maximal value

[ Top ]

setMinimum [line 775]

void setMinimum(
integer
$min)

Sets the progress bar's minimum value.

If the minimum value is different from previous minimum, all change listeners are notified.

Tutorial: progress.setminimum.pkg
See: HTML_Progress2::getMinimum()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer $min — progress bar's minimal value

[ Top ]

setOrientation [line 1191]

void setOrientation(
integer
$orient)

Sets the progress bar's orientation, which must be HTML_PROGRESS2_BAR_HORIZONTAL or HTML_PROGRESS2_BAR_VERTICAL.

The default orientation is HTML_PROGRESS2_BAR_HORIZONTAL.

Tutorial: progress.setorientation.pkg
See: HTML_Progress2::getOrientation()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer $orient — Orientation (horizontal or vertical)

[ Top ]

setProgressAttributes [line 2000]

void setProgressAttributes(
mixed
$attributes)

Sets the common progress bar attributes.

Defaults are:

background-color = #FFFFFF
auto-size = true
Horizontal Bar :
- width = (cell_count * (cell_width + cell_spacing)) + cell_spacing
- height = cell_height + (2 * cell_spacing)
Vertical Bar :
- width = cell_width + (2 * cell_spacing)
- height = (cell_count * (cell_height + cell_spacing)) + cell_spacing

Tutorial: progress.setprogressattributes.pkg
See: HTML_Progress2::getProgressAttributes()
Since: 2.0.0
Access: public

Parameters:

mixed $attributes — Associative array or string of HTML tag attributes

[ Top ]

setProgressHandler [line 2701]

void setProgressHandler(
mixed
$handler)

Sets the user callback function that execute all actions pending progress

Tutorial: progress.setprogresshandler.pkg
See: HTML_Progress2::process()
Throws: HTML_PROGRESS2_ERROR_INVALID_CALLBACK
Since: 2.0.0
Access: public

Parameters:

mixed $handler — Name of function or a class-method.

[ Top ]

setScript [line 2105]

void setScript(
string
$url)

Set the external JavaScript code (file) to manage progress element.

Tutorial: progress.setscript.pkg
See: HTML_Progress2::getScript()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

string $url — URL to the linked Progress JavaScript

[ Top ]

setValue [line 950]

void setValue(
integer
$val)

Sets the progress bar's current value.

If the new value is different from previous value, all change listeners are notified.

Tutorial: progress.setvalue.pkg
See: HTML_Progress2::getValue(), HTML_Progress2::incValue()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.0.0
Access: public

Parameters:

integer $val — progress bar's current value

[ Top ]

sleep [line 2677]

void sleep(
)

Default user callback when none are defined.

Delay execution of progress meter for the given number of milliseconds.

NOTE: The function http://www.php.net/manual/en/function.usleep.php did not work on Windows systems until PHP 5.0.0

Tutorial: progress.sleep.pkg
See: HTML_Progress2::getAnimSpeed(), HTML_Progress2::setAnimSpeed(), HTML_Progress2::process()
Since: 2.0.0
Access: public

[ Top ]

toArray [line 2354]

array toArray(
)

Returns the progress bar structure in an array.

Tutorial: progress.toarray.pkg
Since: 2.0.0
Access: public

[ Top ]

toHtml [line 2387]

string toHtml(
)

Returns the progress structure as HTML.

Tutorial: progress.tohtml.pkg
Since: 2.0.0
Access: public

[ Top ]

Class: HTML_Progress2

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$animSpeed =

$border = array()

$cell = array()

$cellCount =

$fillWay =

$frame = array()

$ident =

$increment =

$indeterminate =

$label = array()

$maximum =

$minimum =

$orientation =

$script =

$value =

Method Detail

__construct (Constructor) [line 555]

Parameters:

HTML_Progress2 (Constructor) [line 524]

Parameters:

addLabel [line 1778]

Parameters:

addListener [line 2819]

Parameters:

apiVersion [line 659]

display [line 2641]

drawCircleSegments [line 2145]

Parameters:

getAnimSpeed [line 2218]

getBorderAttributes [line 1555]

Parameters:

getCellAttributes [line 1340]

Parameters:

getCellCoordinates [line 1448]

getCellCount [line 1290]

getError [line 3539]

getFillWay [line 1243]

getFrameAttributes [line 1612]

Parameters:

getIdent [line 2767]

getIncrement [line 884]

getLabelAttributes [line 1692]

Parameters:

getListeners [line 2800]

getMaximum [line 820]

getMinimum [line 756]

getOrientation [line 1172]

getPercentComplete [line 1138]

Parameters:

getProgressAttributes [line 1954]

Parameters:

getScript [line 2014]

getStyle [line 2269]

getValue [line 931]

hasErrors [line 3525]

hide [line 2655]

incValue [line 991]

isBorderPainted [line 716]

isIndeterminate [line 673]

moveNext [line 1119]

moveStep [line 1013]

Parameters:

process [line 2722]

raiseError [line 3505]

removeLabel [line 1921]

Parameters:

removeListener [line 2842]

Parameters:

run [line 2743]