_ButtonBase

(esrith/amos/core/_ButtonBase)

Basic class for button controls.

Type Description
active Boolean

If true, force 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.
enabledToggle Boolean

If true, the button works as a toggle button. Toggle button is a button that enters active state after it is clicked and remains in active state until it is clicked again to return to normal state.

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).
id String

An unique id for an element. (The specified value must be unique within the document.)

label String Label of an element.
name String

Name of button. 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
activate() None

Force the button to enter the activate state.

deactivate() None

Force the button to enter the normal state.

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.
Description
blur

Fires when an object loses focus.

click

Fires when the user clicks on a button.

dblclick

Fires when the user double-clicks on a button.

focus

Fires when an element gets focus.

keydown

Fires when the user is pressing a key (on the keyboard).

keypress

Fires when the user presses a key (on the keyboard).

keyup

Fires when the user releases a key (on the keyboard).

mousedown

Fires when a user presses a mouse button over an element.

mouseout

Fires when the mouse pointer is moved out of an element.

mouseover

Fires when the mouse pointer is moved onto an element.

mouseup

Fires when a user releases a mouse button over an element.

Properties Detail
<Boolean>
active

Inherited from _StateMixin but overwritten in esrith/amos/core/_ButtonBase.js:62

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

Default value: false

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

Default value: false

<Boolean>
disabled
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>
enabledToggle

If true, the button works as a toggle button. Toggle button is a button that enters active state after it is clicked and remains in active state until it is clicked again to return to normal state.

Default value: false

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

Default value: false

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

Default value: false

<String>
id

An unique id for an element. (The specified value must be unique within the document.)

<String>
label
Label of an element.
<String>
name

Inherited from _FormConstruct but overwritten in esrith/amos/core/_ButtonBase.js:126

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

<Boolean>
readOnly
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
Validity flag that shows whether a form element is validated to be valid (true) or invalid (false).

Default value: true

<String | Number | Object>
value
Value of the element.
<Boolean>
viewMode
If true, the control will show only the displayedValue.

Default value: false

Methods Detail
activate
()

Force the button to enter the activate state.

deactivate
()

Force the button to enter the normal state.

hide
(
  • elem?
)
Hide a specified element. The hidden element will not be displayed at all.
Parameters
  • <Node> elem Optional
    Specified element to be hidden.
<Boolean>
isValid
()
Returns true when value validation succeeded; otherwise, false.
<Boolean>
isVisible
(
  • elem?
)
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
()
Reset all state and value to default.
show
(
  • elem?
)
Display a specified element.
Parameters
  • <Node> elem Optional
    Specified element to be displayed.
toggle
(
  • elem?
)
Toggle visibility of a specified element.
Parameters
  • <Node> elem Optional
    Specified element to toggle visibility.
Events Detail
blur

Fires when an object loses focus.

Event Payload:
  • <Object> evt

    -javascript event object

click

Fires when the user clicks on a button.

Event Payload:
  • <Object> evt

    -javascript event object

dblclick

Fires when the user double-clicks on a button.

Event Payload:
  • <Object> evt

    -javascript event object

focus

Fires when an element gets focus.

Event Payload:
  • <Object> evt

    -javascript event object

keydown

Fires when the user is pressing a key (on the keyboard).

Event Payload:
  • <Object> evt

    -javascript event object

keypress

Fires when the user presses a key (on the keyboard).

Event Payload:
  • <Object> evt

    -javascript event object

keyup

Fires when the user releases a key (on the keyboard).

Event Payload:
  • <Object> evt

    -javascript event object

mousedown

Fires when a user presses a mouse button over an element.

Event Payload:
  • <Object> evt

    -javascript event object

mouseout

Fires when the mouse pointer is moved out of an element.

Event Payload:
  • <Object> evt

    -javascript event object

mouseover

Fires when the mouse pointer is moved onto an element.

Event Payload:
  • <Object> evt

    -javascript event object

mouseup

Fires when a user releases a mouse button over an element.

Event Payload:
  • <Object> evt

    -javascript event object