HTML_Progress2
[ class tree: HTML_Progress2 ] [ index: HTML_Progress2 ] [ all elements ]
Packages:
HTML_Progress2


Classes:
ActionDisplay
ActionPreview
ActionProcess
HTML_Progress2
HTML_Progress2_Error
HTML_Progress2_Generator
HTML_Progress2_Lite
HTML_Progress2_Monitor
HTML_Progress2_Observer
Files:
Default.php
Error.php
Generator.php
HTMLPage2.php
ITDynamic.php
Monitor.php
Observer.php
Preview.php
Process.php
Progress2.php
Progress2_Lite.php
SmartyDynamic.php

Element index for package HTML_Progress2

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

_

__construct
in file Progress2_Lite.php, method HTML_Progress2_Lite::__construct()
    Constructor (ZE2) Summary.
__construct
in file Progress2.php, method HTML_Progress2::__construct()
    Constructor (ZE2) Summary
__construct
in file Monitor.php, method HTML_Progress2_Monitor::__construct()
    Constructor (ZE2) Summary
__construct
in file Generator.php, method HTML_Progress2_Generator::__construct()
    Constructor (ZE2) Summary
__construct
in file Error.php, method HTML_Progress2_Error::__construct()
    Constructor (ZE2)
top

a

$animSpeed
in file Progress2.php, variable HTML_Progress2::$animSpeed
    Delay in milisecond before each progress cells display.
$autorun
in file Monitor.php, variable HTML_Progress2_Monitor::$autorun
    Attributes of monitor form.
accept
in file Monitor.php, method HTML_Progress2_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_Progress2_Generator.
ActionProcess
in file Process.php, class ActionProcess
    The ActionProcess class provides final step of ProgressBar creation.
addButton
in file Progress2_Lite.php, method HTML_Progress2_Lite::addButton()
    Add a new button with the progress bar.
addLabel
in file Progress2_Lite.php, method HTML_Progress2_Lite::addLabel()
    Add a new label to the progress bar.
addLabel
in file Progress2.php, method HTML_Progress2::addLabel()
    Add a new label to the progress bar.
addListener
in file Progress2.php, method HTML_Progress2::addListener()
    Adds a HTML_Progress2_Observer instance to the list of observers that are listening for messages emitted by this HTML_Progress2 instance.
apiVersion
in file Progress2.php, method HTML_Progress2::apiVersion()
    Returns the current API version compatible with php.version_compare()
top

b

$background_color
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$background_color
    Progress bar foreground color.
$border
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$border
    Progress bar border properties
$border
in file Progress2.php, variable HTML_Progress2::$border
    Progress bar border properties
$buttonCancel
in file Monitor.php, variable HTML_Progress2_Monitor::$buttonCancel
    Attributes of monitor form.
$buttonStart
in file Monitor.php, variable HTML_Progress2_Monitor::$buttonStart
    Attributes of monitor form.
top

c

$caption
in file Monitor.php, variable HTML_Progress2_Monitor::$caption
    Monitor status (text label of progress bar).
$cell
in file Progress2.php, variable HTML_Progress2::$cell
    Progress bar cells properties
$cellCount
in file Progress2.php, variable HTML_Progress2::$cellCount
    The cell count of the progress bar. The default is 10.
createButtons
in file Generator.php, method HTML_Progress2_Generator::createButtons()
    Adds all necessary buttons to the given page object.
createProgressBar
in file Generator.php, method HTML_Progress2_Generator::createProgressBar()
    Creates a progress bar with options choosen on all wizard tabs.
createProgressStructure
in file Generator.php, method HTML_Progress2_Generator::createProgressStructure()
    Creates a progress bar structure with options choosen on all wizard tabs.
createTabs
in file Generator.php, method HTML_Progress2_Generator::createTabs()
    Adds all necessary tabs to the given page object.
top

d

$direction
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$direction
    Direction of motion (right, left, up, down).
