in file default.php, class ActionDisplay The ActionDisplay class provides the default form rendering.
ActionPreview
in file preview.php, class ActionPreview The ActionPreview class provides a live demonstration of the progress bar built by HTML_Progress_Generator.
ActionProcess
in file process.php, class ActionProcess The ActionProcess class provides final step of ProgressBar creation.
addListener
in file Progress.php, method HTML_Progress::addListener() Adds a HTML_Progress_Observer instance to the list of observers that are listening for messages emitted by this HTML_Progress instance.
in file UI.php, method HTML_Progress_UI::getOrientation() Returns HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL, depending on the orientation of the progress bar.
getPercentComplete
in file Progress.php, method HTML_Progress::getPercentComplete() Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00.
getPercentComplete
in file DM.php, method HTML_Progress_DM::getPercentComplete() Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00.
in file Progress.php, method HTML_Progress::getUI() Returns the look-and-feel object that renders the progress bar.
getValue
in file DM.php, method HTML_Progress_DM::getValue() Returns the progress bar's current value. The value is always between the minimum and maximum values, inclusive.
getValue
in file Progress.php, method HTML_Progress::getValue() 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.
in file Progress.php, constant HTML_PROGRESS_DEPRECATED Basic error code that indicate a deprecated method that may be removed at any time from a future version
HTML_Progress_DM
in file DM.php, class HTML_Progress_DM The HTML_Progress_DM class handles any mathematical issues arising from assigning faulty values.
in file Progress.php, constant HTML_PROGRESS_ERRORSTACK_LOG If this is returned, then the error will only be logged, but not pushed onto the error stack.
HTML_PROGRESS_ERRORSTACK_LOGANDDIE
in file Progress.php, constant HTML_PROGRESS_ERRORSTACK_LOGANDDIE If this is returned, then the error will only be logged, but not pushed onto the error stack because will halt script execution.
HTML_PROGRESS_ERRORSTACK_PUSH
in file Progress.php, constant HTML_PROGRESS_ERRORSTACK_PUSH If this is returned, then the error will only be pushed onto the stack, and not logged.
HTML_PROGRESS_ERRORSTACK_PUSHANDLOG
in file Progress.php, constant HTML_PROGRESS_ERRORSTACK_PUSHANDLOG If this is returned, then the error will be both pushed onto the stack and logged.
in file observer.php, class HTML_Progress_Observer The HTML_Progress_Observer implements the observer pattern for watching progress bar activity and taking actions on exceptional events.
in file observer.php, method HTML_Progress_Observer::notify() 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.
in file Progress.php, method HTML_Progress::removeListener() Removes a HTML_Progress_Observer instance from the list of observers.
run
in file Progress.php, method HTML_Progress::run() Runs the progress bar (both modes: indeterminate and determinate), and execute all actions defined in user callback identified by method setProgressHandler.
in file Progress.php, method HTML_Progress::setBorderPainted() Sets the value of $_paintBorder property, which determines whether the progress bar should paint its border. The default is false.
in file Progress.php, method HTML_Progress::setIndeterminate() Sets the $_indeterminate property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode.
setMaximum
in file Progress.php, method HTML_Progress::setMaximum() Sets the progress bar's maximum value stored in the progress bar's data model.
in file Progress.php, method HTML_Progress::setModel() Sets the look-and-feel model that renders the progress bar.
setOrientation
in file UI.php, method HTML_Progress_UI::setOrientation() Sets the progress bar's orientation, which must be HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL.
in file UI.php, method HTML_Progress_UI::setScript() Set the external JavaScript code (file) to manage progress element.
setString
in file Progress.php, method HTML_Progress::setString() 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.
in file Progress.php, method HTML_Progress::setStringPainted() Sets the value of $_paintString property, which determines whether the progress bar should render a progress string. The default is false.
setUI
in file Progress.php, method HTML_Progress::setUI() Sets the look-and-feel object that renders the progress bar.
