Element index for package HTML_Progress
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ j ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ _ ]
top
a
- 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.
- apiVersion
- in file Progress.php, method HTML_Progress::apiVersion()
Returns the current API version
- ancestor.php
- procedural page ancestor.php (subpackage: Examples)
- accept
- in file monitor.php, method HTML_Progress_Monitor::accept() (subpackage: Progress_Observer)
Accepts a renderer
- ActionDisplay
- in file default.php, class ActionDisplay (subpackage: Progress_UI)
The ActionDisplay class provides the default form rendering.
- ActionPreview
- in file preview.php, class ActionPreview (subpackage: Progress_UI)
The ActionPreview class provides a live demonstration of the progress bar built by HTML_Progress_Generator.
- ActionProcess
- in file process.php, class ActionProcess (subpackage: Progress_UI)
The ActionProcess class provides final step of ProgressBar creation.
top
top
top
top
top
top
g
- getAnimSpeed
- in file Progress.php, method HTML_Progress::getAnimSpeed()
Returns delay execution of the progress bar
- getDM
- in file Progress.php, method HTML_Progress::getDM()
Returns the data model used by this progress bar.
- getError
- in file Progress.php, method HTML_Progress::getError()
Pop an error off of the HTML_Progress stack
- getIdent
- in file Progress.php, method HTML_Progress::getIdent()
Returns the current identification string.
- getIncrement
- in file Progress.php, method HTML_Progress::getIncrement()
Returns the progress bar's increment value stored in the progress bar's data model.
- getListeners
- in file Progress.php, method HTML_Progress::getListeners()
Returns an array of all the listeners added to this progress bar.
- getMaximum
- in file Progress.php, method HTML_Progress::getMaximum()
Returns the progress bar's maximum value stored in the progress bar's data model.
- getMinimum
- in file Progress.php, method HTML_Progress::getMinimum()
Returns the progress bar's minimum value stored in the progress bar's data model.
- 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 or 0 and 100.
- getScript
- in file Progress.php, method HTML_Progress::getScript()
Get the javascript code to manage progress bar.
- getString
- in file Progress.php, method HTML_Progress::getString()
Returns the current value of the progress string.
- getStyle
- in file Progress.php, method HTML_Progress::getStyle()
Get the cascading style sheet to put inline on HTML document
- getUI
- in file Progress.php, method HTML_Progress::getUI()
Returns the look-and-feel object that renders the progress bar.
- 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.
- getIncrement
- in file DM.php, method HTML_Progress_DM::getIncrement() (subpackage: Progress_DM)
Returns the progress bar's increment value. The default value is +1.
- getMaximum
- in file DM.php, method HTML_Progress_DM::getMaximum() (subpackage: Progress_DM)
Returns the progress bar's maximum value. The default value is 100.
- getMinimum
- in file DM.php, method HTML_Progress_DM::getMinimum() (subpackage: Progress_DM)
Returns the progress bar's minimum value. The default value is 0.
- getPercentComplete
- in file DM.php, method HTML_Progress_DM::getPercentComplete() (subpackage: Progress_DM)
Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00 or 0 and 100.
- getValue
- in file DM.php, method HTML_Progress_DM::getValue() (subpackage: Progress_DM)
Returns the progress bar's current value. The value is always between the minimum and maximum values, inclusive.
- getProgressElement
- in file monitor.php, method HTML_Progress_Monitor::getProgressElement() (subpackage: Progress_Observer)
Returns a reference to the progress bar object used with the monitor.
- getScript
- in file monitor.php, method HTML_Progress_Monitor::getScript() (subpackage: Progress_Observer)
Returns progress javascript.
- getStyle
- in file monitor.php, method HTML_Progress_Monitor::getStyle() (subpackage: Progress_Observer)
Returns progress styles (StyleSheet).
- getBorderAttributes
- in file UI.php, method HTML_Progress_UI::getBorderAttributes() (subpackage: Progress_UI)
Returns the progress bar's border attributes. Assoc array (defaut) or string.
- getCellAttributes
- in file UI.php, method HTML_Progress_UI::getCellAttributes() (subpackage: Progress_UI)
Returns the common and private cell attributes. Assoc array (defaut) or string
- getCellCoordinates
- in file UI.php, method HTML_Progress_UI::getCellCoordinates() (subpackage: Progress_UI)
Returns the coordinates of each cell for a polygonal progress shape.
- getCellCount
- in file UI.php, method HTML_Progress_UI::getCellCount() (subpackage: Progress_UI)
Returns the number of cell in the progress bar. The default value is 10.
- getFillWay
- in file UI.php, method HTML_Progress_UI::getFillWay() (subpackage: Progress_UI)
Returns 'natural' or 'reverse', depending of the fill way of progress bar.
- getOrientation
- in file UI.php, method HTML_Progress_UI::getOrientation() (subpackage: Progress_UI)
Returns HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL, depending on the orientation of the progress bar.
- getProgressAttributes
- in file UI.php, method HTML_Progress_UI::getProgressAttributes() (subpackage: Progress_UI)
Returns the progress attributes. Assoc array (defaut) or string.
- getScript
- in file UI.php, method HTML_Progress_UI::getScript() (subpackage: Progress_UI)
Get the javascript code to manage progress bar.
- getStringAttributes
- in file UI.php, method HTML_Progress_UI::getStringAttributes() (subpackage: Progress_UI)
Returns the string attributes. Assoc array (defaut) or string.
- getStyle
- in file UI.php, method HTML_Progress_UI::getStyle() (subpackage: Progress_UI)
Get the cascading style sheet to put inline on HTML document
- generator.php
- procedural page generator.php (subpackage: Progress_UI)
top
h
- hasErrors
- in file Progress.php, method HTML_Progress::hasErrors()
Determine whether there are errors into the HTML_Progress stack
- hide
- in file Progress.php, method HTML_Progress::hide()
Hides the progress bar.
- HTML_Progress
- in file Progress.php, method HTML_Progress::HTML_Progress()
Constructor Summary
- HTML_Progress
- in file Progress.php, class HTML_Progress
HTML loading bar with only PHP and JS interface.
- HTML_PROGRESS_BAR_HORIZONTAL
- in file Progress.php, constant HTML_PROGRESS_BAR_HORIZONTAL
Progress Bar shape types
- HTML_PROGRESS_BAR_VERTICAL
- in file Progress.php, constant HTML_PROGRESS_BAR_VERTICAL
Progress Bar shape types
- HTML_PROGRESS_CIRCLE
- in file Progress.php, constant HTML_PROGRESS_CIRCLE
Progress Bar shape types
- HTML_PROGRESS_DEPRECATED
- 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_ERRORSTACK_IGNORE
- in file Progress.php, constant HTML_PROGRESS_ERRORSTACK_IGNORE
If this is returned, then the error is completely ignored.
- HTML_PROGRESS_ERRORSTACK_LOG
- 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.
- HTML_PROGRESS_ERROR_INVALID_CALLBACK
- in file Progress.php, constant HTML_PROGRESS_ERROR_INVALID_CALLBACK
Basic error code that indicate a wrong callback definition.
- HTML_PROGRESS_ERROR_INVALID_INPUT
- in file Progress.php, constant HTML_PROGRESS_ERROR_INVALID_INPUT
Basic error code that indicate a wrong input
- HTML_PROGRESS_LOG_TYPE_FILE
- in file Progress.php, constant HTML_PROGRESS_LOG_TYPE_FILE
Append to a file
- HTML_PROGRESS_LOG_TYPE_MAIL
- in file Progress.php, constant HTML_PROGRESS_LOG_TYPE_MAIL
Use PHP's mail() function
- HTML_PROGRESS_LOG_TYPE_SYSTEM
- in file Progress.php, constant HTML_PROGRESS_LOG_TYPE_SYSTEM
Use PHP's system logger
- HTML_PROGRESS_POLYGONAL
- in file Progress.php, constant HTML_PROGRESS_POLYGONAL
Progress Bar shape types
- highlighter.php
- procedural page highlighter.php
- htmlpage.php
- procedural page htmlpage.php (subpackage: Examples)
- half_basic.php
- procedural page half_basic.php (subpackage: Examples)
- half_monitor.php
- procedural page half_monitor.php (subpackage: Examples)
- htmlpage.php
- procedural page htmlpage.php (subpackage: Examples)
- hidden.php
- procedural page hidden.php (subpackage: Examples)
- hbar.php
- procedural page hbar.php (subpackage: Examples)
- HTML_Progress_DM
- in file DM.php, method HTML_Progress_DM::HTML_Progress_DM() (subpackage: Progress_DM)
The data model class constructor
- HTML_Progress_DM
- in file DM.php, class HTML_Progress_DM (subpackage: Progress_DM)
HTML loading bar with only PHP and JS interface.
- HTML_Progress_Monitor
- in file monitor.php, class HTML_Progress_Monitor (subpackage: Progress_Observer)
The HTML_Progress_Monitor class allow an easy way to display progress in a dialog. The user can cancel the task.
- HTML_Progress_Monitor
- in file monitor.php, method HTML_Progress_Monitor::HTML_Progress_Monitor() (subpackage: Progress_Observer)
Constructor Summary
- HTML_Progress_Observer
- in file observer.php, method HTML_Progress_Observer::HTML_Progress_Observer() (subpackage: Progress_Observer)
Creates a new basic HTML_Progress_Observer instance.
- HTML_Progress_Observer
- in file observer.php, class HTML_Progress_Observer (subpackage: Progress_Observer)
The HTML_Progress_Observer implements the observer pattern for watching progress bar activity and taking actions on exceptional events.
- HTML_Progress_Generator
- in file generator.php, class HTML_Progress_Generator (subpackage: Progress_UI)
The HTML_Progress_Generator class provides an easy way to dynamic build Progress bar, show a preview, and save php/css code for a later reuse.
- HTML_Progress_Generator
- in file generator.php, method HTML_Progress_Generator::HTML_Progress_Generator() (subpackage: Progress_UI)
Constructor Summary
- HTML_Progress_Model
- in file model.php, method HTML_Progress_Model::HTML_Progress_Model() (subpackage: Progress_UI)
The progress bar's UI extended model class constructor
- HTML_Progress_Model
- in file model.php, class HTML_Progress_Model (subpackage: Progress_UI)
The HTML_Progress_Model class provides an easy way to set look and feel of a progress bar with external config file.
- HTML_Progress_UI
- in file UI.php, method HTML_Progress_UI::HTML_Progress_UI() (subpackage: Progress_UI)
The progress bar's UI model class constructor
- HTML_Progress_UI
- in file UI.php, class HTML_Progress_UI (subpackage: Progress_UI)
HTML loading bar with only PHP and JS interface.
- HTMLPage.php
- procedural page HTMLPage.php (subpackage: Progress_UI)
top
top
j
- javadanse.php
- procedural page javadanse.php (subpackage: Examples)
top
l
- logger
- in file default2.php, function logger() (subpackage: Examples)
- limit.php
- procedural page limit.php (subpackage: Examples)
top
m
- myFunctionHandler
- in file model.php, function myFunctionHandler() (subpackage: Examples)
- myProcess
- in file formbasic.php, function myProcess() (subpackage: Examples)
- myProgressHandler
- in file half_basic.php, function myProgressHandler() (subpackage: Examples)
This user callback process simulate a reply given after 12 seconds
- model.php
- procedural page model.php (subpackage: Examples)
- method_callback.php
- procedural page method_callback.php (subpackage: Examples)
- mixedupload.php
- procedural page mixedupload.php (subpackage: Examples)
- monitor.php
- procedural page monitor.php (subpackage: Progress_Observer)
- model.php
- procedural page model.php (subpackage: Progress_UI)
top
n
- nostring.php
- procedural page nostring.php (subpackage: Examples)
- notify
- in file observer.php, method HTML_Progress_Observer::notify() (subpackage: Progress_Observer)
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.
- notify
- in file monitor.php, method HTML_Progress_Monitor::notify() (subpackage: Progress_Observer)
Listens all progress events from this monitor.
top
o
- observer.php
- procedural page observer.php (subpackage: Progress_Observer)
top
top
r
- raiseError
- in file Progress.php, method HTML_Progress::raiseError()
Add an error to the stack
- removeListener
- 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.
- redsandback.php
- procedural page redsandback.php (subpackage: Examples)
- rectangleback.php
- procedural page rectangleback.php (subpackage: Examples)
- rectangle.php
- procedural page rectangle.php (subpackage: Examples)
- run
- in file monitor.php, method HTML_Progress_Monitor::run() (subpackage: Progress_Observer)
Display Monitor and catch user action (cancel button).
top
s
- setAnimSpeed
- in file Progress.php, method HTML_Progress::setAnimSpeed()
Set the delays progress bar execution for the given number of miliseconds.
- setBorderPainted
- 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.
- setDM
- in file Progress.php, method HTML_Progress::setDM()
Sets the data model used by this progress bar.
- setIdent
- in file Progress.php, method HTML_Progress::setIdent()
Sets this Progress instance's identification string.
- setIncrement
- in file Progress.php, method HTML_Progress::setIncrement()
Sets the progress bar's increment value stored in the progress bar's data model.
- setIndeterminate
- 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.
- setMinimum
- in file Progress.php, method HTML_Progress::setMinimum()
Sets the progress bar's minimum value stored in the progress bar's data model.
- setModel
- in file Progress.php, method HTML_Progress::setModel()
Sets the look-and-feel model that renders the progress bar.
- setProgressHandler
- in file Progress.php, method HTML_Progress::setProgressHandler()
Sets the user callback function that execute all actions pending progress
- 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.
- setStringPainted
- 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.
- setValue
- in file Progress.php, method HTML_Progress::setValue()
Sets the progress bar's current value stored in the progress bar's data model.
- sleep
- in file Progress.php, method HTML_Progress::sleep()
Default user callback when none are defined.
- smartydynamic.php
- procedural page smartydynamic.php (subpackage: Examples)
- smallest.php
- procedural page smallest.php (subpackage: Examples)
- string.php
- procedural page string.php (subpackage: Examples)
- squareback.php
- procedural page squareback.php (subpackage: Examples)
- square.php
- procedural page square.php (subpackage: Examples)
- simple.php
- procedural page simple.php (subpackage: Examples)
- shockwaveflash.php
- procedural page shockwaveflash.php (subpackage: Examples)
- setIncrement
- in file DM.php, method HTML_Progress_DM::setIncrement() (subpackage: Progress_DM)
Sets the progress bar's increment value.
- setMaximum
- in file DM.php, method HTML_Progress_DM::setMaximum() (subpackage: Progress_DM)
Sets the progress bar's maximum value.
- setMinimum
- in file DM.php, method HTML_Progress_DM::setMinimum() (subpackage: Progress_DM)
Sets the progress bar's minimum value.
- setValue
- in file DM.php, method HTML_Progress_DM::setValue() (subpackage: Progress_DM)
Sets the progress bar's current value.
- setCaption
- in file monitor.php, method HTML_Progress_Monitor::setCaption() (subpackage: Progress_Observer)
Display a caption on action in progress.
- setProgressElement
- in file monitor.php, method HTML_Progress_Monitor::setProgressElement() (subpackage: Progress_Observer)
Attach a progress bar to this monitor.
- setProgressHandler
- in file monitor.php, method HTML_Progress_Monitor::setProgressHandler() (subpackage: Progress_Observer)
Sets a user-defined progress handler function.
- SmartyDynamic.php
- procedural page SmartyDynamic.php (subpackage: Progress_UI)
- setBorderAttributes
- in file UI.php, method HTML_Progress_UI::setBorderAttributes() (subpackage: Progress_UI)
Sets the progress bar's border attributes.
- setCellAttributes
- in file UI.php, method HTML_Progress_UI::setCellAttributes() (subpackage: Progress_UI)
Sets the cell attributes for an existing cell.
- setCellCoordinates
- in file UI.php, method HTML_Progress_UI::setCellCoordinates() (subpackage: Progress_UI)
Set the coordinates of each cell for a polygonal progress shape.
- setCellCount
- in file UI.php, method HTML_Progress_UI::setCellCount() (subpackage: Progress_UI)
Sets the number of cell in the progress bar
- setFillWay
- in file UI.php, method HTML_Progress_UI::setFillWay() (subpackage: Progress_UI)
Sets the progress bar's fill way, which must be 'natural' or 'reverse'.
- setOrientation
- in file UI.php, method HTML_Progress_UI::setOrientation() (subpackage: Progress_UI)
Sets the progress bar's orientation, which must be HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL.
- setProgressAttributes
- in file UI.php, method HTML_Progress_UI::setProgressAttributes() (subpackage: Progress_UI)
Sets the common progress bar attributes.
- setScript
- in file UI.php, method HTML_Progress_UI::setScript() (subpackage: Progress_UI)
Set the external JavaScript code (file) to manage progress element.
- setStringAttributes
- in file UI.php, method HTML_Progress_UI::setStringAttributes() (subpackage: Progress_UI)
Sets the string attributes.
top
top
u
- UI.php
- procedural page UI.php (subpackage: Progress_UI)
top
v
- vertical.php
- procedural page vertical.php (subpackage: Examples)
- vbar.php
- procedural page vbar.php (subpackage: Examples)
top
top
|
|
