Docs For Class MessageBoxWidget

## Class MessageBoxWidget

Description

This class is used to build a DialogWidget that can have 'blocks' for messages.

- author: Walter A. Boring IV <waboring@newsblob.com>

Located in /widgets/MessageBoxWidget.inc (line 18)

    Container
       |
       --BaseWidget
          |
          --DialogWidget
             |
             --StandardDialogWidget
                |
                --MessageBoxWidget

Direct descendents

Class | Description
--- | ---
MessageBoxOK | This is a class for building a MessageBox with an OK button.

Variable Summary
mixed $_form_method
mixed $_has_form
mixed $_hidden_vars
mixed $_message
Method Summary
MessageBoxWidget MessageBoxWidget (string $title, [mixed $width = "600"], [string $message = ""])
void add_button (string $title, [string $action = NULL])
void add_hidden_variable (string $key, string $value)
none add_hidden_variables (array $vars)
object form_action_button (string $content, [string $action = NULL], [array $attrib = NULL])
string get_message ()
void render ([mixed $indent_level = 1], mixed $output_debug)
void set_message (string $mesg)
Variables
mixed $_form_method = "POST" (line 35)

The form method type

GET or POST only

mixed $_has_form = FALSE (line 29)

Do we need to render a form?

mixed $_hidden_vars = array() (line 40)

This stores additionnal hidden variables.

mixed $_message = NULL (line 23)

The _message to display

#### Inherited Variables

Inherited from DialogWidget

> DialogWidget::$_buttons
> DialogWidget::$_cancel_url
> DialogWidget::$_show_cancel_button

Inherited from BaseWidget

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

Methods
Constructor MessageBoxWidget (line 49)

constructor

MessageBoxWidget MessageBoxWidget (string $title, [mixed $width = "600"], [string $message = ""])

- string $title: - the title of the window
- mixed $width: - the width of the object
- string $message: - the message string

add_button (line 146)

Adds a single button to the dialog that will be display at the bottom of the widget

- access: public

void add_button (string $title, [string $action = NULL])

- string $title: - button title
- string $action: - button action, if NULL, then submit button is created

Redefinition of:

DialogWidget::add_button()
  Adds a single button to the dialog that will be display at the bottom of the widget

add_hidden_variable (line 118)

Add a single extra hidden variable

void add_hidden_variable (string $key, string $value)

- string $key: - key of the hidden variable
- string $value: - value of the variable

add_hidden_variables (line 129)

Add extra hidden variables

none add_hidden_variables (array $vars)

- array $vars: an array of key => value hidden variables

form_action_button (line 180)

build an tag of type button which executes a javaScript function

object form_action_button (string $content, [string $action = NULL], [array $attrib = NULL])

- string $content
- string $action
- array $attrib: - additional attributes

get_message (line 105)

Gets the current value of the _message

string get_message ()
render (line 60)

We override the render function

because we want to wrap the table inside a form tag

void render ([mixed $indent_level = 1], mixed $output_debug)

Redefinition of:

DialogWidget::render()
  Creates a container with title,

set_message (line 96)

This sets the _message for the _message window.

void set_message (string $mesg)

- string $mesg: - the _message to display

#### Inherited Methods

Inherited From StandardDialogWidget

> StandardDialogWidget::add_block()
> StandardDialogWidget::_build_message_container()

Inherited From DialogWidget

> DialogWidget::DialogWidget()
> DialogWidget::add()
> DialogWidget::add_button()
> DialogWidget::render()
> DialogWidget::set_cancel_url()
> DialogWidget::show_cancel_button()
> DialogWidget::_build_cancel_url()
> DialogWidget::_build_message_container()

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:06:06 -0700 by phpDocumentor 1.3.0RC3