disableButton
in file Generator.php, method HTML_Progress2_Generator::disableButton()
    Disables certain buttons for a page.
display
in file Progress2_Lite.php, method HTML_Progress2_Lite::display()
    Show the renders of the progress bar.
display
in file Progress2.php, method HTML_Progress2::display()
    Renders the new value of progress bar.
drawCircleSegments
in file Progress2.php, method HTML_Progress2::drawCircleSegments()
    Draw all circle segment pictures
Default.php
procedural page Default.php
top

e

enableButton
in file Generator.php, method HTML_Progress2_Generator::enableButton()
    Enables certain buttons for a page.
exportOutput
in file Process.php, method ActionProcess::exportOutput()
    Prints a string to standard output, with http headers if necessary
Error.php
procedural page Error.php
top

f

$fillWay
in file Progress2.php, variable HTML_Progress2::$fillWay
    Whether the progress bar is filled in 'natural' or 'reverse' way.
$foreground_color
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$foreground_color
    Progress bar foreground color.
$frame
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$frame
    Progress bar frame properties
$frame
in file Progress2.php, variable HTML_Progress2::$frame
    Progress bar frame properties
top

g

getAnimSpeed
in file Progress2.php, method HTML_Progress2::getAnimSpeed()
    Returns delay execution of the progress bar
getBorderAttributes
in file Progress2.php, method HTML_Progress2::getBorderAttributes()
    Returns the progress bar's border attributes. Assoc array (defaut) or string.
getCellAttributes
in file Progress2.php, method HTML_Progress2::getCellAttributes()
    Returns the common and private cell attributes. Assoc array (defaut) or string
getCellCoordinates
in file Progress2.php, method HTML_Progress2::getCellCoordinates()
    Returns the coordinates of each cell for a polygonal progress shape.
getCellCount
in file Progress2.php, method HTML_Progress2::getCellCount()
    Returns the number of cell in the progress bar. The default value is 10.
getError
in file Progress2.php, method HTML_Progress2::getError()
    Pop an error off of the HTML_Progress2 stack
getFillWay
in file Progress2.php, method HTML_Progress2::getFillWay()
    Returns 'natural' or 'reverse', depending of the fill way of progress bar.
getFrameAttributes
in file Progress2.php, method HTML_Progress2::getFrameAttributes()
    Returns the frame attributes. Assoc array (defaut) or string.
getIdent
in file Progress2.php, method HTML_Progress2::getIdent()
    Returns the current identification string.
getIncrement
in file Progress2.php, method HTML_Progress2::getIncrement()
    Returns the progress bar's increment value. The default value is +1.
getLabelAttributes
in file Progress2.php, method HTML_Progress2::getLabelAttributes()
    Returns the label attributes. Assoc array (defaut) or string.
getLevel
in file Error.php, method HTML_Progress2_Error::getLevel()
    Get error level from an error object
getListeners
in file Progress2.php, method HTML_Progress2::getListeners()
    Returns an array of all the listeners added to this progress bar.
getMaximum
in file Progress2.php, method HTML_Progress2::getMaximum()
    Returns the progress bar's maximum value. The default value is 100.
getMinimum
in file Progress2.php, method HTML_Progress2::getMinimum()
    Returns the progress bar's minimum value. The default value is 0.
getOrientation
in file Progress2.php, method HTML_Progress2::getOrientation()
    Returns HTML_PROGRESS2_BAR_HORIZONTAL or HTML_PROGRESS2_BAR_VERTICAL, depending on the orientation of the progress bar.
getPercentComplete
in file Progress2.php, method HTML_Progress2::getPercentComplete()
    Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00.
getProgressAttributes
in file Progress2.php, method HTML_Progress2::getProgressAttributes()
    Returns the progress attributes. Assoc array (defaut) or string.
