Docs For Class ErrorBoxWidget

## Class ErrorBoxWidget

Description

This class is for displaying a standardized look and feel for an 'error' display.

- author: Walter A. Boring IV

Located in /widgets/ErrorBoxWidget.inc (line 21)

    Container
       |
       --BaseWidget
          |
          --ErrorBoxWidget

Variable Summary
mixed $_message
Method Summary
ErrorBoxWidget ErrorBoxWidget ([string $title = "Error"], [string $width = "100%"], [mixed $align = NULL])
void add (string $label, string $message)
void render (int $indent_level, int $output_debug)
void set_message (string $message)
Variables
mixed $_message = "Please review the following error(s) below." (line 28)

This is the message that gets displayed

underneath the image and before the list of errors

#### Inherited Variables

Inherited from BaseWidget

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

Methods
Constructor ErrorBoxWidget (line 37)

The constructor

ErrorBoxWidget ErrorBoxWidget ([string $title = "Error"], [string $width = "100%"], [mixed $align = NULL])

- string $title: the title used in the error box Default = 'Errors'
- string $width: the width of the entire object

add (line 62)

This method is used to add individual errors.

void add (string $label, string $message)

- string $label: the label for the error
- string $message: the actual error message

Redefinition of:

Container::add()
  add content onto content stack

render (line 75)

This is called to generate the resulting html output

void render (int $indent_level, int $output_debug)

- int $indent_level
- int $output_debug

Redefinition of:

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

set_message (line 50)

This method is for changing the default message that gets displayed before the list of errors

void set_message (string $message)

- string $message: the message you want displayed

#### 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()

Documentation generated on Thu, 1 Sep 2005 17:05:38 -0700 by phpDocumentor 1.3.0RC3