API Docs for: 1.0.0
Show:

CheckboxGroup Class

Defined in: src/gallery-checkboxgroups/js/CheckboxGroup.js:10
Module: gallery-checkboxgroups

Base class for enforcing constraints on groups of checkboxes.

Derived classes must override enforceConstraints().

Constructor

CheckboxGroup

(
  • cb_list
)

Defined in src/gallery-checkboxgroups/js/CheckboxGroup.js:10

Parameters:

  • cb_list String | Node | NodeList

    The list of checkboxes to manage

Methods

allChecked

() Boolean

Defined in src/gallery-checkboxgroups/js/CheckboxGroup.js:134

Returns:

Boolean:

true if all checkboxes are checked

allDisabled

() Boolean

Defined in src/gallery-checkboxgroups/js/CheckboxGroup.js:171

Returns:

Boolean:

true if all checkboxes are disabled

allUnchecked

() Boolean

Defined in src/gallery-checkboxgroups/js/CheckboxGroup.js:153

Returns:

Boolean:

true if all checkboxes are unchecked

checkboxChanged

(
  • cb
)

Defined in src/gallery-checkboxgroups/js/CheckboxGroup.js:94

Call this if you modify the checkbox programmatically, since that will not fire a click event.

Parameters:

  • cb Node | String

    checkbox that was modified

enforceConstraints

(
  • cb_list
  • index
)

Defined in src/gallery-checkboxgroups/js/CheckboxGroup.js:121

Derived classes must override this function to implement the desired behavior.

Parameters:

  • cb_list String | Object | Array

    The list of checkboxes

  • index Int

    The index of the checkbox that changed

getCheckboxList

() NodeList

Defined in src/gallery-checkboxgroups/js/CheckboxGroup.js:39

Returns:

NodeList:

List of managed checkboxes

splice

(
  • start
  • delete_count
  • cb_list
)

Defined in src/gallery-checkboxgroups/js/CheckboxGroup.js:48

Same functionality as Array.splice(). Operates on the list of managed checkboxes.

Parameters:

  • start Int

    Insertion index

  • delete_count Int

    Number of items to remove, starting from start

  • cb_list String | Node | NodeList

    The list of checkboxes to insert at start