getProgressElement
in file Monitor.php, method HTML_Progress2_Monitor::getProgressElement()
    Returns a reference to the progress bar object used with the monitor.
getScript
in file Monitor.php, method HTML_Progress2_Monitor::getScript()
    Returns progress javascript.
getScript
in file Progress2.php, method HTML_Progress2::getScript()
    Get the javascript URL or inline code to manage progress bar.
getStyle
in file Progress2.php, method HTML_Progress2::getStyle()
    Get the cascading style sheet to put inline on HTML document
getStyle
in file Monitor.php, method HTML_Progress2_Monitor::getStyle()
    Returns progress styles (StyleSheet).
getValue
in file Progress2.php, method HTML_Progress2::getValue()
    Returns the progress bar's current value. The value is always between the minimum and maximum values, inclusive.
Generator.php
procedural page Generator.php
top

h

$height
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$height
    Progress bar height in pixel.
hasErrors
in file Progress2.php, method HTML_Progress2::hasErrors()
    Determine whether there are errors into the HTML_Progress2 stack
hide
in file Progress2_Lite.php, method HTML_Progress2_Lite::hide()
    Hides the progress bar.
hide
in file Progress2.php, method HTML_Progress2::hide()
    Hides the progress bar.
HTML_Progress2
in file Progress2.php, class HTML_Progress2
    The HTML_Progress2 class allow you to add a loading bar to any of your xhtml document.
HTML_Progress2
in file Progress2.php, method HTML_Progress2::HTML_Progress2()
    Constructor (ZE1)
HTMLPage2.php
procedural page HTMLPage2.php
HTML_PROGRESS2_BAR_HORIZONTAL
in file Progress2.php, constant HTML_PROGRESS2_BAR_HORIZONTAL
    Progress Bar shape types
HTML_PROGRESS2_BAR_VERTICAL
in file Progress2.php, constant HTML_PROGRESS2_BAR_VERTICAL
    Progress Bar shape types
HTML_PROGRESS2_CIRCLE
in file Progress2.php, constant HTML_PROGRESS2_CIRCLE
    Progress Bar shape types
HTML_Progress2_Error
in file Error.php, method HTML_Progress2_Error::HTML_Progress2_Error()
    Constructor (ZE1)
HTML_Progress2_Error
in file Error.php, class HTML_Progress2_Error
    This class creates a progress error object, extending the PEAR_Error class.
HTML_PROGRESS2_ERROR_DEPRECATED
in file Progress2.php, constant HTML_PROGRESS2_ERROR_DEPRECATED
    Basic error code that indicate a deprecated method that may be removed at any time from a future version
HTML_PROGRESS2_ERROR_INVALID_CALLBACK
in file Progress2.php, constant HTML_PROGRESS2_ERROR_INVALID_CALLBACK
    Basic error code that indicate a wrong callback definition.
HTML_PROGRESS2_ERROR_INVALID_INPUT
in file Progress2.php, constant HTML_PROGRESS2_ERROR_INVALID_INPUT
    Basic error code that indicate a wrong input
HTML_PROGRESS2_ERROR_INVALID_OPTION
in file Progress2.php, constant HTML_PROGRESS2_ERROR_INVALID_OPTION
    Basic error code that indicate an invalid option.
HTML_PROGRESS2_ERROR_UNKNOWN
in file Progress2.php, constant HTML_PROGRESS2_ERROR_UNKNOWN
    Basic error code that indicate an unknown message
HTML_Progress2_Generator
in file Generator.php, method HTML_Progress2_Generator::HTML_Progress2_Generator()
    Constructor (ZE1)
HTML_Progress2_Generator
in file Generator.php, class HTML_Progress2_Generator
    The HTML_Progress2_Generator class provides an easy way to build progress bar, show a preview, and save php/css code for a later reuse.
HTML_PROGRESS2_LABEL_BUTTON
in file Progress2.php, constant HTML_PROGRESS2_LABEL_BUTTON
    Progress Bar label types
HTML_PROGRESS2_LABEL_CROSSBAR
in file Progress2.php, constant HTML_PROGRESS2_LABEL_CROSSBAR
    Progress Bar label types
HTML_PROGRESS2_LABEL_PERCENT
in file Progress2.php, constant HTML_PROGRESS2_LABEL_PERCENT
    Progress Bar label types
HTML_PROGRESS2_LABEL_STEP
in file Progress2.php, constant HTML_PROGRESS2_LABEL_STEP
    Progress Bar label types
HTML_PROGRESS2_LABEL_TEXT
in file Progress2.php, constant HTML_PROGRESS2_LABEL_TEXT
    Progress Bar label types
HTML_Progress2_Lite
in file Progress2_Lite.php, method HTML_Progress2_Lite::HTML_Progress2_Lite()
    Constructor (ZE1)
HTML_Progress2_Lite
in file Progress2_Lite.php, class HTML_Progress2_Lite
    The HTML_Progress2_Lite class allow you to add a quick horizontal or vertical loading bar to any of your xhtml document.
HTML_Progress2_Monitor
in file Monitor.php, method HTML_Progress2_Monitor::HTML_Progress2_Monitor()
    Constructor (ZE1)
HTML_Progress2_Monitor
in file Monitor.php, class HTML_Progress2_Monitor
    The HTML_Progress2_Monitor class allow an easy way to display progress in a dialog. The user can cancel the task.
HTML_Progress2_Observer
in file Observer.php, method HTML_Progress2_Observer::HTML_Progress2_Observer()
    Creates a new basic HTML_Progress2_Observer instance.
HTML_Progress2_Observer
in file Observer.php, class HTML_Progress2_Observer
    The HTML_Progress2_Observer implements the observer pattern for watching progress bar activity and taking actions on exceptional events.
HTML_PROGRESS2_POLYGONAL
in file Progress2.php, constant HTML_PROGRESS2_POLYGONAL
    Progress Bar shape types
top

i

$ident
in file Progress2.php, variable HTML_Progress2::$ident
    The label that uniquely identifies this progress object.
$increment
in file Progress2.php, variable HTML_Progress2::$increment
    The progress bar's increment value.
$indeterminate
in file Progress2.php, variable HTML_Progress2::$indeterminate
    Whether the progress bar is in determinate or indeterminate mode.
ITDynamic.php
procedural page ITDynamic.php
incValue
in file Progress2.php, method HTML_Progress2::incValue()
    Updates the progress bar's current value by adding increment value.
isBorderPainted
in file Progress2.php, method HTML_Progress2::isBorderPainted()
    Determines whether the progress bar border is painted or not.
isCanceled
in file Monitor.php, method HTML_Progress2_Monitor::isCanceled()
    Returns TRUE if progress was canceled by user, FALSE otherwise.
isIndeterminate
in file Progress2.php, method HTML_Progress2::isIndeterminate()
    Returns mode of the progress bar (determinate or not).
isStarted
in file Monitor.php, method HTML_Progress2_Monitor::isStarted()
    Returns TRUE if progress was started by user, FALSE otherwise.
top

l

$label
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$label
    Progress bar labels properties
$label
in file Progress2.php, variable HTML_Progress2::$label
    Progress bar labels properties
$left
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$left
    Progress bar position from left.
log
in file Error.php, method HTML_Progress2_Error::log()
    Default callback function/method from an error object
top

m

$max
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$max
    Maximum steps of the progress bar.
$maximum
in file Progress2.php, variable HTML_Progress2::$maximum
    The progress bar's maximum value.
$min
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$min
    Minimum steps of the progress bar.
$minimum
in file Progress2.php, variable HTML_Progress2::$minimum
    The progress bar's minimum value.
Monitor.php
procedural page Monitor.php
moveMin
in file Progress2_Lite.php, method HTML_Progress2_Lite::moveMin()
    Changes value of the progress bar to the minimum step.
