D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
lampp
/
lib
/
php
/
doc
/
HTML_Progress
/
docs
/
TDG
/
HTML_Progress
/
Filename :
tutorial_monitor.run.pkg.html
back
Copy
<html> <head> <title>HTML_Progress_Monitor::run</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"> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <td width="10%" align="left" valign="bottom"><a href= "../HTML_Progress/tutorial_monitor.iscanceled.pkg.html">Prev</a></td> <td width="80%" align="center" valign="bottom"></td> <td width="10%" align="right" valign="bottom"><a href= "../HTML_Progress/tutorial_monitor.setprogresselement.pkg.html">Next</a></td> </tr> </table> <div><a name=""></a><div class="ref-title-box"><div class="ref-title"><span class="function">HTML_Progress_Monitor::run</span></div> <div class="ref-purpose">runs the monitor and catch user action (cancel)</div></div> <span><a name="synopsis"></a><h2 class="title">Synopsis</h2><div class="ref-synopsis"><p class="func-synopsis">require_once 'HTML/Progress/monitor.php';</p> void <span class="function">HTML_Progress_Monitor::run</span>()</div></span> <span><a name="description"></a><h2 class="title">Description</h2><p>This method launch the monitoring process after user has clicked on <strong>Start</strong> button.</p> At any time, the user can stop the process with the <strong>Cancel</strong> button.<br /></span> <span><a name="note"></a><h2 class="title">Note</h2>( HTML_Progress >= 1.0 )<br /> <p><table class="note"><tr><td class="note_img"><img src="../media/important.png"></td><td class="note_text">This function can not be called statically.</td></tr></table></p></span> <span><a name="see"></a><h2 class="title">See</h2><p><a href="../HTML_Progress/tutorial_progress.setanimspeed.pkg.html">HTML_Progress::setAnimSpeed</a>, <a href="../HTML_Progress/tutorial_progress.sleep.pkg.html">HTML_Progress::sleep</a>, <a href="../HTML_Progress/tutorial_monitor.setprogresshandler.pkg.html">HTML_Progress_Monitor::setProgressHandler</a>, <a href="../HTML_Progress/tutorial_monitor.callprogresshandler.pkg.html">HTML_Progress_Monitor::callProgressHandler</a></p></span> <span><a name="example"></a><h2 class="title">Example</h2><p>The full example below will run a progress monitor starting in indeterminate mode, and then switch back to determinate mode.<br /> <p><table class="note"><tr><td><img src="../media/example.png"></td><td><img src = "../media/screenshots/indeterminate.png"/></td></tr></table></p> <div class="listing"><pre><ol><li><span class="src-php"><?php </span></li> <li><span class="src-inc">require_once </span><span class="src-str">'HTML/Progress/monitor.php'</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-key">function </span><span class="src-id">myProgressHandler</span><span class="src-sym">(</span><span class="src-var">$progressValue</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$obj</span><span class="src-sym">)</span></li> <li><span class="src-sym">{</span></li> <li> <span class="src-key">static </span><span class="src-var">$c</span><span class="src-sym">;</span></li> <li> </li> <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span>isset<span class="src-sym">(</span><span class="src-var">$c</span><span class="src-sym">)) </span><span class="src-sym">{ </span></li> <li> <span class="src-var">$c </span>= <span class="src-num">0</span><span class="src-sym">;</span></li> <li> <span class="src-sym">}</span></li> <li> <span class="src-var">$c </span>+= <span class="src-num">16</span><span class="src-sym">;</span></li> <li> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">setCaption</span><span class="src-sym">(</span><span class="src-str">"</span><span class="src-str"><span class="src-id">completed</span> <span class="src-var">$c</span> <span class="src-id">out</span> <span class="src-id">of</span> 400</span><span class="src-str">"</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> </li> <li> <span class="src-var">$bar </span>=<span class="src-sym">& </span><span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">getProgressElement</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> <span class="src-comm">/* rules to determine when switch back </span></li> <li><span class="src-comm"> from indeterminate to determinate mode </span></li> <li><span class="src-comm"> */</span></li> <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$c </span>>= <span class="src-num">240 </span>&& <span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">isIndeterminate</span><span class="src-sym">(</span><span class="src-sym">)) </span><span class="src-sym">{</span></li> <li> <span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">setIndeterminate</span><span class="src-sym">(</span><span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> <span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">setString</span><span class="src-sym">(</span><span class="src-id">null</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// show percent-info</span></li> <li> <span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">setValue</span><span class="src-sym">(</span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> <span class="src-sym">}</span></li> <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">getPercentComplete</span><span class="src-sym">(</span><span class="src-sym">) </span>== <span class="src-num">1</span><span class="src-sym">) </span><span class="src-sym">{</span></li> <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">isIndeterminate</span><span class="src-sym">(</span><span class="src-sym">)) </span><span class="src-sym">{</span></li> <li> <span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">setValue</span><span class="src-sym">(</span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li> <li> <span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">setString</span><span class="src-sym">(</span><span class="src-str">''</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// hide percent-info</span></li> <li> <span class="src-sym">}</span></li> <li> <span class="src-sym">}</span></li> <li><span class="src-sym">}</span></li> <li> </li> <li><span class="src-var">$monitor </span>= <span class="src-key">new </span><span class="src-id"><a href="../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html">HTML_Progress_Monitor</a></span><span class="src-sym">(</span><span class="src-str">'frmMonitor'</span><span class="src-sym">, </span></li> <li> <span class="src-key">array</span><span class="src-sym">( </span><span class="src-str">'button' </span>=> <span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'style' </span>=> <span class="src-str">'width:80px;'</span><span class="src-sym">)</span><span class="src-sym">, </span></li> <li> <span class="src-str">'title' </span>=> <span class="src-str">'Progress ...' </span><span class="src-sym">)</span></li> <li><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-comm">// your custom user process goes here !</span></li> <li><span class="src-var">$monitor</span><span class="src-sym">-></span><span class="src-id">setProgressHandler</span><span class="src-sym">(</span><span class="src-str">'myProgressHandler'</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-comm">// Attach a progress bar custom model</span></li> <li><span class="src-var">$progress </span>= <span class="src-key">new </span><span class="src-id"><a href="../HTML_Progress/HTML_Progress.html">HTML_Progress</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$ui </span>= <span class="src-sym">& </span><span class="src-var">$progress</span><span class="src-sym">-></span><span class="src-id">getUI</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$ui</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetProgressAttributes">setProgressAttributes</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span></li> <li> <span class="src-str">'background-color' </span>=> <span class="src-str">'#e0e0e0'</span></li> <li><span class="src-sym">))</span><span class="src-sym">; </span></li> <li><span class="src-var">$ui</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetStringAttributes">setStringAttributes</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span></li> <li> <span class="src-str">'color' </span>=> <span class="src-str">'#996'</span><span class="src-sym">,</span></li> <li> <span class="src-str">'background-color' </span>=> <span class="src-str">'#CCCC99'</span></li> <li><span class="src-sym">))</span><span class="src-sym">; </span></li> <li><span class="src-var">$ui</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellAttributes">setCellAttributes</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span></li> <li> <span class="src-str">'active-color' </span>=> <span class="src-str">'#996'</span></li> <li><span class="src-sym">))</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-var">$progress</span><span class="src-sym">-></span><span class="src-id">setAnimSpeed</span><span class="src-sym">(</span><span class="src-num">100</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$progress</span><span class="src-sym">-></span><span class="src-id">setIncrement</span><span class="src-sym">(</span><span class="src-num">10</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$progress</span><span class="src-sym">-></span><span class="src-id">setStringPainted</span><span class="src-sym">(</span><span class="src-id">true</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$progress</span><span class="src-sym">-></span><span class="src-id">setString</span><span class="src-sym">(</span><span class="src-str">""</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$progress</span><span class="src-sym">-></span><span class="src-id">setIndeterminate</span><span class="src-sym">(</span><span class="src-id">true</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$monitor</span><span class="src-sym">-></span><span class="src-id">setProgressElement</span><span class="src-sym">(</span><span class="src-var">$progress</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-php">?></span></li> <li><html></li> <li><head></li> <li><title>Indeterminate Mode Progress example</title></li> <li><style type="text/css"></li> <li><!--</li> <li>.progressStatus {</li> <li> color:#000000; </li> <li> font-size:10px;</li> <li>}</li> <li> </li> <li>body {</li> <li> background-color: #444444;</li> <li> color: #EEEEEE;</li> <li> font-family: Verdana, Arial;</li> <li>}</li> <li> </li> <li><span class="src-php"><?php </span>echo <span class="src-var">$monitor</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStyle">getStyle</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-php">?></span></li> <li>// --></li> <li></style></li> <li><script type="text/javascript"></li> <li><!--</li> <li><span class="src-php"><?php </span>echo <span class="src-var">$monitor</span><span class="src-sym">-></span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetScript">getScript</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-php">?></span></li> <li>//--></li> <li></script></li> <li></head></li> <li><body></li> <li> </li> <li><span class="src-php"><?php </span></li> <li><span class="src-var">$renderer </span>=<span class="src-sym">& </span><span class="src-id">HTML_QuickForm</span><span class="src-sym">::</span><span class="src-id">defaultRenderer</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$renderer</span><span class="src-sym">-></span><span class="src-id">setFormTemplate</span><span class="src-sym">(</span><span class="src-str">'</span></li> <li><span class="src-str"> <table width="450" border="0" cellpadding="3" cellspacing="2" bgcolor="#CCCC99"></span></li> <li><span class="src-str"> <form{attributes}>{content}</span></li> <li><span class="src-str"> </form></span></li> <li><span class="src-str"> </table></span></li> <li><span class="src-str">'</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$renderer</span><span class="src-sym">-></span><span class="src-id">setHeaderTemplate</span><span class="src-sym">(</span><span class="src-str">'</span></li> <li><span class="src-str"> <tr></span></li> <li><span class="src-str"> <td style="white-space:nowrap;background:#996;color:#ffc;" align="left" colspan="2"></span></li> <li><span class="src-str"> <b>{header}</b></span></li> <li><span class="src-str"> </td></span></li> <li><span class="src-str"> </tr></span></li> <li><span class="src-str">'</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><span class="src-var">$monitor</span><span class="src-sym">-></span><span class="src-id">accept</span><span class="src-sym">(</span><span class="src-var">$renderer</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-comm">// Display progress monitor dialog box</span></li> <li>echo <span class="src-var">$renderer</span><span class="src-sym">-></span><span class="src-id">toHtml</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> </li> <li> </li> <li><span class="src-var">$monitor</span><span class="src-sym">-></span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span></li> <li><span class="src-php">?></span></li> <li> </li> <li></body></li> <li></html></li> </ol></pre></div></p></span></div> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <td width="33%" align="left" valign="top"><a href="../HTML_Progress/tutorial_monitor.iscanceled.pkg.html">Prev</a></td> <td width="34%" align="center" valign="top"><a href= "../HTML_Progress/tutorial_part3-reference.pkg.html">Up</a></td> <td width="33%" align="right" valign="top"><a href= "../HTML_Progress/tutorial_monitor.setprogresselement.pkg.html">Next</a></td> </tr> <tr> <td width="33%" align="left" valign="top"><span class="function">HTML_Progress_Monitor::isCanceled</span></td> <td width="34%" align="center" valign="top">Reference Guide</td> <td width="33%" align="right" valign="top"><span class="function">HTML_Progress_Monitor::setProgressElement</span></td> </tr> </table> <div class="credit"> <hr /> Documentation generated on Sun, 12 Sep 2004 20:23:33 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html>