_FormMixin

(esrith/amos/core/_FormMixin)

Basic form class for most AMOS form classes. This class inherits _FormConstruct class.

Sample
Type Description
active Boolean If true, this forces the control to enter the active state and classname 'amos-form-active' will be added.
busy Boolean If true, this forces the control to enter the busy state and classname 'amos-form-busy' will be added.
disabled Boolean If true, any control's events(except change) are not responding. Its content cannot be edited and is excluded when the form is submitted.
error Boolean If true, this forces the control to enter the error state and classname 'amos-form-error' will be added.
filled Boolean

A flag that shows whether a form element is filled in (true) or empty (false).
label String

Label of an element.
name String

Name of control. When sending a request to server, this property is the parameter's name.
readOnly Boolean If true, the control is read-only and cannot be edited. However, its content, if presents, is included in form submission.
valid Boolean

Validity flag that shows whether a form element is validated to be valid (true) or invalid (false).
value String | Number | Object

Value of the element.
viewMode Boolean If true, the control will show only the displayedValue.
Return type Description
hide(elem?) None

Hide a specified element. The hidden element will not be displayed at all.
isValid() Boolean

Returns true when value validation succeeded; otherwise, false.
isVisible(elem?) Boolean

Return true if the element is visible, otherwise false.
reset() None

Reset all state and value to default.
show(elem?) None

Display a specified element.
toggle(elem?) None

Toggle visibility of a specified element.
Properties Detail
<Boolean>
active

Inherited from: esrith/amos/core/_StateMixin.js:118

If true, this forces the control to enter the active state and classname 'amos-form-active' will be added.

Default value: false

<Boolean>
busy

Inherited from: esrith/amos/core/_StateMixin.js:156

If true, this forces the control to enter the busy state and classname 'amos-form-busy' will be added.

Default value: false

<Boolean>
disabled

Inherited from: esrith/amos/core/_StateMixin.js:42

If true, any control's events(except change) are not responding. Its content cannot be edited and is excluded when the form is submitted.

Default value: false

<Boolean>
error

Inherited from: esrith/amos/core/_StateMixin.js:138

If true, this forces the control to enter the error state and classname 'amos-form-error' will be added.

Default value: false

<Boolean>
filled

Defined in esrith/amos/core/_FormMixin.js:56

A flag that shows whether a form element is filled in (true) or empty (false).

Default value: false

<String>
label

Defined in esrith/amos/core/_FormMixin.js:75

Label of an element.

<String>
name

Inherited from: esrith/amos/core/_FormConstruct.js:54

Name of control. When sending a request to server, this property is the parameter's name.

<Boolean>
readOnly

Inherited from: esrith/amos/core/_StateMixin.js:66

If true, the control is read-only and cannot be edited. However, its content, if presents, is included in form submission.

Default value: false

<Boolean>
valid

Inherited from: esrith/amos/core/_FormConstruct.js:33

Validity flag that shows whether a form element is validated to be valid (true) or invalid (false).

Default value: true

<String | Number | Object>
value

Inherited from: esrith/amos/core/_FormConstruct.js:63

Value of the element.

<Boolean>
viewMode

Inherited from: esrith/amos/core/_StateMixin.js:88

If true, the control will show only the displayedValue.

Default value: false

Methods Detail
hide
(
  • elem?
)

Inherited from: esrith/amos/core/_DisplayMixin.js:82

Hide a specified element. The hidden element will not be displayed at all.

Parameters
  • <Node> elem Optional

    Specified element to be hidden.
<Boolean>
isValid
()

Inherited from: esrith/amos/core/_FormConstruct.js:42

Returns true when value validation succeeded; otherwise, false.

<Boolean>
isVisible
(
  • elem?
)

Inherited from: esrith/amos/core/_DisplayMixin.js:40

Return true if the element is visible, otherwise false.

Parameters
  • <Node> elem Optional

    Specified element to be checked. If not specified, domNode of the widget is used instead.
reset
()

Inherited from: esrith/amos/core/_FormConstruct.js:72

Reset all state and value to default.

show
(
  • elem?
)

Inherited from: esrith/amos/core/_DisplayMixin.js:69

Display a specified element.

Parameters
  • <Node> elem Optional

    Specified element to be displayed.
toggle
(
  • elem?
)

Inherited from: esrith/amos/core/_DisplayMixin.js:56

Toggle visibility of a specified element.

Parameters
  • <Node> elem Optional

    Specified element to toggle visibility.