progressWidget Class Reference
A form widget for viewing progress. More...
#include "remoto!stdlib:js/widgets/widgets/progressWidget.js"
Inheritance diagram for progressWidget:
Public Member Functions | |
| progressWidget (d) | |
| progressWidget constructor More... | |
| applyOptions () | |
| Apply option changes to an existing widget, like from a diff. More... | |
| createWidget () | |
| Create the html for this widget. More... | |
 Public Member Functions inherited from widget | |
| widget (d) | |
| widget contstructor More... | |
| activate () | |
| Activate the widget, which will cause changes to propagate to the form, and therefore the submit() mechanism. More... | |
| applyOptions () | |
| Apply option changes to an existing widget, like from a diff. More... | |
| arrowMessage (m) | |
| Create an arrowMessage and point its arrow at this widget's position on screen. More... | |
| createHTML () | |
| Create the HTML representation of this object, including the label and form field. More... | |
| createLabel () | |
| Create the label jQuery object. More... | |
| createWidget () | |
| Create the widget jQuery object. More... | |
| deactivate () | |
| Deactivate the widget, which will unbind input events from their callbacks. More... | |
| destroy () | |
| Destroy this widget. More... | |
| disable () | |
| Disable this widget. More... | |
| doChange () | |
Collect changes to the value of this widget and call this widget's _change method, if it exists, after a period of the user's uifreqency has expired. More... | |
| enable () | |
| Enable this widget. More... | |
| sync () | |
| Sync the visible value with the internal value. More... | |
| validate () | |
| Validate the value of this widget using the _validator function. More... | |
| setter | immediateValue |
| Set the value of this widget, and trigger the doChange method without waiting. More... | |
| getter | value |
| Return the internal value of this widget, which may not be the same as what is displayed in the interface. More... | |
| getter | defaultValue |
| Return the default value of this widget. More... | |
| getter | visibleWidget |
| Return the visible jQuery object for this widget. More... | |
| getter | isDefault |
| Return whether or not this widget's value is its default value. More... | |
| getter | nonDefaultValue |
| Return the value of this widget, or return undefined if it contains the default value. More... | |
| setter | validator |
| Set this widget's validator function. More... | |
| setter | error |
| Set the error value of this widget. More... | |
| setter | activeUser |
| Set the activeUser of this widget. More... | |
| getter | enabled |
| Return true or false based on _enabled state. More... | |
| getter | hidden |
| The hidden state of this widget. More... | |
Getters & Setters | |
| getter | value |
| Returns the value of this widget. More... | |
Detailed Description
A form widget for viewing progress.
This will create a progress bar displaying progress from 0-100%.
If the max option is set, the value field will set percentage. If no max is set, value should be between 0.0 and 1.0 .
If the 'hideNumberoption is set totrue`, the numerical value will be hidden.
The 'numberMode' option can be outof for value / max display, otherwise it will be formatted as a percent.
Constructor & Destructor Documentation
◆ progressWidget()
| progressWidget | ( | d | ) |
progressWidget constructor
- Parameters
-
d
Member Function Documentation
◆ applyOptions()
| applyOptions | ( | ) |
Apply option changes to an existing widget, like from a diff.
- See also
- widget::applyOptions()
◆ createWidget()
| createWidget | ( | ) |
Create the html for this widget.
- Returns
- The created html as a jquery object
◆ value()
| setter value |
Returns the value of this widget.
Sets the value of this widget.
The documentation for this class was generated from the following file:
