From: Thierry Parmentelat Date: Tue, 1 Oct 2013 07:30:04 +0000 (+0200) Subject: hazelnuts with checkboxes enabled can be sorted by that column - e.g. to see users... X-Git-Tag: myslice-0.2-5~67 X-Git-Url: http://git.onelab.eu/?p=myslice.git;a=commitdiff_plain;h=4ff1372de7efe594e67562ab6c28df4b9f1a3b39 hazelnuts with checkboxes enabled can be sorted by that column - e.g. to see users or resources in a slice show up first no need to specify aoColumns in datatables_options any lkonger (this even gets discarded anyway) --- diff --git a/plugins/hazelnut/__init__.py b/plugins/hazelnut/__init__.py index e8ecfce7..1fa99408 100644 --- a/plugins/hazelnut/__init__.py +++ b/plugins/hazelnut/__init__.py @@ -5,6 +5,8 @@ class Hazelnut (Plugin): # set checkboxes if a final column with checkboxes is desired # pass columns as the initial set of columns # if None then this is taken from the query's fields + # also please refrain from passing an 'aoColumns' as datatables_options + # as we use 'aoColumnDefs' instead def __init__ (self, query=None, query_all=None, checkboxes=False, columns=None, datatables_options={}, **settings): @@ -21,7 +23,7 @@ class Hazelnut (Plugin): elif self.query: self.columns = self.query.fields if query_all: - # We need a list because sets are not JSON-serilizable + # We need a list because sets are not JSON-serializable self.hidden_columns = list(self.query_all.fields - self.query.fields) else: self.hidden_columns = [] @@ -29,6 +31,19 @@ class Hazelnut (Plugin): self.columns = [] self.hidden_columns = [] self.datatables_options=datatables_options + # if checkboxes were required, we tell datatables about this column's type + # so that sorting can take place on a selected-first basis (or -last of course) + # this relies on the template exposing the checkboxes 'th' with class 'checkbox' + if self.checkboxes: + # we use aoColumnDefs rather than aoColumns -- ignore user-provided aoColumns + if 'aoColumns' in self.datatables_options: + print 'WARNING: hazelnut uses aoColumnDefs, your aoColumns spec. is discarded' + del self.datatables_options['aoColumns'] + # set aoColumnDefs in datatables_options - might already have stuff in there + aoColumnDefs = self.datatables_options.setdefault ('aoColumnDefs',[]) + # here 'checkbox' is the class that we give to the dom elem + # dom-checkbox is a sorting type that we define in hazelnut.js + aoColumnDefs.append ( {'aTargets': ['checkbox'], 'sSortDataType': 'dom-checkbox' } ) def template_file (self): return "hazelnut.html" @@ -41,17 +56,19 @@ class Hazelnut (Plugin): def requirements (self): reqs = { - 'js_files' : [ "js/hazelnut.js", - "js/manifold.js", "js/manifold-query.js", + 'js_files' : [ "js/spin.presets.js", "js/spin.min.js", "js/jquery.spin.js", "js/dataTables.js", "js/dataTables.bootstrap.js", "js/with-datatables.js", - "js/spin.presets.js", "js/spin.min.js", "js/jquery.spin.js", + "js/manifold.js", "js/manifold-query.js", "js/unfold-helper.js", + # hazelnut.js needs to be loaded after dataTables.js as it extends + # dataTableExt.afnSortData + "js/hazelnut.js", ] , - 'css_files': [ "css/hazelnut.css" , - "css/dataTables.bootstrap.css", + 'css_files': [ "css/dataTables.bootstrap.css", # hopefully temporary, when/if datatables supports sPaginationType=bootstrap3 # for now we use full_numbers\, with our own ad hoc css "css/dataTables.full_numbers.css", + "css/hazelnut.css" , ], } return reqs diff --git a/plugins/hazelnut/static/js/hazelnut.js b/plugins/hazelnut/static/js/hazelnut.js index 12ee398d..89275eee 100644 --- a/plugins/hazelnut/static/js/hazelnut.js +++ b/plugins/hazelnut/static/js/hazelnut.js @@ -98,7 +98,10 @@ // XXX use $.proxy here ! }; // the intention here is that options.datatables_options as coming from the python object take precedence - // XXX DISABLED by jordan: was causing errors in datatables.js $.extend(actual_options, options.datatables_options ); + // xxx DISABLED by jordan: was causing errors in datatables.js + // xxx turned back on by Thierry - this is the code that takes python-provided options into account + // check your datatables_options tag instead + $.extend(actual_options, this.options.datatables_options ); this.table = this.elmt('table').dataTable(actual_options); /* Setup the SelectAll button in the dataTable header */ @@ -504,4 +507,16 @@ $.plugin('Hazelnut', Hazelnut); + /* define the 'dom-checkbox' type for sorting in datatables + http://datatables.net/examples/plug-ins/dom_sort.html + using trial and error I found that the actual column number + was in fact given as a third argument, and not second + as the various online resources had it - go figure */ + $.fn.dataTableExt.afnSortData['dom-checkbox'] = function ( oSettings, _, iColumn ) { + return $.map( oSettings.oApi._fnGetTrNodes(oSettings), function (tr, i) { + return result=$('td:eq('+iColumn+') input', tr).prop('checked') ? '1' : '0'; + } ); + } + })(jQuery); + diff --git a/plugins/hazelnut/templates/hazelnut.html b/plugins/hazelnut/templates/hazelnut.html index b49161b6..a223d1b2 100644 --- a/plugins/hazelnut/templates/hazelnut.html +++ b/plugins/hazelnut/templates/hazelnut.html @@ -2,31 +2,19 @@ - {% for column in columns %} - - {% endfor %} - {% for column in hidden_columns %} - - {% endfor %} - {% if checkboxes %} - - {% endif %} - - + {% for column in columns %} {% endfor %} + {% for column in hidden_columns %} {% endfor %} + {% if checkboxes %} {% endif %} + + - {% for column in columns %} - - {% endfor %} - {% for column in hidden_columns %} - - {% endfor %} - {% if checkboxes %} - - {% endif %} - + {% for column in columns %} {% endfor %} + {% for column in hidden_columns %} {% endfor %} + {% if checkboxes %} {% endif %} +
{{ column }}{{ column }}+/-
{{ column }}{{ column }}+/-
{{ column }}{{ column }}+/-
{{ column }}{{ column }}+/-
diff --git a/portal/platformview.py b/portal/platformview.py index 16148ee2..76699cf0 100644 --- a/portal/platformview.py +++ b/portal/platformview.py @@ -35,9 +35,6 @@ class PlatformView(TemplateView): query_all = network_query, checkboxes = False, datatables_options = { - # for now we turn off sorting on the checkboxes columns this way - # this of course should be automatic in hazelnut - 'aoColumns' : [None, None, None, None, {'bSortable': False}], 'iDisplayLength' : 25, 'bLengthChange' : True, }, diff --git a/portal/sliceview.py b/portal/sliceview.py index 175a40e6..0732d980 100644 --- a/portal/sliceview.py +++ b/portal/sliceview.py @@ -133,9 +133,6 @@ class SliceView (LoginRequiredAutoLogoutView): query_all = query_resource_all, checkboxes = True, datatables_options = { - # for now we turn off sorting on the checkboxes columns this way - # this of course should be automatic in hazelnut - 'aoColumns' : [None, None, None, None, {'bSortable': False}], 'iDisplayLength': 25, 'bLengthChange' : True, 'bAutoWidth' : True,