Docs For Class HTML_Progress_Generator

HTML_Progress

# Class: HTML_Progress_Generator Source Location: /Progress/generator.php
### Class Overview
    HTML_QuickForm_Controller
       |
       --HTML_Progress_Generator
| ### Methods HTML_Progress_Generator createButtons createProgressBar createTabs disableButton enableButton
### Class Details [line 42] [ Top ] ### Class Methods ### constructor HTML_Progress_Generator [line 110]
`HTML_Progress_Generator HTML_Progress_Generator( [mixed $controllerName = 'ProgressGenerator'], [array $attributes = array()], [array $errorPrefs = 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);
#### Tags:
throws: | HTML_PROGRESS_ERROR_INVALID_INPUT
access: | public
since: | 1.1
#### Parameters:
string | $controllerName(optional) | Name of generator wizard (QuickForm)
array | $attributes | (optional) List of renderer options
array | $errorPrefs | (optional) Hash of params to configure error handler
[ Top ] ### method createButtons [line 270]
`void createButtons( object &$page, array $buttons, [mixed $attributes = null])`
Adds all necessary buttons to the given page object. #### Tags:
throws: | HTML_PROGRESS_ERROR_INVALID_INPUT
access: | public
since: | 1.1
#### 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.
[ Top ] ### method createProgressBar [line 413]
`void createProgressBar( )`
Creates a progress bar with options choosen on all wizard tabs. #### Tags:
access: | public
since: | 1.1
[ Top ] ### method createTabs [line 228]
`void createTabs( object &$page, [mixed $attributes = null])`
Adds all necessary tabs to the given page object. #### Tags:
throws: | HTML_PROGRESS_ERROR_INVALID_INPUT
access: | public
since: | 1.1
#### Parameters:
object | $page | Page where to put the button
mixed | $attributes | (optional) Either a typical HTML attribute string or an associative array.
[ Top ] ### method disableButton [line 374]
`void disableButton( object &$page, [array $events = array()])`
Disables certain buttons for a page. Buttons [ = events] : back, next, cancel, reset, apply, help #### Tags:
see: | HTML_Progress_Generator::enableButton()
throws: | HTML_PROGRESS_ERROR_INVALID_INPUT
access: | public
since: | 1.1
#### Parameters:
object | $page | Page where you want to activate buttons
array | $events | (optional) List of buttons
[ Top ] ### method enableButton [line 328]
`void enableButton( object &$page, [array $events = array()])`
Enables certain buttons for a page. Buttons [ = events] : back, next, cancel, reset, apply, help #### Tags:
see: | HTML_Progress_Generator::disableButton()
throws: | HTML_PROGRESS_ERROR_INVALID_INPUT
access: | public
since: | 1.1
#### Parameters:
object | $page | Page where you want to activate buttons
array | $events | (optional) List of buttons
[ Top ] Documentation generated on Sun, 12 Sep 2004 20:23:41 +0200 by phpDocumentor 1.3.0RC3