textareaWidget Class Reference
A textarea widget for multi-line input. More...
#include "remoto!stdlib:js/widgets/widgets/textareaWidget.js"
Inheritance diagram for textareaWidget:
Public Member Functions | |
| textareaWidget (d) | |
| createWidget () | |
| Create the widget and apply options. 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... | |
Detailed Description
A textarea widget for multi-line input.
Options:
- nocapturekeys - boolean allow all keypresses to escape this widget. The keys affected are tab, enter, [meta]-s, backspace/delete, and escape. These keys usually have special meaning and the default action is prevented unless this flag is set to true.
- wrap - boolean wrap at the width of the field. Defaults to browser default, which is wrap=true.
- monospace - boolean font setting. When entering code, monospace makes more sense.
- height - often times a textarea wants more space than the default 50px. This is a css string, which will usually require a css unit suffix, for example "100px".
- autofocus - when a form is opened, automatically give focus to this field. If multiple fields have autofocus, the result is undefined.
The normal widget options will still apply.
If a field wants to represent code, you will almost certainly want to set nocapturekeys=true, wrap=false, monospace=true, spellcheck=false, and probably a height using css syntax.
- See also
- textareaField
Constructor & Destructor Documentation
◆ textareaWidget()
| textareaWidget | ( | d | ) |
- Parameters
-
d The widget definition object
Member Function Documentation
◆ createWidget()
| createWidget | ( | ) |
Create the widget and apply options.
- Returns
- The textarea jQuery object
This will also apply keyboard input options, regardless of enabled state.
The documentation for this class was generated from the following file:
