/***********************************************************************************
* ProgressBar, version 1.0.2
* (c) 2007 - 2008 Pierrick HYMBERT <pierrick [ dot ] hymbert [ at ] gmail [ dot ] com>
*
* ProgressBar is freely distributable
* and "PROVIDED AS IS" under the terms of an MIT-style license.
*
/************************************************************************************/
Download
ProgressBar is a pure JavaScript widget based on Prototype API 1.6
Version:
1.0.2
Last modified:
22/10/2008
Upload example
ProgressBar
Constructs a new instance of this class given its container
and a options map describing its behavior and appearance.
/**
* @constructor
*
* @param container:Element The HTML element where the bar will be drawn in.
*
* @param options.style:Integer
* Only one of the styles INDETERMINATE with/without TRANSPARENCY or DETERMINATE may be specified.
*
* @param options.color:Map
* Widget color.
*
* @param options.colorEnd:Map
* If the receiver behavior is DETERMINATE, the color end specified which color the bar items have when selection == maximum.
*
* @param options.classProgressBar:String
* The CSS class to defined position, top, left, width, height receiver attributes.
*
* @param options.minimum:Integer
* The selection minimum value (must be zero or greater).
*
* @param options.maximum:Integer
* The selection maximum value (must be zero or greater).
*
* @param options.selection:Integer
* The receiver current selection (must be zero or greater).
*
* @param options.executerInterval :Integer
* The interval (in milliseconds) for the update receiver function in the indeterminate behavior.
*
* @param options.noIndeterminateIndicators :Integer
* The number of indicators for the indeterminate behavior.
*
* @param options.widthIndicators :Integer
* The indicator width.
*
* @param options.indeterminateIndicatorsSpeed :Integer
* The indicator moving speed in pixel by options.executerInterval.
*/
getMaximum
Returns the maximum value which the receiver will allow.
/**
* @return Integer
* @public
*/
getMinimum
Returns the minimum value which the receiver will allow.
/**
* @return Integer
* @public
*/
getSelection
Returns the single 'selection' that is the receiver's position.
/**
* @return Integer
* @public
*/
setMaximum
Sets the maximum value that the receiver will allow to be the argument which must be greater than or equal to zero.
/**
* @param value:Integer The new maximum (must be zero or greater)
* @public
*/
setMinimum
Sets the minimum value that the receiver will allow to be the argument which must be greater than or equal to zero.
/**
* @param value:Integer The new minimum (must be zero or greater)
* @public
*/
setSelection
Sets the single 'selection' that is the receiver's position to the argument which must be greater than or equal to zero.
/**
* @param value:Integer The new selection (must be zero or greater)
* @public
*/
isDisposed
Returns true if the widget has been disposed, and false otherwise
/**
* @return Boolean
* @public
*/
dispose
Disposes the receiver and all its HTML Objects descendants.
/**
* @public
*/
getData
Returns the application defined property of the receiver with the specified name,
or null if it has not been set.
Applications may have associated arbitrary objects with the receiver in this fashion.
/**
* @param key:String the name of the property
* @return Object
*/
setData
Sets the application defined widget data associated with the receiver to be the argument.
/**
* @param key:String the name of the property
* @param value:String the new value for the property
*/
toString
Return the class identifier.
/**
* @return String
* @public
*/