<!-- saved from url=(0022)https://internet.e-mail -->
<html>
<head>
<title>ProgressClass v1.0 Anleitung</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">
<!--
.normal { font-family: Arial, Helvetica, sans-serif; font-size: 12px; text-align: justify}
.klein { font-family: Arial, Helvetica, sans-serif; font-size: 10px}
.ueberschrift { font-family: Arial, Helvetica, sans-serif; font-size: 16px; font-weight: bold}
.unterueberschrift { font-family: Arial, Helvetica, sans-serif; font-size: 14px; font-weight: bold; font-style: italic}
.code { font-family: "Courier New", Courier, mono; font-size: 14px; font-weight: bold; color: #000099; text-align: left}
-->
</style>
</head>
<body bgcolor="#FFFFFF" text="#000000">
<p class="normal"><span class="ueberschrift">ProgressClass v1.0 Manual<br>
</span> (c) 2002 by Boris Wylutzki / www.edv-internet.de --- english translation by <a href="mailto:lukas.schmidt123@web.de">L. Schmidt</a></p>
<table width="100%" border="0" bgcolor="#CCCCCC">
<tr>
<td> <p class="klein">This program is freeware. You can modify or pass it
on under the conditions of the GNU general Public License, published by
the Free Software Foundation, either in accordance with version 2 of the
license or (after your option) each later version.<br>
<br>
The publication of this program takes place in the hope that it will be
useful for you, but WITHOUT ANY GUARANTEE, even without the implicit guarantee
of being ready for the market or the USABILITY FOR A CERTAIN PURPOSE.
You can find details in the GNU general Public License. <br>
<br>
You should have received a <a href="license.txt">copy of the GNU general
Public License</a> together with this program. If not, write the Free
software Foundation, Inc., 59 Temple Place, suite 330, Boston, MA 02111-1307,
USA.<br>
<br>
If you need a license for using the application in payable software packages,
please contact the author via www.edv-internet.de.</p>
</td>
</tr>
</table>
<p class="unterueberschrift">Program-description </p>
<p class="normal">ProgressClass makes a PHP-Class for the dynamic display and
change of a progress bar available. In a Windows-styled window, the progress
can even be shown during the execution of the scripts, for example with the
loading or the output of the file, sending of e-mails or processing of data
bases. The progress bar can be faded out at the end of the side. Features: optional
abort button; dynamic change of label, color, percent; free size and positioning.
</p>
<p class="unterueberschrift">System-requirements</p>
<p class="normal"> The server requires PHP 4.x or higher with correctly installed
<a href="https://www.garykeith.com/browsers/browscap.asp" target="_blank">browscap.ini</a>.
The Client requires IE 5.x or higher as well as Netscape 6.x or higher. Other
browsers are not tested. ProgressClass tests the browser version independently
and shows no progress bar on too old versions; an own browser check is not needed.</p>
<p class="unterueberschrift">Installation</p>
<p class="normal">Simply copy the files <span class="code">ProgressClass.php</span>
and <span class="code">js.inc.php</span> onto your Webspace.</p>
<p class="unterueberschrift">Application</p>
<p class="normal">ProgressClass is completely object-oriented. It makes available
a class for generating, editing and removal of the progress bar. If several
progress bars are required, the class can be run in several instances without
problems several times (also simultaneously). Basically, the progress bar works
as follows:</p>
<ol class="normal">
<li>Integrate the class:
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">require('ProgressClass.php');</td>
</tr>
</table>
<br>
</li>
<li>Generate oneinstance of the class:
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress=new ProgressClass();</td>
</tr>
</table>
<br>
</li>
<li>Select the desired options (see below). This step is optional, the class
comes with default settings. Example:
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setWidth(300);<br>
$progress->setPosition('center',20);<br>
... etc. </td>
</tr>
</table>
<br>
</li>
<li>Generate and show progress bar:
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->make();</td>
</tr>
</table>
<br>
</li>
<li>Change the percentage or other attitudes:
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code"> <p>$progress->setPercent(10);<br>
...<br>
$progress->setPercent(45);<br>
...<br>
$progress->setPercent(80);<br>
$progress->setLabel('Clearing RAM...');<br>
...<br>
$progress->setPercent(100);<br>
$progress->setLabel('Done!'); </p></td>
</tr>
</table>
<br>
</li>
<li>Remove progress bar, so that it is no longer shown in the browser:
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->hide();</td>
</tr>
</table>
</li>
</ol>
<p class="unterueberschrift">Description of the functions</p>
<p class="code"><b>ProgressClass()</b></p>
<blockquote>
<p class="normal">The function is called by instancing the class and is makes
internal initializations. You may also use many progress bars (also simultaneously)
through generating instancing of new classes. All progress bars have independ
attitudes to each other and can be shown and changed separately. </p>
<p class="normal">Requires no parameters.</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->new ProgressClass();</td>
</tr>
</table>
</blockquote>
<p class="code">setWidth($width);</p>
<blockquote>
<p class="normal">Defines the width (outer edge of the window) of the progress
bar in pixels. <em>350</em> pixels are default. </p>
<p class="normal">Calling this function after <span class="code">make()</span>
has no effect.</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setWidth(300); </td>
</tr>
</table>
</blockquote>
<p class="code">setPosition($left=NULL,$top=NULL);</p>
<blockquote>
<p class="normal">Defines the position (upper left corner) of the progress bar
(outer edge of the window) within the indicated documents/frames in pixels.
Default is<em> 'center','center-65'</em>.</p>
<p class="normal">The first parameter marks the spacing of the upper left corner
to the left margin, the second to the upper margin. You can also declare only
one of these parameters, then the second one will be kept. If you would like
to declare only the second parameter, the first must be <span class="code">NULL</span>.</p>
<p class="normal">Instead of absolute numbers you also can indicate <span class="code">'center'</span>',
so that the window is centered in the display. Even a combination is possible,
for example<span class="code">'center-30'</span>.</p>
<p class="normal">Calling this function after <span class="code">make()</span>
has no effect.</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setPosition(100,30);</td>
</tr>
</table>
<br>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setPosition(NULL,30); // keep default for
$left</td>
</tr>
</table>
<br>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setPosition(100); // keep default for $top</td>
</tr>
</table>
<br>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setPosition('center','center-30'); // center, shifted
upside a little</td>
</tr>
</table>
</blockquote>
<p class="code">setButton($label,$url,$target='_self')</p>
<blockquote>
<p class="normal">Add a button to the progress bar, on click a new side is opened.
The button can be marked <em>"Abort"</em> for example. If it is
clicked, a new side will be loaded, so that the implementation of the current
site is aborted (only if <em>target=' _self'</em> ). </p>
<p class="normal">The first parameter declares the label of the button, the second
one the target URL. The optional third parameter is used for the link target.</p>
<p class="normal">Calling this function after <span class="code">make()</span>
has no effect.</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setButton('Abort','/pages/abort.php');</td>
</tr>
</table>
<br>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setButton('Info','info.php','_blank');</td>
</tr>
</table>
</blockquote>
<p class="code">setPercent($percent)</p>
<blockquote>
<p class="normal">Defines the percentage of the progress bar. Default is<em>
0</em>. </p>
<p class="normal">The parameter must be a number, without a percent-mark.</p>
<p class="normal"> This function can also be called after <span class="code">make()</span>
more then once in order to change the percentage dynamically (DHTML).</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setPercent(25);</td>
</tr>
</table>
</blockquote>
<p class="code">setPerX($some,$all)</p>
<blockquote>
<p class="normal">Defines the percentage of the progress bar and converts the
specified values into percent..</p>
<p class="normal">The first parameter represents the current position of altogether
as much positions as second parameter indicates. If you read a file or a MySQL-Result,
you hand over the number of the entries for <span class="code">$all</span>
and for <span class="code">$some</span> the current position of the pointer
of the file/result.</p>
<p class="normal">This function can also be called after <span class="code">make()</span> more then once in order to change the percentage dynamically (DHTML).</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$gesamt=1500;<br>
for ($i=1;$i<=$gesamt;$i++)<br>
$progress->setPerX($i,$gesamt);</td>
</tr>
</table>
</blockquote>
<p class="code">setLabel($label)</p>
<blockquote>
<p class="normal">Defines the label of the progress bar. Default is<em> "Please
wait..."</em></p>
<p class="normal">This function can also be called after <span class="code">make()</span>
more then once in order to change the percentage dynamically (DHTML).</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setLabel('Seite wird geladen ...');</td>
</tr>
</table>
</blockquote>
<p class="code">setBarColor($color)</p>
<blockquote>
<p class="normal">Defines the color of the progress bar. Default is <em>dark-blue</em>.</p>
<p class="normal">The color has to be declared in HTML-Color-Code. </p>
<p class="normal">This function can also be called after <span class="code">make()</span>
more then once in order to change the percentage dynamically (DHTML).</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->setBarColor('#FF0000'); // red</td>
</tr>
</table>
</blockquote>
<p class="code">hide()</p>
<blockquote>
<p class="normal">Make the progress bar invisible. Should be called in the end,
so that the visitor can view the side without the progress bar.</p>
<p class="normal">Requires no parameters.</p>
<p class="normal">This function should only be called after <span class="code">make()</span>
(DHTML).</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->hide();</td>
</tr>
</table>
</blockquote>
<p class="code">show()</p>
<blockquote>
<p class="normal">Shows the progress bar and is meaningful, for example if previously
make(false) was called.</p>
<p class="normal">Requires no parameters.</p>
<p class="normal">This function should only be called after <span class="code">make()</span>
(DHTML).</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->show();</td>
</tr>
</table>
</blockquote>
<p class="code"><b>make($show=true)</b></p>
<blockquote>
<p class="normal">Creates the progress bar and passes it to the browser. </p>
<p class="normal"><b><font color="#FF0000">Important:</font> The function must
only be called after the <body>-Tag was sent to the browser!</b></p>
<p class="normal"> You can optional declare with the parameter, whether the
progress bar is also immediately shown visible or not. Default is <span class="code">true</span>
(=yes).</p>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->make();</td>
</tr>
</table>
<br>
<table width="80%" border="0" bgcolor="#FFE1C4">
<tr>
<td class="code">$progress->make(false); // Create only , don't show
yet. </td>
</tr>
</table>
</blockquote>
<p> </p>
</body>
</html>
