Docs For Class HTML_Progress

HTML_Progress_Generator (Constructor) [line 109]

HTML_Progress_Generator HTML_Progress_Generator(
[
$controllerName = 'ProgressGenerator'], [array
$attributes = array()], string
$controllerName(optional))

Constructor Summary

Creates a standard progress bar generator wizard.

   $generator = new HTML_Progress_Generator();

Creates a progress bar generator wizard with customized actions: progress bar preview, form rendering, buttons manager

   $controllerName = 'myPrivateGenerator';
   $attributes = array(
        'preview' => name of a HTML_QuickForm_Action instance
                     (default 'ActionPreview', see 'HTML/Progress/generator/preview.php')
        'display' => name of a HTML_QuickForm_Action_Display instance
                     (default 'ActionDisplay', see 'HTML/Progress/generator/default.php')
        'process' => name of a HTML_QuickForm_Action instance
                     (default 'ActionProcess', see 'HTML/Progress/generator/process.php')
   );
   $generator = new HTML_Progress_Generator($controllerName, $attributes);

Since: 1.1
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Access: public

Parameters:

string	`$controllerName(optional)`	—	Name of generator wizard (QuickForm)
array	`$attributes`	—	(optional) List of renderer options
	`$controllerName`	—

[ Top ]

createButtons [line 280]

void createButtons(

&$page, array
$buttons, [mixed
$attributes = null], object
$page)

Adds all necessary buttons to the given page object.

Since: 1.1
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Access: public

Parameters:

object	`$page`	—	Page where to put the button
array	`$buttons`	—	Key/label of each button/event to handle
mixed	`$attributes`	—	(optional) Either a typical HTML attribute string or an associative array.
	`&$page`	—

[ Top ]

createProgressBar [line 423]

void createProgressBar(
)

Creates a progress bar with options choosen on all wizard tabs.

Since: 1.1
Access: public

[ Top ]

createTabs [line 238]

void createTabs(

&$page, [mixed
$attributes = null], object
$page)

Adds all necessary tabs to the given page object.

Since: 1.1
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Access: public

Parameters:

object	`$page`	—	Page where to put the button
mixed	`$attributes`	—	(optional) Either a typical HTML attribute string or an associative array.
	`&$page`	—

[ Top ]

disableButton [line 384]

void disableButton(

&$page, [array
$events = array()], object
$page)

Disables certain buttons for a page.

Buttons [ = events] : back, next, cancel, reset, apply, help

See: enableButton()
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Since: 1.1
Access: public

Parameters:

object	`$page`	—	Page where you want to activate buttons
array	`$events`	—	(optional) List of buttons
	`&$page`	—

[ Top ]

enableButton [line 338]

void enableButton(

&$page, [array
$events = array()], object
$page)

Enables certain buttons for a page.

Buttons [ = events] : back, next, cancel, reset, apply, help

See: disableButton()
Throws: HTML_PROGRESS_ERROR_INVALID_INPUT
Since: 1.1
Access: public

Parameters:

object	`$page`	—	Page where you want to activate buttons
array	`$events`	—	(optional) List of buttons
	`&$page`	—

[ Top ]

Class: HTML_Progress_Generator

Class Overview

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

HTML_Progress_Generator (Constructor) [line 109]

Parameters:

createButtons [line 280]

Parameters:

createProgressBar [line 423]

createTabs [line 238]

Parameters:

disableButton [line 384]

Parameters:

enableButton [line 338]

Parameters: