Show:

A base class for A.FormBuilderCheckBoxField.

Constructor

A.FormBuilderCheckBoxField

(
  • config
)

Parameters:

  • config Object

    Object literal specifying widget configuration properties.

Methods

_booleanFormatter

(
  • o
)
protected

Transforms a Boolean value into "yes" or "no" string.

Parameters:

  • o Object

_getFieldNode

() protected

Returns the node for the current field.

_getToolbarItems

() Array

Gets a list of toolbar items.

Returns:

Array:

_handleDeleteEvent

(
  • event
)
protected

Popups a dialog to confirm deletion. If "yes", destroys the instance.

Parameters:

  • event Object

_handleDuplicateEvent

(
  • event
)
protected

Checks if the field isn't unique. If not, duplicates the instance.

Parameters:

  • event Object

_handleEditEvent

(
  • event
)
protected

Handles the edit event.

Parameters:

  • event Object

_setId

(
  • val
)
protected

Set the id attribute on the UI.

Parameters:

  • val Object

_uiSetAcceptChildren

(
  • val
)
protected

Set the acceptChildren attribute on the UI.

Parameters:

  • val Object

_uiSetDisabled

(
  • val
)
protected

Set the disabled attribute on the UI.

Parameters:

  • val Object

_uiSetFields

(
  • val
)
protected

Set the fields on the UI using the plotFields method from A.FormBuilder.

Parameters:

  • val Object

_uiSetLabel

(
  • val
)
protected

Set the label attribute on the UI.

Parameters:

  • val Object

_uiSetName

(
  • val
)
protected

Set the name attribute on the UI.

Parameters:

  • val Object

_uiSetPredefinedValue

(
  • val
)
protected

Set the predefinedValue attribute on the UI.

Parameters:

  • val Object

_uiSetRequired

(
  • val
)
protected

Set the required attribute on the UI.

Parameters:

  • val Object

_uiSetSelected

(
  • val
)
protected

Set the selected attribute on the UI.

Parameters:

  • val Object

_uiSetShowLabel

(
  • val
)
protected

Set the showLabel attribute on the UI.

Parameters:

  • val Object

_uiSetTip

(
  • val
)
protected

Set the tip attribute on the UI.

Parameters:

  • val Object

_uiSetUnique

(
  • val
)
protected

Set the unique attribute on the UI.

Parameters:

  • val Object

buildFieldId

(
  • id
)
String private

Creates the field id.

Parameters:

  • id Object

Returns:

String:

buildFieldName

(
  • type
)
String private

Creates the field name.

Parameters:

  • type Object

Returns:

String:

createField

(
  • val
)
Object

Creates the field using the createField method from A.FormBuilder.

Parameters:

  • val Object

Returns:

Object:

destructor

() protected

Destructor lifecycle implementation for the A.FormBuilderField class.

getAttributesForCloning

() Object

Gets all necessary attributes for cloning this field.

Returns:

Object:

getHTML

() String

Injects data into the template and returns the HTML result.

Returns:

String:

getNode

() Node

Creates a Node from the HTML string.

Returns:

Node:

getProperties

() Array

Gets properties from the property model.

Returns:

Array:

getPropertyModel

()

Returns a list of property models including the A.RadioCellEditor model.

initializer

() protected

Construction logic executed during A.FormBuilderField instantiation. Lifecycle.

renderUI

() protected

Render the A.FormBuilderCheckBoxField component instance. Lifecycle.

Properties

ATTRS

Object static

Static property used to define the default attribute configuration for the A.FormBuilderCheckBoxField.

CSS_PREFIX

String static

Static property provides a string to identify the CSS prefix.

EXTENDS

Object static

Static property used to define which component it extends.

NAME

String static

Static property provides a string to identify the class.

Attributes

acceptChildren

Boolean

If true children are accepted.

Default: true

builder

The A.FormBuilder instance.

Default: null

controlsToolbar

Object

Collection of toolbar controls.

dataType

String

Indicates which is the type of data for the input field.

Default: 'boolean'

disabled

Boolean

Checks if the input field is disabled or not.

Default: false

dropZoneNode

Node used to generate the drop zone.

hiddenAttributes

Array

List of hidden attributes.

Default: []

label

String

The label of the input field.

Default: ''

localizationMap

Object

Collection for content localization.

Default: {}

parent

Container for the field parent.

Default: null

predefinedValue

Boolean

Specifies a predefined value for the checkbox field.

Default: false

readOnly

Boolean

Checks if an input field is read-only. In other words, it cannot be modified.

Default: false

readOnlyAttributes

Array

List of read-only input fields.

Default: []

required

Boolean

Checks if an input field is required. In other words, it needs content to be valid.

Default: false

requiredFlagNode

Node used to generate the required flag.

selected

Boolean

Checks if the input field is selected or not.

Default: false

showLabel

Boolean

If true the label is showed.

Default: true

strings

Object

Collection of strings used to label elements of the UI.

template

Reusable block of markup used to generate the field.

tip

String

Hint to help the user to fill the input field.

Default: ''

type

String

Defines the type of field.

Default: ''

unique

Boolean

Checks if the input field is unique or not.

Default: false

zIndex

Number

Stack order of the field. An element with greater stack order is always in front of an element with a lower stack order.

Default: 100