API Docs for: 1.0.0
Show:

SelectAllCheckboxGroup Class

Extends CheckboxGroup
Defined in: src/gallery-checkboxgroups/js/SelectAllCheckboxGroup.js:5
Module: gallery-checkboxgroups

All checkboxes can be selected and a select-all checkbox is available to check all. This check-all box is automatically changed if any other checkbox changes state.

Constructor

SelectAllCheckboxGroup

(
  • select_all_cb
  • cb_list
)

Defined in src/gallery-checkboxgroups/js/SelectAllCheckboxGroup.js:5

Parameters:

  • select_all_cb String | Object

    The checkbox that triggers "select all"

  • cb_list String | Node | NodeList

    The list of checkboxes to manage

Methods

allChecked

() Boolean

Inherited from CheckboxGroup: src/gallery-checkboxgroups/js/CheckboxGroup.js:134

Returns:

Boolean: true if all checkboxes are checked

allDisabled

() Boolean

Inherited from CheckboxGroup: src/gallery-checkboxgroups/js/CheckboxGroup.js:171

Returns:

Boolean: true if all checkboxes are disabled

allUnchecked

() Boolean

Inherited from CheckboxGroup: src/gallery-checkboxgroups/js/CheckboxGroup.js:153

Returns:

Boolean: true if all checkboxes are unchecked

checkboxChanged

(
  • cb
)

Inherited from CheckboxGroup: 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
)

Inherited from CheckboxGroup but overwritten in src/gallery-checkboxgroups/js/SelectAllCheckboxGroup.js:63

Parameters:

  • cb_list String | Object | Array

    The list of checkboxes

  • index Int

    The index of the checkbox that changed

getCheckboxList

() NodeList

Inherited from CheckboxGroup: src/gallery-checkboxgroups/js/CheckboxGroup.js:39

Returns:

NodeList: List of managed checkboxes

getSelectAllCheckbox

() Node

Defined in src/gallery-checkboxgroups/js/SelectAllCheckboxGroup.js:43

Returns:

Node: checkbox that controls "select all"

splice

(
  • start
  • delete_count
  • cb_list
)

Inherited from CheckboxGroup: 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

toggleSelectAll

()

Defined in src/gallery-checkboxgroups/js/SelectAllCheckboxGroup.js:52

Toggle the setting of the "select all" checkbox.