form Class Reference
Form renderer. More...
#include "remoto!stdlib:js/panes/panes/form.js"
Inheritance diagram for form:
Public Member Functions | |
| form (layout) | |
| applyDiff (diff, user) | |
| Apply an incoming diff to the fields in this form. More... | |
| applySettings (settings) | |
| applySubscription (data, metadata) | |
| changeField (variable, value, widget) | |
| createHTML () | |
| Create the jquery content object, or return it if it exists. More... | |
| destroy () | |
| getField (field) | |
| Fetch a widget object by field name if it exists, or null if non-existent. More... | |
| getValue (field) | |
| Fetch the value of a field if it exists, or null if non-existent. More... | |
| getValues () | |
| validate () | |
 Public Member Functions inherited from pane | |
| pane (layout, object) | |
| activate () | |
| DOCME. More... | |
| applyDiff (data, user) | |
| applyReleaseLock (data) | |
| applyRequestError (command, id, reason) | |
| applyRequestLock (data) | |
| applyRequestSuccess (command, id, data, metadata) | |
| applySettings (settings) | |
| applySubscription (data, metadata) | |
| area () | |
| attach () | |
| Provides an opportunity for a pane to pass an attach command to its object. More... | |
| attached () | |
| Detects is this pane is attached to the DOM. More... | |
| createHTML () | |
| deactivate () | |
If a deactivate method is present on this pane's _object, call it. More... | |
| destroy () | |
| DOCME. More... | |
| detach () | |
Detach this._html and call this._object.detach(). More... | |
| find (p, type) | |
| hasHelp () | |
| mounted (mountState) | |
| Notify this pane that the mounted state has changed. More... | |
| rename (name) | |
| resize () | |
| DOCME. More... | |
| saveLayout () | |
| Build the layout for this pane. More... | |
| triggerCurrentPane () | |
| DOCME. More... | |
| getter | help |
| A getter that will return a pane object's help message, or a default message indicating that no help is available. More... | |
| getter | paneType |
| A getter which will calculate the pane type based on the _object, or return the default "pane". More... | |
Detailed Description
Form renderer.
Renders a collection of fields into a pane. Transmits changes back to VFS, and responds diff updates.
- See also
- VFS_form
- paneFactory
Constructor & Destructor Documentation
◆ form()
| form | ( | layout | ) |
- Parameters
-
layout The layout definition, probably coming from a layout (.rui) file.
DOCME
Member Function Documentation
◆ applyDiff()
| applyDiff | ( | diff, | |
| user | |||
| ) |
Apply an incoming diff to the fields in this form.
- Parameters
-
diff The diff data user The user sending the diff
DOCME
- See also
- Diffs
◆ applySettings()
| applySettings | ( | settings | ) |
- Parameters
-
settings The json settings to apply, coming from the layout
DOCME
◆ applySubscription()
| applySubscription | ( | data, | |
| metadata | |||
| ) |
- Parameters
-
data metadata
- Returns
DOCME
◆ changeField()
| changeField | ( | variable, | |
| value, | |||
| widget | |||
| ) |
- Parameters
-
variable value widget
DOCME
◆ createHTML()
| createHTML | ( | ) |
Create the jquery content object, or return it if it exists.
- Returns
- the jquery content object
This will also call the base class pane::createHTML() method the first time it's called.
◆ destroy()
| destroy | ( | ) |
DOCME
◆ getField()
| getField | ( | field | ) |
Fetch a widget object by field name if it exists, or null if non-existent.
- Parameters
-
field
- Returns
- the field widget object if it exists, or null
◆ getValue()
| getValue | ( | field | ) |
Fetch the value of a field if it exists, or null if non-existent.
- Parameters
-
field
- Returns
- the value of a field if it exists, or null
◆ getValues()
| getValues | ( | ) |
- Returns
DOCME
◆ validate()
| validate | ( | ) |
- Returns
DOCME
The documentation for this class was generated from the following file:
