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

Element index for package apidoc

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

a

accept
in file monitor.php, method HTML_Progress_Monitor::accept()
    Accepts a renderer
accept
in file uploader.php, method HTML_Progress_Uploader::accept()
    Accepts a renderer
ActionDisplay
in file SmartyDynamic.php, class ActionDisplay
ActionProcess
in file ProgressMaker.php, class ActionProcess
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
attachProgress
in file monitor_complex.php, method ProgressMonitor::attachProgress()
top

b

$buttonCancel
in file monitor.php, variable HTML_Progress_Monitor::$buttonCancel
    Attributes of monitor form.
$buttonCancel
in file uploader.php, variable HTML_Progress_Uploader::$buttonCancel
    Attributes of upload form.
$buttonStart
in file uploader.php, variable HTML_Progress_Uploader::$buttonStart
    Attributes of upload form.
$buttonStart
in file monitor.php, variable HTML_Progress_Monitor::$buttonStart
    Attributes of monitor form.
buildForm
in file ProgressMaker.php, method Ready::buildForm()
buildForm
in file ProgressMaker.php, method Property3::buildForm()
buildForm
in file ProgressMaker.php, method Property1::buildForm()
buildForm
in file ProgressMaker.php, method Property2::buildForm()
buildForm
in file ProgressMaker.php, method Property4::buildForm()
top

c

$captionMask
in file uploader.php, variable HTML_Progress_Uploader::$captionMask
    Attributes of upload form.
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.
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.
display
in file monitor_complex.php, method ProgressMonitor::display()
drawCircleSegments
in file UI.php, method HTML_Progress_UI::drawCircleSegments()
    Draw all circle segment pictures
top

e

enableButton
in file generator.php, method HTML_Progress_Generator::enableButton()
    Enables certain buttons for a page.
exportOutput
in file generator_embedded.php, method MyProcessHandler::exportOutput()
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.
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.
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.
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.
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 uploader.php, method HTML_Progress_Uploader::getScript()
    Returns progress javascript.
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 uploader.php, method HTML_Progress_Uploader::getStyle()
    Returns progress styles (StyleSheet).
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 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.
top

h

HTML_Progress
in file Progress.php, class HTML_Progress
HTML_Progress
in file Progress.php, method HTML_Progress::HTML_Progress()
    Constructor Summary
HTML_Progress_Generator
in file generator.php, class HTML_Progress_Generator
HTML_Progress_Generator
in file generator.php, method HTML_Progress_Generator::HTML_Progress_Generator()
    Constructor Summary
HTML_Progress_Model
in file model.php, class HTML_Progress_Model
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_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
HTML_Progress_UI
in file UI.php, method HTML_Progress_UI::HTML_Progress_UI()
    The progress bar's UI model class constructor
HTML_Progress_UI
in file UI.php, class HTML_Progress_UI
HTML_Progress_Uploader
in file uploader.php, method HTML_Progress_Uploader::HTML_Progress_Uploader()
    The progress uploader class constructor
HTML_Progress_Uploader
in file uploader.php, class HTML_Progress_Uploader
top

i

incValue
in file Progress.php, method HTML_Progress::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.
isCanceled
in file uploader.php, method HTML_Progress_Uploader::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 uploader.php, method HTML_Progress_Uploader::isStarted()
    Returns TRUE if progress was started by user, FALSE otherwise.
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.
top

l

logoff
in file uploader.php, method HTML_Progress_Uploader::logoff()
    Disconnect from a remote FTP server.
logon
in file uploader.php, method HTML_Progress_Uploader::logon()
    Connect on a remote FTP server and login as $user.
top

m

moveTo
in file uploader.php, method HTML_Progress_Uploader::moveTo()
    Uploads the files asynchronously, so the class can perform other operations while files are being uploaded, such : display a progress bar in indeterminate mode.
my1Method
in file progressHandler.php, method my2ClassHandler::my1Method()
my2ClassHandler
in file progressHandler.php, class my2ClassHandler
myClassHandler
in file progressHandler.php, class myClassHandler
MyDisplayHandler
in file generator_embedded.php, class MyDisplayHandler
myMethodHandler
in file progressHandler.php, method myClassHandler::myMethodHandler()
MyProcessHandler
in file generator_embedded.php, class MyProcessHandler
top

n

notify
in file monitor.php, method HTML_Progress_Monitor::notify()
    Listens all progress events from this monitor.
top

p

perform
in file generator_embedded.php, method MyProcessHandler::perform()
perform
in file ProgressMaker.php, method ActionProcess::perform()
ProgressMonitor
in file monitor_complex.php, class ProgressMonitor
ProgressMonitor
in file monitor_complex.php, method ProgressMonitor::ProgressMonitor()
Progress_ITDynamic
in file progressModels.php, method Progress_ITDynamic::Progress_ITDynamic()
Progress_ITDynamic
in file progressModels.php, class Progress_ITDynamic
Progress_ITDynamic2
in file progressModels.php, class Progress_ITDynamic2
Progress_ITDynamic2
in file progressModels.php, method Progress_ITDynamic2::Progress_ITDynamic2()
Property1
in file ProgressMaker.php, class Property1
    Progress main properties
Property2
in file ProgressMaker.php, class Property2
    Cell properties
Property3
in file ProgressMaker.php, class Property3
    Progress border properties
Property4
in file ProgressMaker.php, class Property4
    String properties
top

r

raiseError
in file Progress.php, method HTML_Progress::raiseError()
    Add an error to the stack Dies if the error is an exception (and would have died anyway)
Ready
in file ProgressMaker.php, class Ready
    Output page options
removeListener
in file Progress.php, method HTML_Progress::removeListener()
    Removes a HTML_Progress_Observer instance from the list of observers.
run
in file monitor.php, method HTML_Progress_Monitor::run()
    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.
setAnimSpeed
in file monitor.php, method HTML_Progress_Monitor::setAnimSpeed()
    Set the sleep delay in milisecond before each progress cells display.
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.
setFiles
in file uploader.php, method HTML_Progress_Uploader::setFiles()
    Set a list of files to upload on the ftp server.
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 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.
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 uploader.php, method HTML_Progress_Uploader::setProgressElement()
    Attach a progress bar to this uploader.
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.
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.
setValidExtensions
in file uploader.php, method HTML_Progress_Uploader::setValidExtensions()
    Restricts the valid extensions on file uploads.
setValue
in file Progress.php, method HTML_Progress::setValue()
    Sets the progress bar's current value stored in the progress bar's data model.
top

t

toArray
in file Progress.php, method HTML_Progress::toArray()
    Returns the progress bar structure in an array.
toHtml
in file uploader.php, method HTML_Progress_Uploader::toHtml()
    Returns Uploader forms as a Html string.
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.
toHtml
in file monitor_complex.php, method ProgressMonitor::toHtml()
top

w

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

Documentation generated on Mon, 11 Mar 2019 10:15:07 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.