booleanWidget Class Reference
A checkbox/boolean widget. More...
#include "remoto!stdlib:js/widgets/widgets/booleanWidget.js"
Inheritance diagram for booleanWidget:
Public Member Functions | |
| booleanWidget (d) | |
| activate () | |
| Activate the widget, which will cause changes to propagate to the form, and therefore the submit() mechanism. More... | |
| createWidget () | |
| Create the widget jQuery object. More... | |
| sync () | |
| Sync the visible value with the internal value. 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 |
| a getter DOCME More... | |
Detailed Description
A checkbox/boolean widget.
Options include:
- text - A string to place to the right of the checkbox, separate from the normal label
Constructor & Destructor Documentation
◆ booleanWidget()
| booleanWidget | ( | d | ) |
- Parameters
-
d The widget definition object
For initialization, d.value can be string "true" or boolean true.
Member Function Documentation
◆ activate()
| activate | ( | ) |
Activate the widget, which will cause changes to propagate to the form, and therefore the submit() mechanism.
Subclassed from widget.js, this only listens for "change", not "input". It also squashes propagation of "click" events.
◆ createWidget()
| createWidget | ( | ) |
Create the widget jQuery object.
- Returns
- the widget jQuery object
Optionally, a text string can be placed to the right of the checkbox by including the "text" option.
- See also
- widget::createWidget
◆ sync()
| sync | ( | ) |
Sync the visible value with the internal value.
◆ value()
| setter value |
a getter DOCME
a setter DOCME
The documentation for this class was generated from the following file:
