Class: HTML_Progress
Source Location: /HTML_Progress-1.2.0RC3/Progress.php
Inherited Variables
|
Inherited Methods
|
Class Details
[line 86]
Method Detail
HTML_Progress (Constructor) [line 270]
HTML_Progress HTML_Progress(
object
$model, int
$orient, int
$min, int
$max, array
$errorPrefs)
|
|
Constructor Summary - Creates a natural horizontal progress bar that displays ten cells/units
with no border and no progress string.
The initial and minimum values are 0, and the maximum is 100.
$bar = new HTML_Progress();
- Creates a natural progress bar with the specified orientation, which can be
either HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL
By default, no border and no progress string are painted.
The initial and minimum values are 0, and the maximum is 100.
$bar = new HTML_Progress($orient);
- Creates a natural horizontal progress bar with the specified minimum and
maximum. Sets the initial value of the progress bar to the specified
minimum, and the maximum that the progress bar can reach.
By default, no border and no progress string are painted.
$bar = new HTML_Progress($min, $max);
- Creates a natural horizontal progress bar with the specified orientation,
minimum and maximum. Sets the initial value of the progress bar to the
specified minimum, and the maximum that the progress bar can reach.
By default, no border and no progress string are painted.
$bar = new HTML_Progress($orient, $min, $max);
- Creates a natural horizontal progress that uses the specified model
to hold the progress bar's data.
By default, no border and no progress string are painted.
$bar = new HTML_Progress($model);
Parameters:
addListener [line 1298]
boolean addListener(
object
$observer)
|
|
Adds a HTML_Progress_Observer instance to the list of observers that are listening for messages emitted by this HTML_Progress instance.
Parameters:
apiVersion [line 379]
Returns the current API version
display [line 1096]
Renders the new value of progress bar.
getAnimSpeed [line 860]
Returns delay execution of the progress bar
getDM [line 557]
Returns the data model used by this progress bar.
getError [line 1831]
Pop an error off of the HTML_Progress stack
getIdent [line 1248]
Returns the current identification string.
getIncrement [line 688]
Returns the progress bar's increment value stored in the progress bar's data model. The default value is +1.
getListeners [line 1280]
Returns an array of all the listeners added to this progress bar.
getMaximum [line 647]
Returns the progress bar's maximum value stored in the progress bar's data model. The default value is 100.
getMinimum [line 606]
Returns the progress bar's minimum value stored in the progress bar's data model. The default value is 0.
getPercentComplete [line 781]
float getPercentComplete(
)
|
|
Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00.
getScript [line 933]
Get the javascript code to manage progress bar.
getString [line 520]
Returns the current value of the progress string. By default, the progress bar displays the value returned by getPercentComplete() method formatted as a percent such as 33%.
getStyle [line 912]
Get the cascading style sheet to put inline on HTML document
getUI [line 794]
Returns the look-and-feel object that renders the progress bar.
getValue [line 723]
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. By default, the value is initialized to be equal to the minimum value.
hasErrors [line 1818]
Determine whether there are any errors on the HTML_Progress stack
hide [line 1142]
incValue [line 764]
Updates the progress bar's current value by adding increment value. All change listeners are notified.
isBorderPainted [line 436]
boolean isBorderPainted(
)
|
|
Determines whether the progress bar border is painted or not. The default is false.
isIndeterminate [line 393]
boolean isIndeterminate(
)
|
|
Returns mode of the progress bar (determinate or not).
isStringPainted [line 479]
boolean isStringPainted(
)
|
|
Determines whether the progress bar string is painted or not. The default is false. The progress bar displays the value returned by getPercentComplete() method formatted as a percent such as 33%.
process [line 1204]
Performs the progress actions
raiseError [line 1800]
array raiseError(
integer
$code, string
$level, array
$params, [boolean
$msg = false])
|
|
Add an error to the stack Dies if the error is an exception (and would have died anyway)
Parameters:
removeListener [line 1320]
boolean removeListener(
object
$observer)
|
|
Removes a HTML_Progress_Observer instance from the list of observers.
Parameters:
run [line 1224]
Runs the progress bar (both modes: indeterminate and determinate), and execute all actions defined in user callback identified by method setProgressHandler.
setAnimSpeed [line 877]
void setAnimSpeed(
integer
$delay)
|
|
Set the delays progress bar execution for the given number of miliseconds.
Parameters:
setBorderPainted [line 454]
void setBorderPainted(
boolean
$paint)
|
|
Sets the value of $_paintBorder property, which determines whether the progress bar should paint its border. The default is false.
Parameters:
setDM [line 573]
void setDM(
string
$model)
|
|
Sets the data model used by this progress bar.
Parameters:
setIdent [line 1262]
void setIdent(
[mixed
$ident = null])
|
|
Sets this Progress instance's identification string.
Parameters:
setIncrement [line 705]
void setIncrement(
integer
$inc)
|
|
Sets the progress bar's increment value stored in the progress bar's data model.
Parameters:
setIndeterminate [line 414]
void setIndeterminate(
boolean
$continuous)
|
|
Sets the $_indeterminate property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode. An indeterminate progress bar continuously displays animation indicating that an operation of unknown length is occuring. By default, this property is false.
Parameters:
setMaximum [line 666]
void setMaximum(
integer
$max)
|
|
Sets the progress bar's maximum value stored in the progress bar's data model. If the maximum value is different from previous maximum, all change listeners are notified.
Parameters:
setMinimum [line 625]
void setMinimum(
integer
$min)
|
|
Sets the progress bar's minimum value stored in the progress bar's data model. If the minimum value is different from previous minimum, all change listeners are notified.
Parameters:
setModel [line 844]
void setModel(
string
$file, string
$type)
|
|
Sets the look-and-feel model that renders the progress bar.
Parameters:
setProgressHandler [line 1184]
void setProgressHandler(
mixed
$handler)
|
|
Sets the user callback function that execute all actions pending progress
Parameters:
setString [line 544]
void setString(
string
$str)
|
|
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. The progress string is painted only if the isStringPainted() method returns true.
Parameters:
setStringPainted [line 497]
void setStringPainted(
boolean
$paint)
|
|
Sets the value of $_paintString property, which determines whether the progress bar should render a progress string. The default is false.
Parameters:
setUI [line 810]
Sets the look-and-feel object that renders the progress bar.
Parameters:
setValue [line 742]
void setValue(
integer
$val)
|
|
Sets the progress bar's current value stored in the progress bar's data model. If the new value is different from previous value, all change listeners are notified.
Parameters:
sleep [line 1167]
Default user callback when none are defined
toArray [line 947]
Returns the progress bar structure in an array.
toHtml [line 985]
Returns the progress structure as HTML.
Documentation generated on Mon, 11 Mar 2019 13:52:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|
