HTML_Progress
[ class tree: HTML_Progress ] [ index: HTML_Progress ] [ all elements ]

Index of all elements

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ _ ]

a

accept
in file monitor.php, method HTML_Progress_Monitor::accept()
    Accepts a renderer
ActionDisplay
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.
apiVersion
in file Progress.php, method HTML_Progress::apiVersion()
    Returns the current API version
ancestor.php
procedural page ancestor.php
top

b

$buttonCancel
in file monitor.php, variable HTML_Progress_Monitor::$buttonCancel
    Attributes of monitor form.
$buttonStart
in file monitor.php, variable HTML_Progress_Monitor::$buttonStart
    Attributes of monitor form.
bgimages.php
procedural page bgimages.php
bluesandplus.php
procedural page bluesandplus.php
bluesand.php
procedural page bluesand.php
bullit.php
procedural page bullit.php
basic.php
procedural page basic.php
top

c

callProgressHandler
in file monitor.php, method HTML_Progress_Monitor::callProgressHandler()
    Calls a user-defined progress handler function.
createButtons
in file generator.php, method HTML_Progress_Generator::createButtons()
    Adds all necessary buttons to the given page object.
createProgressBar
in file generator.php, method HTML_Progress_Generator::createProgressBar()
    Creates a progress bar with options choosen on all wizard tabs.
createTabs
in file generator.php, method HTML_Progress_Generator::createTabs()
    Adds all necessary tabs to the given page object.
custom.php
procedural page custom.php
circleback.php
procedural page circleback.php
circleplain.php
procedural page circleplain.php
complex.php
procedural page complex.php
top

d

disableButton
in file generator.php, method HTML_Progress_Generator::disableButton()
    Disables certain buttons for a page.
display
in file Progress.php, method HTML_Progress::display()
    Renders the new value of progress bar.
drawCircleSegments
in file UI.php, method HTML_Progress_UI::drawCircleSegments()
    Draw all circle segment pictures
default.php
procedural page default.php
default1.php
procedural page default1.php
default2.php
procedural page default2.php
default.php
procedural page default.php
DM.php
procedural page DM.php
default.php
procedural page default.php
top

e

enableButton
in file generator.php, method HTML_Progress_Generator::enableButton()
    Enables certain buttons for a page.
exportOutput
in file process.php, method ActionProcess::exportOutput()
embedded.php
procedural page embedded.php
ellipse.php
procedural page ellipse.php
top

f

function_callback.php
procedural page function_callback.php
formbasic.php
procedural page formbasic.php
formpopup.php
procedural page formpopup.php
formselfref.php
procedural page formselfref.php
ftpupload.php
procedural page ftpupload.php
top

g

getAnimSpeed
in file Progress.php, method HTML_Progress::getAnimSpeed()
    Returns delay execution of the progress bar
getBorderAttributes
in file UI.php, method HTML_Progress_UI::getBorderAttributes()
    Returns the progress bar's border attributes. Assoc array (defaut) or string.
getCellAttributes
in file UI.php, method HTML_Progress_UI::getCellAttributes()
    Returns the common and private cell attributes. Assoc array (defaut) or string
getCellCoordinates
in file UI.php, method HTML_Progress_UI::getCellCoordinates()
    Returns the coordinates of each cell for a polygonal progress shape.
getCellCount
in file UI.php, method HTML_Progress_UI::getCellCount()
    Returns the number of cell in the progress bar. The default value is 10.
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
getFillWay
in file UI.php, method HTML_Progress_UI::getFillWay()
    Returns 'natural' or 'reverse', depending of the fill way of progress bar.
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.
getIncrement
in file DM.php, method HTML_Progress_DM::getIncrement()
    Returns the progress bar's increment value. The default value is +1.
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.
getMaximum
in file DM.php, method HTML_Progress_DM::getMaximum()
    Returns the progress bar's maximum value. The default value is 100.
getMinimum
in file Progress.php, method HTML_Progress::getMinimum()
    Returns the progress bar's minimum value stored in the progress bar's data model.
getMinimum
in file DM.php, method HTML_Progress_DM::getMinimum()
    Returns the progress bar's minimum value. The default value is 0.
getOrientation
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 or 0 and 100.
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 or 0 and 100.
getProgressAttributes
in file UI.php, method HTML_Progress_UI::getProgressAttributes()
    Returns the progress attributes. Assoc array (defaut) or string.
getProgressElement
in file monitor.php, method HTML_Progress_Monitor::getProgressElement()
    Returns a reference to the progress bar object used with the monitor.
getScript
in file UI.php, method HTML_Progress_UI::getScript()
    Get the javascript code to manage progress bar.
