Docs For Class ProgressBoxWidget

Description

This class builds a nice box that contains a title a ProgressWidget and some description text for each progress percentage.

By default it is hidden, so you can build the box, and call set_visible() when you want to display it, then call set_hidden() when you want it to disapear when it reaches 100%

author: Walter A. Boring IV

Located in /widgets/ProgressWidget.inc (line 181)

Container
   |
   --BaseWidget
      |
      --ProgressBoxWidget

Variable Summary

mixed $last_comment

mixed $_progress

Method Summary

ProgressBoxWidget ProgressBoxWidget ([string $title = NULL], [integer $width = 300], [ $show_percent_flag = TRUE])

void display ()

void render ([integer $indent_level = 0], [integer $output_debug = 0])

void set_hidden ()

void set_visible ()

void update (integer $percent, [string $comment = NULL])

none update_comment (string $comment)

Variables

mixed $last_comment = NULL (line 193)

Holds value of the last comment

mixed $_progress = NULL (line 187)

Holds the progress bar object

Inherited Variables

Inherited from BaseWidget

BaseWidget::$title
BaseWidget::$width
BaseWidget::$_image_prefix

Methods

Constructor ProgressBoxWidget (line 202)

The constructor

ProgressBoxWidget ProgressBoxWidget ([string $title = NULL], [integer $width = 300], [ $show_percent_flag = TRUE])

string $title: the title of the box.
integer $width: the width to use for the outer box.
$show_percent_flag

display (line 239)

This function outputs the html

and places it in the middle of the page

void display ()

render (line 217)

Render the box.

This should get called before calling update()

void render ([integer $indent_level = 0], [integer $output_debug = 0])

integer $indent_level: indent level
integer $output_debug: output_debug

Redefinition of:

Container::render(): This function is compatible with the rest of the phpHtmllib API spec.

set_hidden (line 275)

This function hides the progress window

void set_hidden ()

set_visible (line 267)

This function shows the progress window

void set_visible ()

update (line 288)

this function updates the progress bar

void update (integer $percent, [string $comment = NULL])

integer $percent
: percentage as an integer
1. < x < 100
string $comment: comment

update_comment (line 301)

this function updates the progress bar

none update_comment (string $comment)

string $comment: the comment to update.

Inherited Methods

Inherited From BaseWidget

BaseWidget::get_align()
BaseWidget::get_css()
BaseWidget::get_javascript()
BaseWidget::get_title()
BaseWidget::get_width()
BaseWidget::set_align()
BaseWidget::set_image_path_prefix()
BaseWidget::set_title()
BaseWidget::set_width()

Inherited From Container

Container::Container()
Container::add()
Container::add_reference()
Container::count_content()
Container::get_element()
Container::get_indent_flag()
Container::push()
Container::push_reference()
Container::render()
Container::reset_content()
Container::set_collapse()
Container::set_indent_flag()