HTML_Progress_Monitor::run

runs the monitor and catch user action (cancel)

Synopsis

require_once 'HTML/Progress/monitor.php';

void HTML_Progress_Monitor::run()

Description

This method launch the monitoring process after user has clicked on Start button.

At any time, the user can stop the process with the Cancel button.

Note

( HTML_Progress >= 1.0 )

This function can not be called statically.

See

HTML_Progress::setAnimSpeed, HTML_Progress::sleep, HTML_Progress_Monitor::setProgressHandler, HTML_Progress_Monitor::callProgressHandler

Example

The full example below will run a progress monitor starting in indeterminate mode, and then switch back to determinate mode.

<?php 
require_once 'HTML/Progress/monitor.php';
 
function myProgressHandler($progressValue, &$obj)
{
    static $c;
    
    if (!isset($c)) { 
        $c = 0;
    }
    $c += 16;
    $obj->setCaption("completed $c out of 400");
 
    $bar =& $obj->getProgressElement();
    /* rules to determine when switch back 
       from indeterminate to determinate mode 
     */
    if ($c >= 240 && $bar->isIndeterminate()) {
        $bar->setIndeterminate(false);
        $bar->setString(null);   // show percent-info
        $bar->setValue(0);
    }
    if ($bar->getPercentComplete() == 1) {
        if ($bar->isIndeterminate()) {
            $bar->setValue(0);
        } else {
            $bar->setString(''); // hide percent-info
        }
    }
}
 
$monitor = new HTML_Progress_Monitor('frmMonitor', 
    array( 'button' => array('style' => 'width:80px;'), 
           'title'  => 'Progress ...' )
);
 
// your custom user process goes here !
$monitor->setProgressHandler('myProgressHandler');
 
// Attach a progress bar custom model
$progress = new HTML_Progress();
$ui = & $progress->getUI();
$ui->setProgressAttributes(array(
    'background-color' => '#e0e0e0'
));        
$ui->setStringAttributes(array(
    'color'  => '#996',
    'background-color' => '#CCCC99'
));        
$ui->setCellAttributes(array(
    'active-color' => '#996'
));
 
$progress->setAnimSpeed(100);
$progress->setIncrement(10);
$progress->setStringPainted(true);
$progress->setString("");
$progress->setIndeterminate(true);
$monitor->setProgressElement($progress);
?>
<html>
<head>
<title>Indeterminate Mode Progress example</title>
<style type="text/css">
<!--
.progressStatus {
    color:#000000; 
    font-size:10px;
}
 
body {
    background-color: #444444;
    color: #EEEEEE;
    font-family: Verdana, Arial;
}
 
<?php echo $monitor->getStyle(); ?>
// -->
</style>
<script type="text/javascript">
<!--
<?php echo $monitor->getScript(); ?>
//-->
</script>
</head>
<body>
 
<?php 
$renderer =& HTML_QuickForm::defaultRenderer();
$renderer->setFormTemplate('
    <table width="450" border="0" cellpadding="3" cellspacing="2" bgcolor="#CCCC99">
    <form{attributes}>{content}
    </form>
    </table>
');
$renderer->setHeaderTemplate('
    <tr>
    <td style="white-space:nowrap;background:#996;color:#ffc;" align="left" colspan="2">
        <b>{header}</b>
    </td>
    </tr>
');
$monitor->accept($renderer);
 
// Display progress monitor dialog box
echo $renderer->toHtml();
 
 
$monitor->run();   
?>
 
</body>
</html>