X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=plugins%2Fhazelnut%2Fstatic%2Fjs%2Fhazelnut.js;h=f17eb258da2574a924e9f3adcfef5416168d0bc9;hb=3fb8170e3114c0845d95b35542a7bbfe84f7ac1b;hp=af2dcfa0e65fd297a6b38e25fc11865b05c2d22b;hpb=ac2dda758798f7e44de062d370763c639cc6a375;p=myslice.git diff --git a/plugins/hazelnut/static/js/hazelnut.js b/plugins/hazelnut/static/js/hazelnut.js index af2dcfa0..f17eb258 100644 --- a/plugins/hazelnut/static/js/hazelnut.js +++ b/plugins/hazelnut/static/js/hazelnut.js @@ -6,10 +6,8 @@ (function($){ - // TEMP - var ELEMENT_KEY = 'resource_hrn'; var debug=false; - debug=true +// debug=true var Hazelnut = Plugin.extend({ @@ -18,14 +16,21 @@ this._super(options, element); /* Member variables */ - // query status - this.received_all = false; - this.received_set = false; - this.in_set_buffer = Array(); + // in general we expect 2 queries here + // query_uuid refers to a single object (typically a slice) + // query_all_uuid refers to a list (typically resources or users) + // these can return in any order so we keep track of which has been received yet + this.received_all_query = false; + this.received_query = false; + + // an internal buffer for records that are 'in' and thus need to be checked + this.buffered_records_to_check = []; + // an internal buffer for keeping lines and display them in one call to fnAddData + this.buffered_lines = []; /* XXX Events XXX */ // this.$element.on('show.Datatables', this.on_show); - this.el().on('show', this, this.on_show); + this.elmt().on('show', this, this.on_show); // Unbind all events using namespacing // TODO in destructor // $(window).unbind('Hazelnut'); @@ -44,10 +49,6 @@ this.initialize_table(); }, - default_options: { - 'checkboxes': false - }, - /* PLUGIN EVENTS */ on_show: function(e) @@ -78,10 +79,13 @@ { /* Transforms the table into DataTable, and keep a pointer to it */ var self = this; - actual_options = { + var actual_options = { // Customize the position of Datatables elements (length,filter,button,...) // we use a fluid row on top and another on the bottom, making sure we take 12 grid elt's each time - sDom: "<'row-fluid'<'span5'l><'span1'r><'span6'f>>t<'row-fluid'<'span5'i><'span7'p>>", + sDom: "<'row'<'col-xs-5'l><'col-xs-1'r><'col-xs-6'f>>t<'row'<'col-xs-5'i><'col-xs-7'p>>", + // XXX as of sept. 2013, I cannot locate a bootstrap3-friendly mode for now + // hopefully this would come with dataTables v1.10 ? + // in any case, search for 'sPaginationType' all over the code for more comments sPaginationType: 'bootstrap', // Handle the null values & the error : Datatables warning Requested unknown parameter // http://datatables.net/forums/discussion/5331/datatables-warning-...-requested-unknown-parameter/p2 @@ -93,13 +97,22 @@ // 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 ); - this.table = this.el('table').dataTable(actual_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 + // however, we have to accumulate in aoColumnDefs from here (above) + // and from the python wrapper (checkboxes management, plus any user-provided aoColumnDefs) + if ( 'aoColumnDefs' in this.options.datatables_options) { + actual_options['aoColumnDefs']=this.options.datatables_options['aoColumnDefs'].concat(actual_options['aoColumnDefs']); + delete this.options.datatables_options['aoColumnDefs']; + } + $.extend(actual_options, this.options.datatables_options ); + this.table = this.elmt('table').dataTable(actual_options); /* Setup the SelectAll button in the dataTable header */ /* xxx not sure this is still working */ var oSelectAll = $('#datatableSelectAll-'+ this.options.plugin_uuid); - oSelectAll.html("Select All"); + oSelectAll.html("Select All"); oSelectAll.button(); oSelectAll.css('font-size','11px'); oSelectAll.css('float','right'); @@ -134,115 +147,17 @@ return (tabIndex.length > 0) ? tabIndex[0] : -1; }, // getColIndex - // UNUSED ? // this.update_plugin = function(e, rows) { - // UNUSED ? // // e.data is what we passed in second argument to subscribe - // UNUSED ? // // so here it is the jquery object attached to the plugin
- // UNUSED ? // var $plugindiv=e.data; - // UNUSED ? // if (debug) - // UNUSED ? // messages.debug("entering hazelnut.update_plugin on id '" + $plugindiv.attr('id') + "'"); - // UNUSED ? // // clear the spinning wheel: look up an ancestor that has the need-spin class - // UNUSED ? // // do this before we might return - // UNUSED ? // $plugindiv.closest('.need-spin').spin(false); - // UNUSED ? // - // UNUSED ? // var options = this.options; - // UNUSED ? // var hazelnut = this; - // UNUSED ? // - // UNUSED ? // /* if we get no result, or an error, try to make that clear, and exit */ - // UNUSED ? // if (rows.length==0) { - // UNUSED ? // if (debug) - // UNUSED ? // messages.debug("Empty result on hazelnut " + this.options.domid); - // UNUSED ? // var placeholder=$(this.table).find("td.dataTables_empty"); - // UNUSED ? // console.log("placeholder "+placeholder); - // UNUSED ? // if (placeholder.length==1) - // UNUSED ? // placeholder.html(unfold.warning("Empty result")); - // UNUSED ? // else - // UNUSED ? // this.table.html(unfold.warning("Empty result")); - // UNUSED ? // return; - // UNUSED ? // } else if (typeof(rows[0].error) != 'undefined') { - // UNUSED ? // // we now should have another means to report errors that this inline/embedded hack - // UNUSED ? // if (debug) - // UNUSED ? // messages.error ("undefined result on " + this.options.domid + " - should not happen anymore"); - // UNUSED ? // this.table.html(unfold.error(rows[0].error)); - // UNUSED ? // return; - // UNUSED ? // } - // UNUSED ? // - // UNUSED ? // /* - // UNUSED ? // * fill the dataTables object - // UNUSED ? // * we cannot set html content directly here, need to use fnAddData - // UNUSED ? // */ - // UNUSED ? // var lines = new Array(); - // UNUSED ? // - // UNUSED ? // this.current_resources = Array(); - // UNUSED ? // - // UNUSED ? // $.each(rows, function(index, row) { - // UNUSED ? // // this models a line in dataTables, each element in the line describes a cell - // UNUSED ? // line = new Array(); - // UNUSED ? // - // UNUSED ? // // go through table headers to get column names we want - // UNUSED ? // // in order (we have temporarily hack some adjustments in names) - // UNUSED ? // var cols = object.table.fnSettings().aoColumns; - // UNUSED ? // var colnames = cols.map(function(x) {return x.sTitle}) - // UNUSED ? // var nb_col = cols.length; - // UNUSED ? // /* if we've requested checkboxes, then forget about the checkbox column for now */ - // UNUSED ? // if (options.checkboxes) nb_col -= 1; - // UNUSED ? // - // UNUSED ? // /* fill in stuff depending on the column name */ - // UNUSED ? // for (var j = 0; j < nb_col; j++) { - // UNUSED ? // if (typeof colnames[j] == 'undefined') { - // UNUSED ? // line.push('...'); - // UNUSED ? // } else if (colnames[j] == 'hostname') { - // UNUSED ? // if (row['type'] == 'resource,link') - // UNUSED ? // //TODO: we need to add source/destination for links - // UNUSED ? // line.push(''); - // UNUSED ? // else - // UNUSED ? // line.push(row['hostname']); - // UNUSED ? // } else { - // UNUSED ? // if (row[colnames[j]]) - // UNUSED ? // line.push(row[colnames[j]]); - // UNUSED ? // else - // UNUSED ? // line.push(''); - // UNUSED ? // } - // UNUSED ? // } - // UNUSED ? // - // UNUSED ? // /* catch up with the last column if checkboxes were requested */ - // UNUSED ? // if (options.checkboxes) { - // UNUSED ? // var checked = ''; - // UNUSED ? // // xxx problem is, we don't get this 'sliver' thing set apparently - // UNUSED ? // if (typeof(row['sliver']) != 'undefined') { /* It is equal to null when is present */ - // UNUSED ? // checked = 'checked '; - // UNUSED ? // hazelnut.current_resources.push(row[ELEMENT_KEY]); - // UNUSED ? // } - // UNUSED ? // // Use a key instead of hostname (hard coded...) - // UNUSED ? // line.push(hazelnut.checkbox(options.plugin_uuid, row[ELEMENT_KEY], row['type'], checked, false)); - // UNUSED ? // } - // UNUSED ? // - // UNUSED ? // lines.push(line); - // UNUSED ? // - // UNUSED ? // }); - // UNUSED ? // - // UNUSED ? // this.table.fnClearTable(); - // UNUSED ? // if (debug) - // UNUSED ? // messages.debug("hazelnut.update_plugin: total of " + lines.length + " rows"); - // UNUSED ? // this.table.fnAddData(lines); - // UNUSED ? // - // UNUSED ? // }, // update_plugin - - checkbox: function (plugin_uuid, header, field) //, selected_str, disabled_str) + checkbox_html : function (key, value) { var result=""; - if (header === null) - header = ''; // Prefix id with plugin_uuid result += " '+record['hrn']); } else { if (record[colnames[j]]) line.push(record[colnames[j]]); @@ -279,14 +197,15 @@ } } - /* catch up with the last column if checkboxes were requested */ - if (this.options.checkboxes) + // catch up with the last column if checkboxes were requested + if (this.options.checkboxes) { // Use a key instead of hostname (hard coded...) - // XXX remove the empty checked attribute - line.push(this.checkbox(this.options.plugin_uuid, record[ELEMENT_KEY], record['type'])); + line.push(this.checkbox_html(this.key, record[this.key])); + } - // XXX Is adding an array of lines more efficient ? - this.table.fnAddData(line); + // adding an array in one call is *much* more efficient + // this.table.fnAddData(line); + this.buffered_lines.push(line); }, @@ -321,8 +240,7 @@ set_checkbox: function(record, checked) { /* Default: checked = true */ - if (typeof checked === 'undefined') - checked = true; + if (checked === undefined) checked = true; var key_value; /* The function accepts both records and their key */ @@ -340,11 +258,11 @@ } - var checkbox_id = this.id('checkbox', this.id_from_key(this.key, key_value)); - checkbox_id = '#' + checkbox_id.replace(/\./g, '\\.'); - - var element = $(checkbox_id, this.table.fnGetNodes()); - + var checkbox_id = this.flat_id(this.id('checkbox', key_value)); + checkbox_id = '#' + checkbox_id; + // using dataTables's $ to search also in nodes that are not currently displayed + var element = this.table.$(checkbox_id); + if (debug) messages.debug("set_checkbox checked=" + checked + " id=" + checkbox_id + " matches=" + element.length); element.attr('checked', checked); }, @@ -387,13 +305,15 @@ on_new_record: function(record) { - /* NOTE in fact we are doing a join here */ - if (this.received_all) - // update checkbox for record + if (this.received_all_query) { + // if the 'all' query has been dealt with already we may turn on the checkbox + if (debug) messages.debug("turning on checkbox for record "+record[this.key]); this.set_checkbox(record, true); - else - // store for later update of checkboxes - this.in_set_buffer.push(record); + } else { + // otherwise we need to remember that and do it later on + if (debug) messages.debug ("Remembering record to check " + record[this.key]); + this.buffered_records_to_check.push(record); + } }, on_clear_records: function() @@ -408,9 +328,9 @@ on_query_done: function() { - if (this.received_all) - this.unspin(); - this.received_set = true; + this.received_query = true; + // unspin once we have received both + if (this.received_all_query && this.received_query) this.unspin(); }, on_field_state_changed: function(data) @@ -450,19 +370,22 @@ on_all_query_done: function() { + if (debug) messages.debug("1-shot initializing dataTables content with " + this.buffered_lines.length + " lines"); + this.table.fnAddData (this.buffered_lines); + this.buffered_lines=[]; + var self = this; - if (this.received_set) { - /* XXX needed ? XXX We uncheck all checkboxes ... */ - $("[id^='datatables-checkbox-" + this.options.plugin_uuid +"']").attr('checked', false); - - /* ... and check the ones specified in the resource list */ - $.each(this.in_set_buffer, function(i, record) { - self.set_checkbox(record, true); - }); + // if we've already received the slice query, we have not been able to set + // checkboxes on the fly at that time (dom not yet created) + $.each(this.buffered_records_to_check, function(i, record) { + if (debug) messages.debug ("delayed turning on checkbox " + i + " record= " + record); + self.set_checkbox(record, true); + }); + this.buffered_records_to_check = []; - this.unspin(); - } - this.received_all = true; + this.received_all_query = true; + // unspin once we have received both + if (this.received_all_query && this.received_query) this.unspin(); }, // on_all_query_done @@ -534,7 +457,7 @@ * Handle clicks on checkboxes: reassociate checkbox click every time * the table is redrawn */ - this.els('hazelnut-checkbox').unbind('click').click(this, this._check_click); + this.elts('hazelnut-checkbox').unbind('click').click(this, this._check_click); if (!this.table) return; @@ -565,6 +488,7 @@ var self = e.data; // XXX this.value = key of object to be added... what about multiple keys ? + if (debug) messages.debug("hazelnut click handler checked=" + this.checked + " hrn=" + this.value); manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, this.value); //return false; // prevent checkbox to be checked, waiting response from manifold plugin api @@ -594,4 +518,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); +