getScript
in file Progress.php, method HTML_Progress::getScript()
    Get the javascript code to manage progress bar.
getScript
in file monitor.php, method HTML_Progress_Monitor::getScript()
    Returns progress javascript.
getString
in file Progress.php, method HTML_Progress::getString()
    Returns the current value of the progress string.
getStringAttributes
in file UI.php, method HTML_Progress_UI::getStringAttributes()
    Returns the string attributes. Assoc array (defaut) or string.
getStyle
in file UI.php, method HTML_Progress_UI::getStyle()
    Get the cascading style sheet to put inline on HTML document
getStyle
in file Progress.php, method HTML_Progress::getStyle()
    Get the cascading style sheet to put inline on HTML document
getStyle
in file monitor.php, method HTML_Progress_Monitor::getStyle()
    Returns progress styles (StyleSheet).
getUI
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.
generator.php
procedural page generator.php
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_DM
in file DM.php, method HTML_Progress_DM::HTML_Progress_DM()
    The data model class constructor
HTML_Progress_DM
in file DM.php, class HTML_Progress_DM
    HTML loading bar with only PHP and JS interface.
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_Generator
in file generator.php, method HTML_Progress_Generator::HTML_Progress_Generator()
    Constructor Summary
HTML_Progress_Generator
in file generator.php, class HTML_Progress_Generator
    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_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_Model
in file model.php, method HTML_Progress_Model::HTML_Progress_Model()
    The progress bar's UI extended model class constructor
HTML_Progress_Model
in file model.php, class HTML_Progress_Model
    The HTML_Progress_Model class provides an easy way to set look and feel of a progress bar with external config file.
HTML_Progress_Monitor
in file monitor.php, method HTML_Progress_Monitor::HTML_Progress_Monitor()
    Constructor Summary
HTML_Progress_Monitor
in file monitor.php, class HTML_Progress_Monitor
    The HTML_Progress_Monitor class allow an easy way to display progress in a dialog. The user can cancel the task.
HTML_Progress_Observer
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.
HTML_Progress_Observer
in file observer.php, method HTML_Progress_Observer::HTML_Progress_Observer()
    Creates a new basic HTML_Progress_Observer instance.
HTML_PROGRESS_POLYGONAL
in file Progress.php, constant HTML_PROGRESS_POLYGONAL
    Progress Bar shape types
HTML_Progress_UI
in file UI.php, class HTML_Progress_UI
    HTML loading bar with only PHP and JS interface.
HTML_Progress_UI
in file UI.php, method HTML_Progress_UI::HTML_Progress_UI()
    The progress bar's UI model class constructor
htmlpage.php
procedural page htmlpage.php
highlighter.php
procedural page highlighter.php
half_basic.php
procedural page half_basic.php
half_monitor.php
procedural page half_monitor.php
htmlpage.php
procedural page htmlpage.php
hidden.php
procedural page hidden.php
hbar.php
procedural page hbar.php
HTMLPage.php
procedural page HTMLPage.php
top

i

incValue
in file Progress.php, method HTML_Progress::incValue()
    Updates the progress bar's current value by adding increment value.
incValue
in file DM.php, method HTML_Progress_DM::incValue()
    Updates the progress bar's current value by adding increment value.
isBorderPainted
in file Progress.php, method HTML_Progress::isBorderPainted()
    Determines whether the progress bar border is painted or not.
isCanceled
in file monitor.php, method HTML_Progress_Monitor::isCanceled()
    Returns TRUE if progress was canceled by user, FALSE otherwise.
isIndeterminate
in file Progress.php, method HTML_Progress::isIndeterminate()
    Returns mode of the progress bar (determinate or not).
isStarted
in file monitor.php, method HTML_Progress_Monitor::isStarted()
    Returns TRUE if progress was started by user, FALSE otherwise.
isStringPainted
in file Progress.php, method HTML_Progress::isStringPainted()
    Determines whether the progress bar string is painted or not.
itdynamic.php
procedural page itdynamic.php
inicommented.php
procedural page inicommented.php
itdynamic.php
procedural page itdynamic.php
itxstatic.php
procedural page itxstatic.php
ITDynamic.php
procedural page ITDynamic.php
top

j

javadanse.php
procedural page javadanse.php
top

l

logger
in file default2.php, function logger()
limit.php
procedural page limit.php
top

m

myFunctionHandler
in file model.php, function myFunctionHandler()
myProcess
in file formbasic.php, function myProcess()
myProgressHandler
in file half_basic.php, function myProgressHandler()
    This user callback process simulate a reply given after 12 seconds
model.php
procedural page model.php
method_callback.php
procedural page method_callback.php
mixedupload.php
procedural page mixedupload.php
model.php
procedural page model.php
monitor.php
procedural page monitor.php
top

n

notify
in file monitor.php, method HTML_Progress_Monitor::notify()
    Listens all progress events from this monitor.
notify
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.
nostring.php
procedural page nostring.php
top

o

observer.php
procedural page observer.php
top

p

perform
in file process.php, method ActionProcess::perform()
perform
in file preview.php, method ActionPreview::perform()
process
in file Progress.php, method HTML_Progress::process()
    Performs the progress actions
progressbar.php
procedural page progressbar.php
pages.php
procedural page pages.php
preview.php
procedural page preview.php
process.php
procedural page process.php
Progress.php
procedural page Progress.php
top

r

redsandback.php
procedural page redsandback.php
rectangleback.php
procedural page rectangleback.php
rectangle.php
procedural page rectangle.php
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.
run
in file monitor.php, method HTML_Progress_Monitor::run()
    Display Monitor and catch user action (cancel button).
top

s

smartydynamic.php
procedural page smartydynamic.php
smallest.php
procedural page smallest.php
string.php
procedural page string.php
squareback.php
procedural page squareback.php
square.php
procedural page square.php
simple.php
procedural page simple.php
shockwaveflash.php
procedural page shockwaveflash.php
SmartyDynamic.php
procedural page SmartyDynamic.php
setAnimSpeed
in file Progress.php, method HTML_Progress::setAnimSpeed()
    Set the delays progress bar execution for the given number of miliseconds.
setBorderAttributes
in file UI.php, method HTML_Progress_UI::setBorderAttributes()
    Sets the progress bar's border attributes.
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.
setCaption
in file monitor.php, method HTML_Progress_Monitor::setCaption()
    Display a caption on action in progress.
setCellAttributes
in file UI.php, method HTML_Progress_UI::setCellAttributes()
    Sets the cell attributes for an existing cell.
setCellCoordinates
in file UI.php, method HTML_Progress_UI::setCellCoordinates()
    Set the coordinates of each cell for a polygonal progress shape.
setCellCount
in file UI.php, method HTML_Progress_UI::setCellCount()
    Sets the number of cell in the progress bar
setDM
in file Progress.php, method HTML_Progress::setDM()
    Sets the data model used by this progress bar.
setFillWay
in file UI.php, method HTML_Progress_UI::setFillWay()
    Sets the progress bar's fill way, which must be 'natural' or 'reverse'.
setIdent
in file Progress.php, method HTML_Progress::setIdent()
    Sets this Progress instance's identification string.
setIncrement
in file DM.php, method HTML_Progress_DM::setIncrement()
    Sets the progress bar's increment value.
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 DM.php, method HTML_Progress_DM::setMaximum()
    Sets the progress bar's maximum value.
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.
setMinimum
in file DM.php, method HTML_Progress_DM::setMinimum()
    Sets the progress bar's minimum value.
setModel
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.
setProgressAttributes
in file UI.php, method HTML_Progress_UI::setProgressAttributes()
    Sets the common progress bar attributes.
setProgressElement
in file monitor.php, method HTML_Progress_Monitor::setProgressElement()
    Attach a progress bar to this monitor.
setProgressHandler
in file monitor.php, method HTML_Progress_Monitor::setProgressHandler()
    Sets a user-defined progress handler function.
setProgressHandler
in file Progress.php, method HTML_Progress::setProgressHandler()
    Sets the user callback function that execute all actions pending progress
setScript
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.
setStringAttributes
in file UI.php, method HTML_Progress_UI::setStringAttributes()
    Sets the string attributes.
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 DM.php, method HTML_Progress_DM::setValue()
    Sets the progress bar's current value.
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.
top

t

toArray
in file Progress.php, method HTML_Progress::toArray()
    Returns the progress bar structure in an array.
toHtml
in file Progress.php, method HTML_Progress::toHtml()
    Returns the progress structure as HTML.
toHtml
in file monitor.php, method HTML_Progress_Monitor::toHtml()
    Returns Monitor forms as a Html string.
top

u

UI.php
procedural page UI.php
top

v

vertical.php
procedural page vertical.php
vbar.php
procedural page vbar.php
top

w

$windowname
in file monitor.php, variable HTML_Progress_Monitor::$windowname
    Attributes of monitor form.
top

_

_attributesArray
in file process.php, method ActionProcess::_attributesArray()
_methodExists
in file hbar.php, function _methodExists()
_renderForm
in file default.php, method ActionDisplay::_renderForm()
top

Documentation generated on Sun, 25 Sep 2005 17:25:18 +0200 by phpDocumentor 1.2.3