#include "remoto!stdlib:js/widgets/widgets/metadataWidget.js"
Public Member Functions | |
| metadataWidget (d) | |
| activate () | |
| Activate the widget, which will cause changes to propagate to the form, and therefore the submit() mechanism. More... | |
| createRow (rn, rv) | |
| Create a metadata row. More... | |
| createWidget () | |
| Create the widget object. More... | |
| deactivate () | |
| Deactivate the widget, which will unbind input events from their callbacks. More... | |
| rowExists (n) | |
| See if a row exists with the name n. More... | |
| sync () | |
| Check the state of the widget against its internal value, and send an update if needed. More... | |
| takeRow (n) | |
| Find a row by name, remove it and return it. More... | |
| updateWidget () | |
| Update the rows to match the widget's 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 | |
| setter | value |
| Set the value of this object from a json object. More... | |
| setter | enabled |
| a setter Enable or disable this widget More... | |
Detailed Description
DOCME
Constructor & Destructor Documentation
◆ metadataWidget()
| metadataWidget | ( | d | ) |
- Parameters
-
d The widget definition object
DOCME
Member Function Documentation
◆ activate()
| activate | ( | ) |
Activate the widget, which will cause changes to propagate to the form, and therefore the submit() mechanism.
This will also listen for blur, which gives the widget a moment to clean up if needed.
◆ createRow()
| createRow | ( | rn, | |
| rv | |||
| ) |
Create a metadata row.
- Parameters
-
rn The name value for the row rv The value value for the row
- Returns
- The new row
This is for internal use; you should not call this.
◆ createWidget()
| createWidget | ( | ) |
Create the widget object.
- Returns
- The widget jquery object
◆ deactivate()
| deactivate | ( | ) |
Deactivate the widget, which will unbind input events from their callbacks.
◆ enabled()
| setter enabled |
a setter Enable or disable this widget
◆ rowExists()
| rowExists | ( | n | ) |
See if a row exists with the name n.
- Parameters
-
n The name of the row to search for
- Returns
- boolean value of if a named row exists
This is for internal use; you should not call this.
◆ sync()
| sync | ( | ) |
Check the state of the widget against its internal value, and send an update if needed.
- Returns
- false, for the jquery event
◆ takeRow()
| takeRow | ( | n | ) |
Find a row by name, remove it and return it.
- Parameters
-
n The name of the row to search for
- Returns
- The found row, or null
This is for internal use; you should not call this.
◆ updateWidget()
| updateWidget | ( | ) |
Update the rows to match the widget's internal value.
- Returns
This is for internal use; you should not call this.
◆ value()
| getter value |
Set the value of this object from a json object.
Return the json object value of this widget.
The documentation for this class was generated from the following file:
