Class GroupField

Object
   |
   +--GroupField

class GroupField

Defined in form.js

Field Detail

grp

Array grp

Members of the group

label

String label

Label of the group

multiple

Boolean multiple

The group accepts multiple choice or not

name

String name

Name of the group

self

<private> Object self

type

String type

Type of the group members

GroupField

GroupField(<Object> grp)

The GroupField class encapsulate operations over grouped elements, which are sets of form inputs with the same name, accepting single choice (radio button groups) or multiple choice (checkbox groups)

Parameters:
grp - Group of fields

clear

void clear()

Unselect the selected option(s) in the group

focus

void focus()

Move the focus to the first enabled member of the group

getFormElement

Array getFormElement()

Return the array of group members

getValue

Object getValue()

Return the current value of the group. For multiple choice groups, the value returned is an array

invert

Number invert()

Invert group members state. Returns the number of checked inputs after the inversion

isEmpty

Boolean isEmpty()

Verifies if the group has a selected value (or values)

serialize

String serialize()

Serialize the name of the group and the selected value(s). The returning value could be used to build query strings or HTTP requests

setAll

void setAll(<Boolean> b)

Change all group members to a given state

Parameters:
b - State

setDisabled

void setDisabled(b)

Enables/disables all elements in the group

setValue

void setValue(<Object> val)

Changes the selected option(s) of the group. For multiple choice groups, the expected parameter is an array of values

Parameters:
val - New value