| Current File : //opt/RZphp71/includes/doc/HTML_Progress/docs/TDG/elementindex_HTML_Progress.html |
<html>
<head>
<title>Package HTML_Progress Element Index</title>
<link rel="stylesheet" type="text/css" href="media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">HTML_Progress</td>
</tr>
<tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ]
[ <a href="elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ]
[ <a href="elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<a name="top"></a>
<h1>Element index for package HTML_Progress</h1>
[ <a href="elementindex_HTML_Progress.html#a">a</a> ]
[ <a href="elementindex_HTML_Progress.html#b">b</a> ]
[ <a href="elementindex_HTML_Progress.html#c">c</a> ]
[ <a href="elementindex_HTML_Progress.html#d">d</a> ]
[ <a href="elementindex_HTML_Progress.html#e">e</a> ]
[ <a href="elementindex_HTML_Progress.html#g">g</a> ]
[ <a href="elementindex_HTML_Progress.html#h">h</a> ]
[ <a href="elementindex_HTML_Progress.html#i">i</a> ]
[ <a href="elementindex_HTML_Progress.html#m">m</a> ]
[ <a href="elementindex_HTML_Progress.html#n">n</a> ]
[ <a href="elementindex_HTML_Progress.html#o">o</a> ]
[ <a href="elementindex_HTML_Progress.html#p">p</a> ]
[ <a href="elementindex_HTML_Progress.html#r">r</a> ]
[ <a href="elementindex_HTML_Progress.html#s">s</a> ]
[ <a href="elementindex_HTML_Progress.html#t">t</a> ]
[ <a href="elementindex_HTML_Progress.html#u">u</a> ]
[ <a href="elementindex_HTML_Progress.html#w">w</a> ]
[ <a href="elementindex_HTML_Progress.html#_">_</a> ]
<hr />
<a name="_"></a>
<div>
<h2>_</h2>
<dl>
<dt><b>_attributesArray</b></dt>
<dd>in file process.php, method <a href="HTML_Progress/Progress_UI/ActionProcess.html#method_attributesArray">ActionProcess::_attributesArray()</a></dd>
<dt><b>_renderForm</b></dt>
<dd>in file default.php, method <a href="HTML_Progress/Progress_UI/ActionDisplay.html#method_renderForm">ActionDisplay::_renderForm()</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="a"></a>
<div>
<h2>a</h2>
<dl>
<dt><b>addListener</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodaddListener">HTML_Progress::addListener()</a><br> Adds a HTML_Progress_Observer instance to the list of observers that are listening for messages emitted by this HTML_Progress instance.</dd>
<dt><b>apiVersion</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodapiVersion">HTML_Progress::apiVersion()</a><br> Returns the current API version</dd>
<dt><b>accept</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodaccept">HTML_Progress_Monitor::accept()</a><br> Accepts a renderer</dd>
<dt><b>ActionDisplay</b></dt>
<dd>in file default.php, class <a href="HTML_Progress/Progress_UI/ActionDisplay.html">ActionDisplay</a><br> The ActionDisplay class provides the default form rendering.</dd>
<dt><b>ActionPreview</b></dt>
<dd>in file preview.php, class <a href="HTML_Progress/Progress_UI/ActionPreview.html">ActionPreview</a><br> The ActionPreview class provides a live demonstration of the progress bar built by HTML_Progress_Generator.</dd>
<dt><b>ActionProcess</b></dt>
<dd>in file process.php, class <a href="HTML_Progress/Progress_UI/ActionProcess.html">ActionProcess</a><br> The ActionProcess class provides final step of ProgressBar creation.</dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="b"></a>
<div>
<h2>b</h2>
<dl>
<dt><b>$buttonCancel</b></dt>
<dd>in file monitor.php, variable <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#var$buttonCancel">HTML_Progress_Monitor::$buttonCancel</a><br> Attributes of monitor form.</dd>
<dt><b>$buttonStart</b></dt>
<dd>in file monitor.php, variable <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#var$buttonStart">HTML_Progress_Monitor::$buttonStart</a><br> Attributes of monitor form.</dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="c"></a>
<div>
<h2>c</h2>
<dl>
<dt><b>callProgressHandler</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodcallProgressHandler">HTML_Progress_Monitor::callProgressHandler()</a><br> Calls a user-defined progress handler function.</dd>
<dt><b>createButtons</b></dt>
<dd>in file generator.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodcreateButtons">HTML_Progress_Generator::createButtons()</a><br> Adds all necessary buttons to the given page object.</dd>
<dt><b>createProgressBar</b></dt>
<dd>in file generator.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodcreateProgressBar">HTML_Progress_Generator::createProgressBar()</a><br> Creates a progress bar with options choosen on all wizard tabs.</dd>
<dt><b>createTabs</b></dt>
<dd>in file generator.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodcreateTabs">HTML_Progress_Generator::createTabs()</a><br> Adds all necessary tabs to the given page object.</dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="d"></a>
<div>
<h2>d</h2>
<dl>
<dt><b>display</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methoddisplay">HTML_Progress::display()</a><br> Renders the new value of progress bar.</dd>
<dt><b>DM.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_DM/_Progress_Progress_DM_php.html">DM.php</a></dd>
<dt><b>disableButton</b></dt>
<dd>in file generator.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methoddisableButton">HTML_Progress_Generator::disableButton()</a><br> Disables certain buttons for a page.</dd>
<dt><b>drawCircleSegments</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methoddrawCircleSegments">HTML_Progress_UI::drawCircleSegments()</a><br> Draw all circle segment pictures</dd>
<dt><b>default.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_generator_default_php.html">default.php</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="e"></a>
<div>
<h2>e</h2>
<dl>
<dt><b>enableButton</b></dt>
<dd>in file generator.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodenableButton">HTML_Progress_Generator::enableButton()</a><br> Enables certain buttons for a page.</dd>
<dt><b>exportOutput</b></dt>
<dd>in file process.php, method <a href="HTML_Progress/Progress_UI/ActionProcess.html#methodexportOutput">ActionProcess::exportOutput()</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="g"></a>
<div>
<h2>g</h2>
<dl>
<dt><b>getAnimSpeed</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetAnimSpeed">HTML_Progress::getAnimSpeed()</a><br> Returns delay execution of the progress bar</dd>
<dt><b>getDM</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetDM">HTML_Progress::getDM()</a><br> Returns the data model used by this progress bar.</dd>
<dt><b>getError</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetError">HTML_Progress::getError()</a><br> Pop an error off of the HTML_Progress stack</dd>
<dt><b>getIdent</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetIdent">HTML_Progress::getIdent()</a><br> Returns the current identification string.</dd>
<dt><b>getIncrement</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetIncrement">HTML_Progress::getIncrement()</a><br> Returns the progress bar's increment value stored in the progress bar's data model.</dd>
<dt><b>getListeners</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetListeners">HTML_Progress::getListeners()</a><br> Returns an array of all the listeners added to this progress bar.</dd>
<dt><b>getMaximum</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetMaximum">HTML_Progress::getMaximum()</a><br> Returns the progress bar's maximum value stored in the progress bar's data model.</dd>
<dt><b>getMinimum</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetMinimum">HTML_Progress::getMinimum()</a><br> Returns the progress bar's minimum value stored in the progress bar's data model.</dd>
<dt><b>getPercentComplete</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetPercentComplete">HTML_Progress::getPercentComplete()</a><br> Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00.</dd>
<dt><b>getScript</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetScript">HTML_Progress::getScript()</a><br> Get the javascript code to manage progress bar.</dd>
<dt><b>getString</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetString">HTML_Progress::getString()</a><br> Returns the current value of the progress string.</dd>
<dt><b>getStyle</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetStyle">HTML_Progress::getStyle()</a><br> Get the cascading style sheet to put inline on HTML document</dd>
<dt><b>getUI</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetUI">HTML_Progress::getUI()</a><br> Returns the look-and-feel object that renders the progress bar.</dd>
<dt><b>getValue</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodgetValue">HTML_Progress::getValue()</a><br> Returns the progress bar's current value, which is stored in the progress bar's data model. The value is always between the minimum and maximum values, inclusive.</dd>
<dt><b>getIncrement</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetIncrement">HTML_Progress_DM::getIncrement()</a><br> Returns the progress bar's increment value. The default value is +1.</dd>
<dt><b>getMaximum</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetMaximum">HTML_Progress_DM::getMaximum()</a><br> Returns the progress bar's maximum value. The default value is 100.</dd>
<dt><b>getMinimum</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetMinimum">HTML_Progress_DM::getMinimum()</a><br> Returns the progress bar's minimum value. The default value is 0.</dd>
<dt><b>getPercentComplete</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetPercentComplete">HTML_Progress_DM::getPercentComplete()</a><br> Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00.</dd>
<dt><b>getValue</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetValue">HTML_Progress_DM::getValue()</a><br> Returns the progress bar's current value. The value is always between the minimum and maximum values, inclusive.</dd>
<dt><b>getProgressElement</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodgetProgressElement">HTML_Progress_Monitor::getProgressElement()</a><br> Returns a reference to the progress bar object used with the monitor.</dd>
<dt><b>getScript</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodgetScript">HTML_Progress_Monitor::getScript()</a><br> Returns progress javascript.</dd>
<dt><b>getStyle</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodgetStyle">HTML_Progress_Monitor::getStyle()</a><br> Returns progress styles (StyleSheet).</dd>
<dt><b>getBorderAttributes</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetBorderAttributes">HTML_Progress_UI::getBorderAttributes()</a><br> Returns the progress bar's border attributes. Assoc array (defaut) or string.</dd>
<dt><b>getCellAttributes</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellAttributes">HTML_Progress_UI::getCellAttributes()</a><br> Returns the common and private cell attributes. Assoc array (defaut) or string</dd>
<dt><b>getCellCoordinates</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellCoordinates">HTML_Progress_UI::getCellCoordinates()</a><br> Returns the coordinates of each cell for a polygonal progress shape.</dd>
<dt><b>getCellCount</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellCount">HTML_Progress_UI::getCellCount()</a><br> Returns the number of cell in the progress bar. The default value is 10.</dd>
<dt><b>getFillWay</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetFillWay">HTML_Progress_UI::getFillWay()</a><br> Returns 'natural' or 'reverse', depending of the fill way of progress bar.</dd>
<dt><b>getOrientation</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetOrientation">HTML_Progress_UI::getOrientation()</a><br> Returns HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL, depending on the orientation of the progress bar.</dd>
<dt><b>getProgressAttributes</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetProgressAttributes">HTML_Progress_UI::getProgressAttributes()</a><br> Returns the progress attributes. Assoc array (defaut) or string.</dd>
<dt><b>getScript</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetScript">HTML_Progress_UI::getScript()</a><br> Get the javascript code to manage progress bar.</dd>
<dt><b>getStringAttributes</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStringAttributes">HTML_Progress_UI::getStringAttributes()</a><br> Returns the string attributes. Assoc array (defaut) or string.</dd>
<dt><b>getStyle</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStyle">HTML_Progress_UI::getStyle()</a><br> Get the cascading style sheet to put inline on HTML document</dd>
<dt><b>generator.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_generator_php.html">generator.php</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="h"></a>
<div>
<h2>h</h2>
<dl>
<dt><b>hasErrors</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodhasErrors">HTML_Progress::hasErrors()</a><br> Determine whether there are errors into the HTML_Progress stack</dd>
<dt><b>hide</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodhide">HTML_Progress::hide()</a><br> Hides the progress bar.</dd>
<dt><b>HTML_Progress</b></dt>
<dd>in file Progress.php, class <a href="HTML_Progress/HTML_Progress.html">HTML_Progress</a></dd>
<dt><b>HTML_Progress</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodHTML_Progress">HTML_Progress::HTML_Progress()</a><br> Constructor Summary</dd>
<dt><b>HTML_PROGRESS_BAR_HORIZONTAL</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_BAR_HORIZONTAL">HTML_PROGRESS_BAR_HORIZONTAL</a><br> Progress Bar shape types</dd>
<dt><b>HTML_PROGRESS_BAR_VERTICAL</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_BAR_VERTICAL">HTML_PROGRESS_BAR_VERTICAL</a><br> Progress Bar shape types</dd>
<dt><b>HTML_PROGRESS_CIRCLE</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_CIRCLE">HTML_PROGRESS_CIRCLE</a><br> Progress Bar shape types</dd>
<dt><b>HTML_PROGRESS_DEPRECATED</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_DEPRECATED">HTML_PROGRESS_DEPRECATED</a><br> Basic error code that indicate a deprecated method that may be removed at any time from a future version</dd>
<dt><b>HTML_PROGRESS_ERRORSTACK_IGNORE</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_ERRORSTACK_IGNORE">HTML_PROGRESS_ERRORSTACK_IGNORE</a><br> If this is returned, then the error is completely ignored.</dd>
<dt><b>HTML_PROGRESS_ERRORSTACK_LOG</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_ERRORSTACK_LOG">HTML_PROGRESS_ERRORSTACK_LOG</a><br> If this is returned, then the error will only be logged, but not pushed onto the error stack.</dd>
<dt><b>HTML_PROGRESS_ERRORSTACK_LOGANDDIE</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_ERRORSTACK_LOGANDDIE">HTML_PROGRESS_ERRORSTACK_LOGANDDIE</a><br> If this is returned, then the error will only be logged, but not pushed onto the error stack because will halt script execution.</dd>
<dt><b>HTML_PROGRESS_ERRORSTACK_PUSH</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_ERRORSTACK_PUSH">HTML_PROGRESS_ERRORSTACK_PUSH</a><br> If this is returned, then the error will only be pushed onto the stack, and not logged.</dd>
<dt><b>HTML_PROGRESS_ERRORSTACK_PUSHANDLOG</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_ERRORSTACK_PUSHANDLOG">HTML_PROGRESS_ERRORSTACK_PUSHANDLOG</a><br> If this is returned, then the error will be both pushed onto the stack and logged.</dd>
<dt><b>HTML_PROGRESS_ERROR_INVALID_CALLBACK</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_ERROR_INVALID_CALLBACK">HTML_PROGRESS_ERROR_INVALID_CALLBACK</a><br> Basic error code that indicate a wrong callback definition.</dd>
<dt><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_ERROR_INVALID_INPUT">HTML_PROGRESS_ERROR_INVALID_INPUT</a><br> Basic error code that indicate a wrong input</dd>
<dt><b>HTML_PROGRESS_LOG_TYPE_FILE</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_LOG_TYPE_FILE">HTML_PROGRESS_LOG_TYPE_FILE</a><br> Append to a file</dd>
<dt><b>HTML_PROGRESS_LOG_TYPE_MAIL</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_LOG_TYPE_MAIL">HTML_PROGRESS_LOG_TYPE_MAIL</a><br> Use PHP's mail() function</dd>
<dt><b>HTML_PROGRESS_LOG_TYPE_SYSTEM</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_LOG_TYPE_SYSTEM">HTML_PROGRESS_LOG_TYPE_SYSTEM</a><br> Use PHP's system logger</dd>
<dt><b>HTML_PROGRESS_POLYGONAL</b></dt>
<dd>in file Progress.php, constant <a href="HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_POLYGONAL">HTML_PROGRESS_POLYGONAL</a><br> Progress Bar shape types</dd>
<dt><b>HTML_Progress_DM</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodHTML_Progress_DM">HTML_Progress_DM::HTML_Progress_DM()</a><br> The data model class constructor</dd>
<dt><b>HTML_Progress_DM</b></dt>
<dd>in file DM.php, class <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html">HTML_Progress_DM</a><br> The HTML_Progress_DM class handles any mathematical issues arising from assigning faulty values.</dd>
<dt><b>HTML_Progress_Monitor</b></dt>
<dd>in file monitor.php, class <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html">HTML_Progress_Monitor</a></dd>
<dt><b>HTML_Progress_Monitor</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodHTML_Progress_Monitor">HTML_Progress_Monitor::HTML_Progress_Monitor()</a><br> Constructor Summary</dd>
<dt><b>HTML_Progress_Observer</b></dt>
<dd>in file observer.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Observer.html#methodHTML_Progress_Observer">HTML_Progress_Observer::HTML_Progress_Observer()</a><br> Creates a new basic HTML_Progress_Observer instance.</dd>
<dt><b>HTML_Progress_Observer</b></dt>
<dd>in file observer.php, class <a href="HTML_Progress/Progress_Observer/HTML_Progress_Observer.html">HTML_Progress_Observer</a><br> The HTML_Progress_Observer implements the observer pattern for watching progress bar activity and taking actions on exceptional events.</dd>
<dt><b>HTML_Progress_Generator</b></dt>
<dd>in file generator.php, class <a href="HTML_Progress/Progress_UI/HTML_Progress_Generator.html">HTML_Progress_Generator</a></dd>
<dt><b>HTML_Progress_Generator</b></dt>
<dd>in file generator.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_Generator.html#methodHTML_Progress_Generator">HTML_Progress_Generator::HTML_Progress_Generator()</a><br> Constructor Summary</dd>
<dt><b>HTML_Progress_UI</b></dt>
<dd>in file UI.php, class <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html">HTML_Progress_UI</a></dd>
<dt><b>HTML_Progress_UI</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodHTML_Progress_UI">HTML_Progress_UI::HTML_Progress_UI()</a><br> The progress bar's UI model class constructor</dd>
<dt><b>HTMLPage.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_generator_HTMLPage_php.html">HTMLPage.php</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="i"></a>
<div>
<h2>i</h2>
<dl>
<dt><b>incValue</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodincValue">HTML_Progress::incValue()</a><br> Updates the progress bar's current value by adding increment value.</dd>
<dt><b>isBorderPainted</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodisBorderPainted">HTML_Progress::isBorderPainted()</a><br> Determines whether the progress bar border is painted or not.</dd>
<dt><b>isIndeterminate</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodisIndeterminate">HTML_Progress::isIndeterminate()</a><br> Returns mode of the progress bar (determinate or not).</dd>
<dt><b>isStringPainted</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodisStringPainted">HTML_Progress::isStringPainted()</a><br> Determines whether the progress bar string is painted or not.</dd>
<dt><b>incValue</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodincValue">HTML_Progress_DM::incValue()</a><br> Updates the progress bar's current value by adding increment value.</dd>
<dt><b>isCanceled</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodisCanceled">HTML_Progress_Monitor::isCanceled()</a><br> Returns TRUE if progress was canceled by user, FALSE otherwise.</dd>
<dt><b>isStarted</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodisStarted">HTML_Progress_Monitor::isStarted()</a><br> Returns TRUE if progress was started by user, FALSE otherwise.</dd>
<dt><b>ITDynamic.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_generator_ITDynamic_php.html">ITDynamic.php</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="m"></a>
<div>
<h2>m</h2>
<dl>
<dt><b>monitor.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_Observer/_Progress_Progress_monitor_php.html">monitor.php</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="n"></a>
<div>
<h2>n</h2>
<dl>
<dt><b>notify</b></dt>
<dd>in file observer.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Observer.html#methodnotify">HTML_Progress_Observer::notify()</a><br> This is a stub method to make sure that HTML_Progress_Observer classes do something when they are notified of a message. The default behavior is to just write into a file 'progress_observer.log' in current directory.</dd>
<dt><b>notify</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodnotify">HTML_Progress_Monitor::notify()</a><br> Listens all progress events from this monitor.</dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="o"></a>
<div>
<h2>o</h2>
<dl>
<dt><b>observer.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_Observer/_Progress_Progress_observer_php.html">observer.php</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="p"></a>
<div>
<h2>p</h2>
<dl>
<dt><b>process</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodprocess">HTML_Progress::process()</a><br> Performs the progress actions</dd>
<dt><b>Progress.php</b></dt>
<dd>procedural page <a href="HTML_Progress/_Progress_Progress_php.html">Progress.php</a></dd>
<dt><b>perform</b></dt>
<dd>in file process.php, method <a href="HTML_Progress/Progress_UI/ActionProcess.html#methodperform">ActionProcess::perform()</a></dd>
<dt><b>perform</b></dt>
<dd>in file preview.php, method <a href="HTML_Progress/Progress_UI/ActionPreview.html#methodperform">ActionPreview::perform()</a></dd>
<dt><b>pages.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_generator_pages_php.html">pages.php</a></dd>
<dt><b>preview.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_generator_preview_php.html">preview.php</a></dd>
<dt><b>process.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_generator_process_php.html">process.php</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="r"></a>
<div>
<h2>r</h2>
<dl>
<dt><b>raiseError</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodraiseError">HTML_Progress::raiseError()</a><br> Add an error to the stack</dd>
<dt><b>removeListener</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodremoveListener">HTML_Progress::removeListener()</a><br> Removes a HTML_Progress_Observer instance from the list of observers.</dd>
<dt><b>run</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodrun">HTML_Progress::run()</a><br> Runs the progress bar (both modes: indeterminate and determinate), and execute all actions defined in user callback identified by method setProgressHandler.</dd>
<dt><b>run</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodrun">HTML_Progress_Monitor::run()</a><br> Display Monitor and catch user action (cancel button).</dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="s"></a>
<div>
<h2>s</h2>
<dl>
<dt><b>setAnimSpeed</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetAnimSpeed">HTML_Progress::setAnimSpeed()</a><br> Set the delays progress bar execution for the given number of miliseconds.</dd>
<dt><b>setBorderPainted</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetBorderPainted">HTML_Progress::setBorderPainted()</a><br> Sets the value of $_paintBorder property, which determines whether the progress bar should paint its border. The default is false.</dd>
<dt><b>setDM</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetDM">HTML_Progress::setDM()</a><br> Sets the data model used by this progress bar.</dd>
<dt><b>setIdent</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetIdent">HTML_Progress::setIdent()</a><br> Sets this Progress instance's identification string.</dd>
<dt><b>setIncrement</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetIncrement">HTML_Progress::setIncrement()</a><br> Sets the progress bar's increment value stored in the progress bar's data model.</dd>
<dt><b>setIndeterminate</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetIndeterminate">HTML_Progress::setIndeterminate()</a><br> Sets the $_indeterminate property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode.</dd>
<dt><b>setMaximum</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetMaximum">HTML_Progress::setMaximum()</a><br> Sets the progress bar's maximum value stored in the progress bar's data model.</dd>
<dt><b>setMinimum</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetMinimum">HTML_Progress::setMinimum()</a><br> Sets the progress bar's minimum value stored in the progress bar's data model.</dd>
<dt><b>setModel</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetModel">HTML_Progress::setModel()</a><br> Sets the look-and-feel model that renders the progress bar.</dd>
<dt><b>setProgressHandler</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetProgressHandler">HTML_Progress::setProgressHandler()</a><br> Sets the user callback function that execute all actions pending progress</dd>
<dt><b>setString</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetString">HTML_Progress::setString()</a><br> Sets the current value of the progress string. By default, this string is null. If you have provided a custom progress string and want to revert to the built-in-behavior, set the string back to null.</dd>
<dt><b>setStringPainted</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetStringPainted">HTML_Progress::setStringPainted()</a><br> Sets the value of $_paintString property, which determines whether the progress bar should render a progress string. The default is false.</dd>
<dt><b>setUI</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetUI">HTML_Progress::setUI()</a><br> Sets the look-and-feel object that renders the progress bar.</dd>
<dt><b>setValue</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsetValue">HTML_Progress::setValue()</a><br> Sets the progress bar's current value stored in the progress bar's data model.</dd>
<dt><b>sleep</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodsleep">HTML_Progress::sleep()</a><br> Default user callback when none are defined.</dd>
<dt><b>setIncrement</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodsetIncrement">HTML_Progress_DM::setIncrement()</a><br> Sets the progress bar's increment value.</dd>
<dt><b>setMaximum</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodsetMaximum">HTML_Progress_DM::setMaximum()</a><br> Sets the progress bar's maximum value.</dd>
<dt><b>setMinimum</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodsetMinimum">HTML_Progress_DM::setMinimum()</a><br> Sets the progress bar's minimum value.</dd>
<dt><b>setValue</b></dt>
<dd>in file DM.php, method <a href="HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodsetValue">HTML_Progress_DM::setValue()</a><br> Sets the progress bar's current value.</dd>
<dt><b>setCaption</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodsetCaption">HTML_Progress_Monitor::setCaption()</a><br> Display a caption on action in progress.</dd>
<dt><b>setProgressElement</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodsetProgressElement">HTML_Progress_Monitor::setProgressElement()</a><br> Attach a progress bar to this monitor.</dd>
<dt><b>setProgressHandler</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodsetProgressHandler">HTML_Progress_Monitor::setProgressHandler()</a><br> Sets a user-defined progress handler function.</dd>
<dt><b>SmartyDynamic.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_generator_SmartyDynamic_php.html">SmartyDynamic.php</a></dd>
<dt><b>setBorderAttributes</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetBorderAttributes">HTML_Progress_UI::setBorderAttributes()</a><br> Sets the progress bar's border attributes.</dd>
<dt><b>setCellAttributes</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellAttributes">HTML_Progress_UI::setCellAttributes()</a><br> Sets the cell attributes for an existing cell.</dd>
<dt><b>setCellCoordinates</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellCoordinates">HTML_Progress_UI::setCellCoordinates()</a><br> Set the coordinates of each cell for a polygonal progress shape.</dd>
<dt><b>setCellCount</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellCount">HTML_Progress_UI::setCellCount()</a><br> Sets the number of cell in the progress bar</dd>
<dt><b>setFillWay</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetFillWay">HTML_Progress_UI::setFillWay()</a><br> Sets the progress bar's fill way, which must be 'natural' or 'reverse'.</dd>
<dt><b>setOrientation</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetOrientation">HTML_Progress_UI::setOrientation()</a><br> Sets the progress bar's orientation, which must be HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL.</dd>
<dt><b>setProgressAttributes</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetProgressAttributes">HTML_Progress_UI::setProgressAttributes()</a><br> Sets the common progress bar attributes.</dd>
<dt><b>setScript</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetScript">HTML_Progress_UI::setScript()</a><br> Set the external JavaScript code (file) to manage progress element.</dd>
<dt><b>setStringAttributes</b></dt>
<dd>in file UI.php, method <a href="HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetStringAttributes">HTML_Progress_UI::setStringAttributes()</a><br> Sets the string attributes.</dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="t"></a>
<div>
<h2>t</h2>
<dl>
<dt><b>toArray</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodtoArray">HTML_Progress::toArray()</a><br> Returns the progress bar structure in an array.</dd>
<dt><b>toHtml</b></dt>
<dd>in file Progress.php, method <a href="HTML_Progress/HTML_Progress.html#methodtoHtml">HTML_Progress::toHtml()</a><br> Returns the progress structure as HTML.</dd>
<dt><b>toHtml</b></dt>
<dd>in file monitor.php, method <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodtoHtml">HTML_Progress_Monitor::toHtml()</a><br> Returns Monitor forms as a Html string.</dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="u"></a>
<div>
<h2>u</h2>
<dl>
<dt><b>UI.php</b></dt>
<dd>procedural page <a href="HTML_Progress/Progress_UI/_Progress_Progress_UI_php.html">UI.php</a></dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<hr />
<a name="w"></a>
<div>
<h2>w</h2>
<dl>
<dt><b>$windowname</b></dt>
<dd>in file monitor.php, variable <a href="HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#var$windowname">HTML_Progress_Monitor::$windowname</a><br> Attributes of monitor form.</dd>
</dl>
</div>
<a href="elementindex_HTML_Progress.html#top">top</a><br>
<div class="credit">
<hr />
Documentation generated on Sun, 12 Sep 2004 20:23:39 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>