Docs For Class DialogWidget

Description

This is a base class for building generic Dialogs with messages and buttons.

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

Located in /widgets/DialogWidget.inc (line 22)

Container
   |
   --BaseWidget
      |
      --DialogWidget

Direct descendents

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

Variable Summary

mixed $_buttons

mixed $_cancel_url

mixed $_show_cancel_button

Method Summary

none DialogWidget ([string $title = NULL], [string $width = "100%"], [ $align = NULL])

void add (mixed 0)

void add_button (string $button, string 1)

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

void set_cancel_url (string $url)

void show_cancel_button (bool $flag)

string _build_cancel_url ()

object - &_build_message_container ()

Variables

mixed $_buttons = array() (line 29)

Holds the list of buttons

for this widget dialog

mixed $_cancel_url = NULL (line 41)

Holds the cancel action

mixed $_show_cancel_button = FALSE (line 35)

Show or not to show the cancel button?

Inherited Variables

Inherited from BaseWidget

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

Methods

Constructor DialogWidget (line 51)

The constructor

none DialogWidget ([string $title = NULL], [string $width = "100%"], [ $align = NULL])

string $title: the title
string $width: the width
$align

add (line 85)

Pushes a content into the data object

access: public

void add (mixed 0)

mixed 0: - either string, or tag object.

Redefinition of:

Container::add(): add content onto content stack

add_button (line 103)

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

access: public

void add_button (string $button, string 1)

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

Redefined in descendants as:

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

render (line 62)

Creates a container with title,

data and the buttons

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

$indent_level
$output_debug

Redefinition of:

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

Redefined in descendants as:

MessageBoxWidget::render() : We override the render function

set_cancel_url (line 123)

Sets the cancel action

void set_cancel_url (string $url)

string $url: - action

show_cancel_button (line 114)

Sets the flag to show or not to show the cancel button

void show_cancel_button (bool $flag)

bool $flag: - flag

_build_cancel_url (line 165)

Build the cancel url

string _build_cancel_url ()

_build_message_container (line 179)

This method is used to add the message blocks to the appropriate container

return: the container object with the messages.

object - &_build_message_container ()

Redefined in descendants as:

StandardDialogWidget::_build_message_container() : This method is used to add the message blocks to the appropriate container

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