HTML_Progress
[ class tree: HTML_Progress ] [ index: HTML_Progress ] [ all elements ]
Packages:
HTML_Progress


Files:
highlighter.php
Progress.php

subpackage Examples
ancestor.php
basic.php
bgimages.php
bluesand.php
bluesandplus.php
bullit.php
circleback.php
circleplain.php
complex.php
custom.php
default.php
default.php
default1.php
default2.php
ellipse.php
embedded.php
formbasic.php
formpopup.php
formselfref.php
ftpupload.php
function_callback.php
half_basic.php
half_monitor.php
hbar.php
hidden.php
htmlpage.php
htmlpage.php
inicommented.php
itdynamic.php
itdynamic.php
itxstatic.php
javadanse.php
limit.php
method_callback.php
mixedupload.php
model.php
nostring.php
progressbar.php
rectangle.php
rectangleback.php
redsandback.php
shockwaveflash.php
simple.php
smallest.php
smartydynamic.php
square.php
squareback.php
string.php
vbar.php
vertical.php

subpackage Progress_DM
DM.php

subpackage Progress_Observer
monitor.php
observer.php

subpackage Progress_UI
default.php
generator.php
HTMLPage.php
ITDynamic.php
model.php
pages.php
preview.php
process.php
SmartyDynamic.php
UI.php

Classes:
Progress_UI
   ActionDisplay
   ActionPreview
   ActionProcess
   HTML_Progress_Generator
   HTML_Progress_Model
   HTML_Progress_UI
Progress_DM
   HTML_Progress_DM
Progress_Observer
   HTML_Progress_Monitor
   HTML_Progress_Observer
HTML_Progress

Class: HTML_Progress_Generator

Source Location: /Progress/generator.php

Class Overview

HTML_QuickForm_Controller
   |
   --HTML_Progress_Generator

The HTML_Progress_Generator class provides an easy way to dynamic build Progress bar, show a preview, and save php/css code for a later reuse.


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 1997-2005 The PHP Group

Methods

Inherited Variables

Inherited Methods

Class Details

[line 56]
The HTML_Progress_Generator class provides an easy way to dynamic build Progress bar, show a preview, and save php/css code for a later reuse.

PHP versions 4 and 5

LICENSE: This source file is subject to version 3.0 of the PHP license that is available through the world-wide-web at the following URI: http://www.php.net/license/3_0.txt. If you did not receive a copy of the PHP License and are unable to obtain it through the web, please send a note to license@php.net so we can mail you a copy immediately.




Tags:

link:  http://pear.php.net/package/HTML_Progress
version:  Release: @package_version@
license:  PHP License 3.0
copyright:  1997-2005 The PHP Group
author:  Laurent Laville <mailto:pear@laurent-laville.org>


[ Top ]

Class Methods

constructor HTML_Progress_Generator [line 124]

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

Constructor Summary

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

    1     $controllerName = 'myPrivateGenerator';
    2        $attributes = array(
    3             'preview' => name of a HTML_QuickForm_Action instance
    4                          (default 'ActionPreview', see 'HTML/Progress/generator/preview.php')
    5             'display' => name of a HTML_QuickForm_Action_Display instance
    6                          (default 'ActionDisplay', see 'HTML/Progress/generator/default.php')
    7             'process' => name of a HTML_QuickForm_Action instance
    8                          (default 'ActionProcess', see 'HTML/Progress/generator/process.php')
    9        );
    10       $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 284]

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 428]

object HTML_Progress createProgressBar( )

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



Tags:

return:  instance
access:  public
since:  1.1


[ Top ]

method createTabs [line 242]

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 388]

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 342]

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, 25 Sep 2005 17:25:28 +0200 by phpDocumentor 1.2.3