Reference Guide

HTML_Progress

Prev |  | Next
Reference Guide this reference describes every API in the HTML_Progress package # Table of Contents Common Function Reference Error Handler Reference Observer Pattern Reference Mathematical Reference Graphical Reference Data Model Package HTML_Progress Constants Monitor Functions ## Common Function Reference These common methods allow to manage UI and DM classes component, change internal progress meter identifier, speed animation, and many other little tasks. HTML_Progress::apiVersion HTML_Progress::display HTML_Progress::hide HTML_Progress::toHtml HTML_Progress::toArray HTML_Progress::sleep HTML_Progress::setProgressHandler HTML_Progress::process HTML_Progress::run HTML_Progress::getUI HTML_Progress::setUI HTML_Progress::getDM HTML_Progress::setDM HTML_Progress::getIdent HTML_Progress::setIdent HTML_Progress::getAnimSpeed HTML_Progress::setAnimSpeed HTML_Progress::getString HTML_Progress::setString HTML_Progress::isStringPainted HTML_Progress::setStringPainted HTML_Progress::isBorderPainted HTML_Progress::setBorderPainted HTML_Progress::getScript HTML_Progress::getStyle HTML_Progress::setModel HTML_Progress::isIndeterminate HTML_Progress::setIndeterminate ## Error Handler Reference HTML_Progress::raiseError HTML_Progress::hasErrors HTML_Progress::getError ## Observer Pattern Reference The HTML_Progress_Observer class provides an implementation of the observer pattern. In the content of the HTML_Progress package, it provides a mechanism by which you can examine special event as it is happened. This allows the implementation of special behavior. HTML_Progress::addListener HTML_Progress::removeListener HTML_Progress::getListeners ## Mathematical Reference Default mathematical model (HTML_Progress_DM class) handles a common progress bar with a minimum and initial value sets to 0, a maximum set to 100, and an increment set to 1. HTML_Progress::getIncrement HTML_Progress::setIncrement HTML_Progress::getMaximum HTML_Progress::setMaximum HTML_Progress::getMinimum HTML_Progress::setMinimum HTML_Progress::getValue HTML_Progress::setValue HTML_Progress::incValue HTML_Progress::getPercentComplete ## Graphical Reference The HTML_Progress_UI class provides methods for html code display and element attributes handling. You can overload it with HTML_Progress::setUI method. HTML_Progress_UI::getOrientation HTML_Progress_UI::setOrientation HTML_Progress_UI::getFillWay HTML_Progress_UI::setFillWay HTML_Progress_UI::getCellCount HTML_Progress_UI::setCellCount HTML_Progress_UI::getCellAttributes HTML_Progress_UI::setCellAttributes HTML_Progress_UI::getCellCoordinates HTML_Progress_UI::setCellCoordinates HTML_Progress_UI::getBorderAttributes HTML_Progress_UI::setBorderAttributes HTML_Progress_UI::getStringAttributes HTML_Progress_UI::setStringAttributes HTML_Progress_UI::getProgressAttributes HTML_Progress_UI::setProgressAttributes HTML_Progress_UI::getScript HTML_Progress_UI::setScript HTML_Progress_UI::getStyle HTML_Progress_UI::drawCircleSegments ## Data Model The HTML_Progress_DM class handles any mathematical issues arising from assigning faulty values. You can overload it with HTML_Progress::setDM method. HTML_Progress_DM::getMinimum HTML_Progress_DM::setMinimum HTML_Progress_DM::getMaximum HTML_Progress_DM::setMaximum HTML_Progress_DM::getIncrement HTML_Progress_DM::setIncrement HTML_Progress_DM::getValue HTML_Progress_DM::setValue HTML_Progress_DM::incValue HTML_Progress_DM::getPercentComplete ## Package HTML_Progress Constants All Contants defined in and used by HTML_Progress ## Monitor Functions HTML_Progress_Monitor class allows to execute a process while display a progress bar inside a dialog box. HTML_Progress_Monitor::notify HTML_Progress_Monitor::setProgressHandler HTML_Progress_Monitor::callProgressHandler HTML_Progress_Monitor::isStarted HTML_Progress_Monitor::isCanceled HTML_Progress_Monitor::run HTML_Progress_Monitor::setProgressElement HTML_Progress_Monitor::getProgressElement HTML_Progress_Monitor::getStyle HTML_Progress_Monitor::getScript HTML_Progress_Monitor::toHtml HTML_Progress_Monitor::accept HTML_Progress_Monitor::setCaption
Prev | Up | Next
Monitoring functions v2 | HTML_Progress 1.x | HTML_Progress::apiVersion
Documentation generated on Sun, 12 Sep 2004 20:22:57 +0200 by phpDocumentor 1.3.0RC3