Class Form

Object
   |
   +--Form

class Form

Defined in form.js

ajaxify

void ajaxify(<Object> form, ajax)

Setup a given form to be submitted using AJAX. The second argument must be a function that returns a valid instance of an AJAX request class.

Parameters:
form - Form reference or id
Function - that builds the AJAX handler

clear

void clear(<Object> form, <Array> prsv)

Clears the value of all form fields

Parameters:
form - Form instance or id
prsv - Field names to be preserved

disable

void disable(<Object> form)

Disable one or more fields in a given form. This method excepts field names starting from the second parameter

Parameters:
form - Form reference or id

disableAll

void disableAll(<Object> form, <Array> prsv)

Disable all fields in a form

Parameters:
form - Form instance or id
prsv - Field names to be preserved

enable

void enable(<Object> form)

Enable one or more fields in a given form. This method excepts field names starting from the second parameter

Parameters:
form - Form instance or id

enableAll

void enableAll(<Object> form, <Array> prsv)

Enable all fields in a form

Parameters:
form - Form instance or id
prsv - Field names to be skipped

focusFirstField

void focusFirstField(<Object> form)

Move focus to the first enable field of a form

Parameters:
form - Form reference or id

get

Object get(<String> formName)

Retrieve a form object from its name

Parameters:
formName - Form name

getElements

Array getElements(<Object> form)

Returns the array of elements of this form, indexed by name

Parameters:
form - Form instance or id

getField

Object getField(<Object> form, <String> name)

Returns a single field of a form by name. The value returned is an instance of one of the Field classes, depending on the type and nature of the field. Instances for form fields are created only once

Parameters:
form - Form instance or id
name - Field name

getFields

Hash getFields(<Object> form)

Returns a hash table of fields of a form, indexed by name. Here, buttons and auxiliary inputs used by form components are not listed. Only the top elements declared in the XML specification might be returned

Parameters:
form - Form instance or id

reset

void reset(form)

Reset all the fields in the form to their default values

Parameters:
Form - instance or id

serialize

Object serialize(<Object> form, fld)

Serialize all the field's contents. The result is a string separated by & that can be used in query strings and HTTP requests

Parameters:
form - Form reference or id
flds - Optional list of fields to be serialized

updateCheckboxes

void updateCheckboxes(<Object> form)

Update value and enable state of hidden fields associated with checkboxes before submission

Parameters:
form - Form reference or id