Source code for django_tables2.columns.checkboxcolumn

# coding: utf-8
from __future__ import absolute_import, unicode_literals

from django.utils.safestring import mark_safe

from django_tables2.utils import Accessor, AttributeDict

from .base import Column, library


@library.register
[docs]class CheckBoxColumn(Column): """ A subclass of `.Column` that renders as a checkbox form input. This column allows a user to *select* a set of rows. The selection information can then be used to apply some operation (e.g. "delete") onto the set of objects that correspond to the selected rows. The value that is extracted from the :term:`table data` for this column is used as the value for the checkbox, i.e. ``<input type="checkbox" value="..." />`` This class implements some sensible defaults: - HTML input's ``name`` attribute is the :term:`column name` (can override via *attrs* argument). - *orderable* defaults to `False`. .. note:: You'd expect that you could select multiple checkboxes in the rendered table and then *do something* with that. This functionality isn't implemented. If you want something to actually happen, you'll need to implement that yourself. In addition to *attrs* keys supported by `.Column`, the following are available: - *input* -- ``<input>`` elements in both ``<td>`` and ``<th>``. - *th__input* -- Replaces *input* attrs in header cells. - *td__input* -- Replaces *input* attrs in body cells. To render the checkbox as checked, use the *checked* argument with a accessor, boolean or callable returning boolean. If it resolves to a truthy value, the checkbox will be rendered as checked. """ def __init__(self, attrs=None, checked=None, **extra): self.checked = checked kwargs = {'orderable': False, 'attrs': attrs} kwargs.update(extra) super(CheckBoxColumn, self).__init__(**kwargs) @property def header(self): default = {'type': 'checkbox'} general = self.attrs.get('input') specific = self.attrs.get('th__input') attrs = AttributeDict(default, **(specific or general or {})) return mark_safe('<input %s/>' % attrs.as_html()) def render(self, value, bound_column, record): default = { 'type': 'checkbox', 'name': bound_column.name, 'value': value } if self.is_checked(value, record): default.update({ 'checked': 'checked', }) general = self.attrs.get('input') specific = self.attrs.get('td__input') attrs = AttributeDict(default, **(specific or general or {})) return mark_safe('<input %s/>' % attrs.as_html())
[docs] def is_checked(self, value, record): """ Determine if the checkbox should be checked """ if self.checked is None: return False if self.checked is True: return True if callable(self.checked): return bool(self.checked(value, record)) checked = Accessor(self.checked) if checked in record: return bool(record[checked]) return False