added toolbar_message(): same as footer_message(), but appends message to toolbar

Author: morlandi

CHANGELOG.rst

@@ -6,6 +6,7 @@ History
 v4.4.3
 ------
 * assign '__iexact', instead of '__icontains', as default 'lookup_field' value for columns with choices
+* added toolbar_message(): same as footer_message(), but appends message to toolbar
 
 v4.4.2
 ------

README.rst

@@ -407,7 +407,7 @@ Example::
         'autofilter': False,                # see `Filtering single columns` below
         'boolean': False,                   # treat calculated column as BooleanField
         'max_length': 0,                    # if > 0, clip result longer then max_length
-        'lookup_field': '__icontains',      # used for searches; default: '__icontains'
+        'lookup_field': '__icontains',      # used for searches; default: '__iexact' for columns with choices, '__icontains' in all other cases
     }, {
         ...
 
@@ -868,6 +868,15 @@ Example:
 
 .. image:: screenshots/005.png
 
+toolbar_message()
+.................
+
+Same as footer_message() but appends message to toolbar:
+
+.. code:: python
+
+    def footer_message(self, qs, params):
+        return 'Selected rows: %d' % qs.count()
 
 render_clip_value_as_html()
 ...........................

ajax_datatable/static/ajax_datatable/js/utils.js

@@ -362,6 +362,17 @@ window.AjaxDatatableViewUtils = (function() {
         footer.html(html);
     }
 
+    function _write_toolbar_message(table, html) {
+        var wrapper = table.closest('.dataTables_wrapper');
+        var toolbar = wrapper.find('.toolbar');
+        var toolbar_message = toolbar.find('.dataTables_extraToolbar');
+        if (toolbar_message.length <= 0) {
+            $('<div class="dataTables_extraToolbar"></div>').appendTo(toolbar);
+            toolbar_message = toolbar.find('.dataTables_extraToolbar');
+        }
+        toolbar_message.html(html);
+    }
+
     function initialize_table(element, url, extra_options={}, extra_data={}) {
 
         var data = {action: 'initialize'};
@@ -441,6 +452,10 @@ window.AjaxDatatableViewUtils = (function() {
                           if (footer_message !== null) {
                               _write_footer(table, footer_message);
                           }
+                          var toolbar_message = data.toolbar_message;
+                          if (toolbar_message !== null) {
+                              _write_toolbar_message(table, toolbar_message);
+                          }
 
                       }).fail(function(jqXHR, textStatus, errorThrown) {
                           console.log('ERROR: ' + jqXHR.responseText);

ajax_datatable/views.py

@@ -562,6 +562,7 @@ def get(self, request, *args, **kwargs):
             paginator = Paginator(qs, params['length'])
         response_dict = self.get_response_dict(request, paginator, params['draw'], params['start'])
         response_dict['footer_message'] = self.footer_message(qs, params)
+        response_dict['toolbar_message'] = self.toolbar_message(qs, params)
 
         # Prepare response
         response = HttpResponse(
@@ -950,6 +951,12 @@ def footer_message(self, qs, params):
         # return 'Selected rows: %d' % qs.count()
         return None
 
+    def toolbar_message(self, qs, params):
+        """
+        Overriden to append a message to the bottom of the table
+        """
+        return None
+
     def list_autofilter_choices(self, request, column_spec, field, initial_search_value):
         """
         Collects distinct values from specified field,