moveNext
in file Progress2_Lite.php, method HTML_Progress2_Lite::moveNext()
    Changes value of the progress bar to the next step.
moveNext
in file Progress2.php, method HTML_Progress2::moveNext()
    Changes value of the progress bar to the next step.
moveStep
in file Progress2_Lite.php, method HTML_Progress2_Lite::moveStep()
    Changes new step value of the progress bar.
moveStep
in file Progress2.php, method HTML_Progress2::moveStep()
    Changes new step value of the progress bar.
top

n

notify
in file Observer.php, method HTML_Progress2_Observer::notify()
    This is a stub method to make sure that HTML_Progress2_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_Progress2_Monitor::notify()
    Listens all progress events from this monitor.
top

o

$orientation
in file Progress2.php, variable HTML_Progress2::$orientation
    Whether the progress bar is horizontal, vertical, polygonal or circle.
Observer.php
procedural page Observer.php
ob_get_clean
in file Progress2_Lite.php, function ob_get_clean()
top

p

$padding
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$padding
    Progress bar padding in pixel.
$position
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$position
    Progress bar position (absolute, relative).
Preview.php
procedural page Preview.php
Process.php
procedural page Process.php
Progress2.php
procedural page Progress2.php
Progress2_Lite.php
procedural page Progress2_Lite.php
perform
in file Preview.php, method ActionPreview::perform()
perform
in file Process.php, method ActionProcess::perform()
    Performs an action on a page of the controller (wizard)
PHP_EOL
in file Progress2_Lite.php, constant PHP_EOL
process
in file Progress2.php, method HTML_Progress2::process()
    Performs the progress actions
top

r

raiseError
in file Progress2.php, method HTML_Progress2::raiseError()
    A basic wrapper around the default PEAR_Error object
removeButton
in file Progress2_Lite.php, method HTML_Progress2_Lite::removeButton()
    Removes a button to the progress bar.
removeLabel
in file Progress2_Lite.php, method HTML_Progress2_Lite::removeLabel()
    Removes a label to the progress bar.
removeLabel
in file Progress2.php, method HTML_Progress2::removeLabel()
    Removes a label to the progress bar.
removeListener
in file Progress2.php, method HTML_Progress2::removeListener()
    Removes a HTML_Progress2_Observer instance from the list of observers.
run
in file Progress2.php, method HTML_Progress2::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_Progress2_Monitor::run()
    Display Monitor and catch user action (cancel button).
top

s

$script
in file Progress2.php, variable HTML_Progress2::$script
    External Javascript file to override internal default code
SmartyDynamic.php
procedural page SmartyDynamic.php
setAnimSpeed
in file Progress2.php, method HTML_Progress2::setAnimSpeed()
    Set the delays progress bar execution for the given number of miliseconds.
setBarAttributes
in file Progress2_Lite.php, method HTML_Progress2_Lite::setBarAttributes()
    Defines main style of a progress bar.
setBorderAttributes
in file Progress2.php, method HTML_Progress2::setBorderAttributes()
    Sets the progress bar's border attributes.
setBorderPainted
in file Progress2.php, method HTML_Progress2::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_Progress2_Monitor::setCaption()
    Display a caption on action in progress.
setCellAttributes
in file Progress2.php, method HTML_Progress2::setCellAttributes()
    Sets the cell attributes for an existing cell.
setCellCoordinates
in file Progress2.php, method HTML_Progress2::setCellCoordinates()
    Set the coordinates of each cell for a polygonal progress shape.
setCellCount
in file Progress2.php, method HTML_Progress2::setCellCount()
    Sets the number of cell in the progress bar
setDirection
in file Progress2_Lite.php, method HTML_Progress2_Lite::setDirection()
    Moves the progress bar in all directions (left, right, up , down).
