Class: Form

Methods

---

ajaxSubmit()

Fires the submit in the background and hands back the jQuery promise.

An optional config can be passed in to control the underlying jQuery ajax XHR.

Source:

• Form.js, line 573

Returns:

Type

*

---

clear(stopUpdateTrigger)

Clears the form and resets values of its fields.

Parameters:

Name	Type	Description
stopUpdateTrigger		If false, triggers the update event of this event.

Source:

• Form.js, line 519

---

destroy(Boolean)

Purge any event listeners and remove the form from the DOM.

Parameters:

Name	Type	Argument	Description
Boolean		<optional>	skipParent when true, the form cleans up without traversing through parent child controls

Source:

• Form.js, line 482

---

disable()

Disables this form.

Source:

• Form.js, line 449

---

enable()

Enables this form.

Source:

• Form.js, line 457

---

fireCallback(id, arg1, arg2, arg3, arg4, arg5)

Fires a view callback for the current form.

Parameters:

Name	Type	Description
id
arg1
arg2
arg3
arg4
arg5

Source:

• Form.js, line 544

---

focus()

Focuses on this form.

If a callback is provided, the callback receives the focused control.

Source:

• Form.js, line 467

---

getFormEl()

Retrieves the form element.

Source:

• Form.js, line 554

Returns:

The rendered DOM element.

Type

Object

---

getId()

Returns the id of the form.

Source:

• Form.js, line 307

Returns:

Form id

Type

String

---

getParent()

Returns this form's parent.

Source:

• Form.js, line 327

Returns:

Form parent.

Type

Object

---

getType()

Returns form type.

Source:

• Form.js, line 317

Returns:

Form type.

Type

String

---

getValue()

Returns the value of the JSON rendered by this form.

Source:

• Form.js, line 337

Returns:

Value of the JSON rendered by this form.

Type

Any

---

hide()

Hides the form.

Source:

• Form.js, line 507

---

initEvents()

Initializes events handling (Form Submission) for this form.

Source:

• Form.js, line 355

---

isEmpty()

Checks if form is empty.

Source:

• Form.js, line 529

Returns:

True if the form is empty, false otherwise.

Type

Boolean

---

isFormValid()

Determines whether the top control is entirely valid.

Source:

• Form.js, line 174

Returns:

Type

*

---

onSubmit(e, form)

Handles form submit events.

Parameters:

Name	Type	Description
e	Object	Submit event.
form	Object	the form

Source:

• Form.js, line 397

---

processRender(parentEl, callback)

Responsible for fetching any templates needed so as to render the
current mode for this field.

Once completed, the onSuccess method is called.

Parameters:

Name	Type	Description
parentEl	Object	Field container.
callback	function

Source:

• Form.js, line 234

---

refreshValidationState(children)

Displays validation information of all fields of this form.

Parameters:

Name	Type	Description
children	Boolean	whether to render validation state for child fields

Source:

• Form.js, line 441

Returns:

Form validation state.

Type

Object

---

registerSubmitHandler(func)

Registers a custom submit handler.

Parameters:

Name	Type	Description
func	Object	Submit handler to be registered.

Source:

• Form.js, line 426

---

render(callback)

Renders this form into the container.

Parameters:

Name	Type	Description
callback	function

Source:

• Form.js, line 135

---

setValue(value)

Sets the value of the JSON to be rendered by this form.

Parameters:

Name	Type	Description
value	Any	Value to be set.

Source:

• Form.js, line 347

---

show()

Shows the form.

Source:

• Form.js, line 497

---

submit()

Performs a regular old submit.

Source:

• Form.js, line 561