Class ProgressBar

Description

Class ProgressBar Easy to use progress bar in html and css.

  • version: 1.0 - 20070418
  • author: David Bongard (mail@bongard.net | www.bongard.net | www.pinkorange. at)

Located in /inc/ProgressBar.class.php (line 63)


	
			
Method Summary
ProgressBar ProgressBar ([str $message = 'Working...'], [bool $hide = false], int $sleepOnFinish, [int $barLength = 300], [int $precision = 30], [str $backgroundColor = '#cccccc'], [str $foregroundColor = '#0A0'], [str $domID = 'progressbar'], [str $stepElement = '
'
])
void increase ()
void initialize (int $numElements)
Methods
Constructor ProgressBar (line 79)

Constructor

ProgressBar ProgressBar ([str $message = 'Working...'], [bool $hide = false], int $sleepOnFinish, [int $barLength = 300], [int $precision = 30], [str $backgroundColor = '#cccccc'], [str $foregroundColor = '#0A0'], [str $domID = 'progressbar'], [str $stepElement = '
'
])
  • str $message: Message shown above the bar eg. "Please wait...". Default: ''
  • bool $hide: Hide the bar after completion (with JavaScript). Default: false
  • int $sleepOnFinish: Seconds to sleep after bar completion. Default: 0
  • int $barLength: Length in pixels. Default: 200
  • int $precision: Desired number of steps to show. Default: 20. Precision will become $numElements when greater than $numElements. $barLength will increase if $precision is greater than $barLength.
  • str $backgroundColor: Color of the bar background
  • str $foregroundColor: Color of the actual progress-bar
  • str $domID: Html-Attribute "id" for the bar
  • str $stepElement: Element the bar is build from
increase (line 160)

Count steps and increase bar length

void increase ()
initialize (line 110)

Print the empty progress bar

void initialize (int $numElements)
  • int $numElements: Number of Elements to be processed and number of times $bar->initialize() will be called while processing

Documentation generated on Mon, 31 Mar 2008 21:17:33 +0200 by phpDocumentor 1.3.0RC3