setFillWay
in file Progress2.php, method HTML_Progress2::setFillWay()
    Sets the progress bar's fill way, which must be 'natural' or 'reverse'.
setFrameAttributes
in file Progress2.php, method HTML_Progress2::setFrameAttributes()
    Build a frame around the progress bar.
setFrameAttributes
in file Progress2_Lite.php, method HTML_Progress2_Lite::setFrameAttributes()
    Build a frame around the progress bar.
setIdent
in file Progress2.php, method HTML_Progress2::setIdent()
    Sets this Progress instance's identification string.
setIncrement
in file Progress2.php, method HTML_Progress2::setIncrement()
    Sets the progress bar's increment value.
setIndeterminate
in file Progress2.php, method HTML_Progress2::setIndeterminate()
    Sets the $indeterminate property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode.
setLabelAttributes
in file Progress2_Lite.php, method HTML_Progress2_Lite::setLabelAttributes()
    Defines style of a progress bar label.
setLabelAttributes
in file Progress2.php, method HTML_Progress2::setLabelAttributes()
    Sets label attributes.
setMaximum
in file Progress2.php, method HTML_Progress2::setMaximum()
    Sets the progress bar's maximum value.
setMinimum
in file Progress2.php, method HTML_Progress2::setMinimum()
    Sets the progress bar's minimum value.
setOrientation
in file Progress2.php, method HTML_Progress2::setOrientation()
    Sets the progress bar's orientation, which must be HTML_PROGRESS2_BAR_HORIZONTAL or HTML_PROGRESS2_BAR_VERTICAL.
setProgressAttributes
in file Progress2.php, method HTML_Progress2::setProgressAttributes()
    Sets the common progress bar attributes.
setProgressElement
in file Monitor.php, method HTML_Progress2_Monitor::setProgressElement()
    Attach a progress bar to this monitor.
setProgressHandler
in file Monitor.php, method HTML_Progress2_Monitor::setProgressHandler()
    Sets a user-defined progress handler function.
setProgressHandler
in file Progress2.php, method HTML_Progress2::setProgressHandler()
    Sets the user callback function that execute all actions pending progress
setScript
in file Progress2.php, method HTML_Progress2::setScript()
    Set the external JavaScript code (file) to manage progress element.
setValue
in file Progress2.php, method HTML_Progress2::setValue()
    Sets the progress bar's current value.
show
in file Progress2_Lite.php, method HTML_Progress2_Lite::show()
    Shows a progress bar hidden.
sleep
in file Progress2.php, method HTML_Progress2::sleep()
    Default user callback when none are defined.
sprintContextExec
in file Error.php, method HTML_Progress2_Error::sprintContextExec()
    Returns the context of execution formatted.
sprintCSS
in file Process.php, method ActionProcess::sprintCSS()
    Returns a formatted string of the progress meter stylesheet
sprintPHP
in file Process.php, method ActionProcess::sprintPHP()
    Returns a formatted string of the progress meter php code
top

t

$top
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$top
    Progress bar position from top.
toArray
in file Progress2.php, method HTML_Progress2::toArray()
    Returns the progress bar structure in an array.
toHtml
in file Progress2_Lite.php, method HTML_Progress2_Lite::toHtml()
    Returns the progress bar structure as HTML.
toHtml
in file Progress2.php, method HTML_Progress2::toHtml()
    Returns the progress structure as HTML.
toHtml
in file Monitor.php, method HTML_Progress2_Monitor::toHtml()
    Returns Monitor forms as a Html string.
top

v

$value
in file Progress2.php, variable HTML_Progress2::$value
    The progress bar's current value.
top

w

$width
in file Progress2_Lite.php, variable HTML_Progress2_Lite::$width
    Progress bar width in pixel.
$windowname
in file Monitor.php, variable HTML_Progress2_Monitor::$windowname
    Attributes of monitor form.
top
Documentation generated on Mon, 11 Mar 2019 14:18:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.