← Back to the web2py-plugin list
Table Checkbox
The plugin provides a form object which is an extra table column composed of checkboxes to select multiple records, and submits selected record ids.
Demo
| table | : |
| ||||||||||||||||||
| tablecheckbox | : |
Usage
-
controllers/plugin_tablecheckbox.py
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.from plugin_tablecheckbox import TableCheckbox
from plugin_solidtable import SOLIDTABLE
from gluon.contrib.populate import populate
db = DAL('sqlite:memory:')
db.define_table('product', Field('name'))
populate(db.product, 5)
def index():
################################ The core ######################################
tablecheckbox = TableCheckbox()
# Insert an extra element to select an action
tablecheckbox.components.insert(0,
SELECT('update', 'delete', _name='action', _style='width:70px;',
requires=IS_IN_SET(['update', 'delete'])))
if tablecheckbox.accepts(request.vars):
# Selected record ids will be submitted
session.flash = 'submitted %s' % tablecheckbox.vars
redirect(URL('index'))
extracolumns = [tablecheckbox.column()]
################################################################################
table = SOLIDTABLE(db(db.product.id>0).select(),
extracolumns=extracolumns, renderstyle=True)
return dict(table=table, tablecheckbox=tablecheckbox)
Source code
-
modules/plugin_tablecheckbox.py
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.from gluon import *
class TableCheckbox(FORM):
def __init__(self, id_getter=lambda row: row.id,
tablecheckbox_var='tablecheckbox',
confirm_message='"Are you sure you want to submit?"',
submit_button='Submit checks',
**attributes):
FORM.__init__(self, **attributes)
self.id_getter = id_getter
self.attributes['_class'] = 'tablecheckbox'
self.tablecheckbox_var, self.confirm_message, self.submit_button = (
tablecheckbox_var, confirm_message, submit_button
)
self._checkall = '%s_checkall' % self.tablecheckbox_var
self._selected = '%s_selected' % self.tablecheckbox_var
self._button = '%s_button' % self.tablecheckbox_var
self.append(SCRIPT("""
jQuery(document).ready(function(){
var selected_el = jQuery("input[name=%(selected)s]");
function set_activation(){setTimeout(function(){
var button_el = jQuery('#%(button)s');
selected_el.each(function(){
if(jQuery(this).is(':checked')) { button_el.prop({disabled: false}); return false;
} else { button_el.prop({disabled: true}); }}); }, 10); }
selected_el.change(set_activation);
jQuery("input[name=%(checkall)s]").change(set_activation);
});""" % dict(checkall=self._checkall, selected=self._selected, button=self._button)))
self.append(INPUT(_type='hidden', _name=self.tablecheckbox_var))
self.append(INPUT(_type='submit', _value=self.submit_button,
_onclick=self._get_submit_js(),
_id=self._button, _disabled='disabled'))
def column(self):
return {'label': DIV(INPUT(_type='checkbox', _name=self._checkall,
_onclick=self._get_toggle_all_js()),
_style='text-align:center;'),
'content': lambda row, rc: DIV(INPUT(_type='checkbox', _name=self._selected,
_value=self.id_getter(row), _style='margin:3px;'),
_style='text-align:center;'),
'width': '', 'class': '', 'selected': False}
def accepts(self, *args, **kwds):
accepted = FORM.accepts(self, *args, **kwds)
if accepted:
self.vars[self.tablecheckbox_var] = current.request.vars[self.tablecheckbox_var].split(',')
return accepted
def xml(self):
return FORM.xml(self)
def _get_toggle_all_js(self):
return """
jQuery('input[name=%(selected)s]').prop('checked', jQuery('input[name=%(checkall)s]').is(':checked'));
""" % dict(checkall=self._checkall, selected=self._selected)
def _get_submit_js(self):
return """
if(%(confirm)s){
var val = [];
jQuery("input[name=%(selected)s]").each(function(){
var el = jQuery(this);
if(el.is(':checked')) { val.push(el.val()); }
});
jQuery("input[name=%(tablecheckbox)s]").val(val);
return true;
;}; return false;""" % dict(confirm='confirm(%s)' % self.confirm_message if self.confirm_message else 'true',
selected=self._selected,
tablecheckbox=self.tablecheckbox_var)
Static files
There are no static files