Class: CheckboxModal

new CheckboxModal({
    i18n: i18n,
    vent: vent,
    parameters: {
        modalHeader: 'modalHeader'
    },
    tables: [{
        initialState: true,
        tableHeader: 'tableTitle',
        rows: [
            'one',
            'two',
            'three'
        ]
    }]
});

Extends

• Backbone.View

Methods

clearAllCheckboxes()

clear all checkboxes in all tables

Source:

• checkbox-modal.js, line 201

<protected> clearAllRows()

Clear the internal state of all rows for all tables

Source:

• checkbox-modal.js, line 162

getElementValue(selector) → {*}

Get the value of an input. Don't use this to get the value of checkboxes or you will have a bad time

Parameters:

Name	Type	Description
selector	string	A css selector for locating the input

Source:

• checkbox-modal.js, line 348

Returns:

The value of the input

Type

*

<protected> getModalTemplateParams() → {CheckboxModalTemplateParameters}

Gets the parameters which are passed to templateModal. The tables configs are passed to each table.

Source:

• checkbox-modal.js, line 315

Returns:

template parameters augemented with the additional parameters
passed to initialize

Type

CheckboxModalTemplateParameters

getSelectedRows() → {Array.<string>}

Get the selected rows for each table. Updates the internal state of the tables

Source:

• checkbox-modal.js, line 259

Returns:

The names of the selected rows

Type

Array.<string>

<protected> handleCheckBoxChange(e)

Handler called when a checkbox is clicked. This will set the state of the corresponding global checkbox
accordingly

Parameters:

Name	Type	Description
e	object	jQuery event object

Source:

• checkbox-modal.js, line 419

hideModal()

Hides the modal

Source:

• checkbox-modal.js, line 374

<protected> onOkClick()

Called when the OK button is pressed. This will call okCallback and close the modal

Source:

• checkbox-modal.js, line 470

remove()

removes the modal

Source:

• checkbox-modal.js, line 484

render()

renders the modal and adds the event handlers

Source:

• checkbox-modal.js, line 398

Returns:

this

<protected> resizeModal()

Called when the vent fires a vent:resize event. Sets the max-height of the modal body to 80% of the window
height, less the height of the modal-header and modal-footer, clamped to [1, 400].

Source:

• checkbox-modal.js, line 104

<protected> restorePrevState()

Restores the previous state of the modal

Source:

• checkbox-modal.js, line 382

setCheckbox(index, rowName, value)

Set the checked property of the named checkbox in the given table

Parameters:

Name	Type	Description
index	number	The index of the table
rowName	string	The name of the row
value	boolean	The new value of the checkbox

Source:

• checkbox-modal.js, line 185

setCheckboxes(index, value)

Set the checked property of all checkboxes in the given table

Parameters:

Name	Type	Description
index	number	The index of the table
value	boolean	The new value of the checkbox

Source:

• checkbox-modal.js, line 194

setCheckboxesAndRows(index, valueCheckbox, valueGlobalCheckbox)

Sets the internal state and the checkboxes for a given table

Parameters:

Name	Type	Description
index	number	The index of the table
valueCheckbox	boolean	The new value of the checkbox
valueGlobalCheckbox	boolean	The new indeterminate state of the global checkbox

Source:

• checkbox-modal.js, line 221

setElementValue(selector, value)

Get the value of an input. Don't use this to get the value of checkboxes or you will have a bad time

Parameters:

Name	Type	Description
selector	string	A css selector for locating the input
value	*	The new value of the input

Source:

• checkbox-modal.js, line 357

setGlobalCheckboxes()

sets the value of the global checkbox in each table in accordance with the values of the checkboxes in
the table

Source:

• checkbox-modal.js, line 233

setIndeterminateCheckbox(index, value)

Sets the value of the indeterminate property of the checkbox with the given index

Parameters:

Name	Type	Description
index	number	The index of the checkbox
value	boolean	The value of the indeterminate property

Source:

• checkbox-modal.js, line 211

setNthCheckbox(index, n, value)

Set the checked property of the nth input in the given table

Parameters:

Name	Type	Description
index	number	The index of the table
n	number	The index of the checkbox in the table. This includes the global checkbox and other inputs.
value	boolean	The new value of the checkbox

Deprecated:

• Prefer setCheckbox

Source:

• checkbox-modal.js, line 175

<protected> setRow(index, name, value)

Sets the internal state of a row

Parameters:

Name	Type	Description
index	number	The index of the table
name	string	The name of the row
value	boolean	The new value of the checkbox

Source:

• checkbox-modal.js, line 142

<protected> setRows(index, value)

Sets the internal state of all rows for the given table

Parameters:

Name	Type	Description
index	number	The index of the table
value	boolean	The new value of the checkbox

Source:

• checkbox-modal.js, line 152

<protected> setTableInitialState()

Initialises the internal state of the tables from the configuration

Source:

• checkbox-modal.js, line 117

showModal()

Shows the modal

Source:

• checkbox-modal.js, line 364