rewrite simplelist to use a table (thus datatable-ready) instead of <ul> -- ctd
[unfold.git] / plugins / static / js / simplelist.js
index b916d11..d7f1d92 100644 (file)
  * MySlice SimpleList plugin
  * Version: 0.1.0
  * URL: http://www.myslice.info
- * Description: Google maps display of geolocated data
+ * Description: display simple lists like slices or testbeds
  * Requires: 
  * Author: The MySlice Team
- * Copyright: Copyright 2012 UPMC Sorbonne Universités
+ * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA
  * License: GPLv3
  */
 
-(function(jQuery){
-
-  var methods = {
-     init : function( options ) {
-
-       return this.each(function(){
-         
-         var $this = jQuery(this),
-             data = $this.data('SimpleList'), SimpleList = jQuery('<div />', { text : $this.attr('title') });
-         
-         // If the plugin hasn't been initialized yet
-         if ( ! data ) {
-         
-            /* Plugin initialization */
-
-            /* Subscribe to query updates */
-            jQuery.subscribe('/results/' + options.query_uuid + '/changed', {instance: $this}, update_list);
-
-            /* End of plugin initialization */
-
-            $this.data('SimpleList', {
-                options: options,
-                target : $this,
-                SimpleList : SimpleList
-            });
-
-         }
-       });
-     },
-    destroy : function( ) {
-
-        return this.each(function(){
-            var $this = jQuery(this), data = $this.data('SimpleList');
-            jQuery(window).unbind('SimpleList');
-            data.SimpleList.remove();
-            $this.removeData('SimpleList');
-        })
-
+simplelist_debug=false;
+
+(function($){
+    var methods = {
+       init : function( options ) {
+           return this.each(function(){
+               var $this = $(this);
+               var data = $this.data('SimpleList');
+               /* create an empty DOM object */                
+               var SimpleList = $('<div />', { text : $this.attr('title') });
+               // If the plugin hasn't been initialized yet
+               if ( ! data ) {
+                   /* Subscribe to query updates */
+                   var channel='/results/' + options.query_uuid + '/changed';
+                   /* passing $this as 2nd arg: callbacks will retrieve $this as e.data */
+                   $.subscribe(channel, $this, update_list);
+                   if (simplelist_debug) window.console.log('subscribing to ' + channel);
+                   $this.data('SimpleList', {options: options, SimpleList : SimpleList});
+               }
+           });
+       },
+       destroy : function( ) {
+            return this.each(function(){
+               var $this = $(this), data = $this.data('SimpleList');
+               $(window).unbind('SimpleList');
+               data.SimpleList.remove();
+               $this.removeData('SimpleList');
+            })
     },
-/*
-    reposition : function( ) { // ... },
-    show : function( ) { // ... },
-    hide : function( ) { // ... },
-*/
-    update : function( content ) { }
-  };
+       update : function( content ) { }
+    };
 
-    jQuery.fn.SimpleList = function( method ) {
+    $.fn.SimpleList = function( method ) {
         /* Method calling logic */
         if ( methods[method] ) {
             return methods[ method ].apply( this, Array.prototype.slice.call( arguments, 1 ));
         } else if ( typeof method === 'object' || ! method ) {
             return methods.init.apply( this, arguments );
         } else {
-            jQuery.error( 'Method ' +  method + ' does not exist on jQuery.SimpleList' );
+            $.error( 'Method ' +  method + ' does not exist on jQuery.SimpleList' );
         }    
-
     };
 
     /* Private methods */
+    function update_list(e, rows) {
+       // e.data is what we passed in second argument to subscribe
+       var $this=e.data;
+       // locate the <tbody>, expected layout being
+       // <div class='plugin'> <table> <thead /> <tbody /tbody> </table> </div>
+       // -- or, if we don't have a header --
+       // <div class='plugin'> <table> <tbody /tbody> </table> </div>
+       var $tbody=$this.find("tbody.simplelist").first();
+       if (simplelist_debug) console.log("$tbody goes with "+$tbody.get(0));
 
-    function update_list(e, rows)
-    {
         if (rows.length == 0) {
-            e.data.instance.html('No result !');
+            $tbody.html("<tr><td class='simplelist-empty'>No result !</tr></td>");
             return;
         }
         if (typeof rows[0].error != 'undefined') {
-            e.data.instance.html('ERROR: ' + rows[0].error);
+            e.data.html("<tr><td class='simplelist-error'>ERROR: " + rows[0].error + "</td></tr>");
             return;
         }
-        options = e.data.instance.data().SimpleList.options;
-        is_cached = options.query.ts != 'now' ? true : false;
-        e.data.instance.html(myslice_html_ul(rows, options.key, options.value, is_cached)+"<br/>");
-        
-    }
-
-    function myslice_html_li(type, value, is_cached) {
-        var cached = '';
-        //if (is_cached)
-        //    cached='<div class="cache"><span><b>Cached information from the database</b><br/>Timestamp: XX/XX/XX XX:XX:XX<br/><br/><i>Refresh in progress...</i></span></div>';
-        if (type == 'slice_hrn') {
-            return "<li class='icn icn-play'><a href='/view/slice/" + value + "'>" + value + cached + "</a></li>";
-        } else if (type == 'network_hrn') {
-            return "<li class='icn icn-play'>" + value + cached + "</li>";
-        } else {
-            return "<li>" + value + "</li>";
-        }
+        var options = e.data.data().SimpleList.options;
+        var is_cached = options.query.timestamp != 'now' ? true : false;
+       // here is where we use 'key' and 'value' from the SimpleList (python) constructor
+       html_code=myslice_html_tbody(rows, options.key, options.value, is_cached);
+       // locate the tbody from the template, set its text
+        $tbody.html(html_code);
+       // clear the spinning wheel
+       var $elt = e.data;
+       if (simplelist_debug) console.log("about to unspin with elt #" + $elt.attr('id') + " class " + $elt.attr('class'));
+       $elt.closest('.need-spin').spin(false);
     }
 
-
-    function myslice_html_ul(data, key, value, is_cached) {
-        var out = "<ul>";
+    function myslice_html_tbody(data, key, value, is_cached) {
+//     return $.map (...)
+        var out = "";
         for (var i = 0; i < data.length; i++) {
-            out += myslice_html_li(key, data[i][value], is_cached);
-            //out += myslice_html_li(key, myslice_html_a(data[i][key], data[i][value], key), is_cached);
+            out += myslice_html_tr(key, data[i][value], is_cached);
         }
-        out += "</ul>";
-
         return out;
     }
-
-    /*
-    function myslice_async_render_list(data, key, value, is_cached) {
-        // we suppose we only have one column, or we need more precisions
-        var col = [];
-        if (myslice_array_size(data[0]) == 1) {
-            for (var k in data[0]) {
-                key = k;
-                value = k;
-            }
+    
+    function myslice_html_tr(key, value,is_cached) {
+        var cached = is_cached ? "(cached)" : "";
+        if (key == 'slice_hrn') {
+            return "<tr><td class='simplelist'><i class='icon-play-circle'></i><a href='/slice/" + value + "'>" + value + cached + "</a></td></tr>";
+        } else if (key == 'network_hrn') {
+            return "<tr><td class='simplelist'><i class='icon-play-circle'></i>" + value + cached + "</td></tr>";
         } else {
-            for (var k in data[0]) {
-                if (k.substr(-4) == '_hrn') {
-                    key = k;
-                } else {
-                    value = k;
-                }
-            }
+            return "<tr><td class='simplelist'>" + value + "</td></tr>";
         }
-        return myslice_html_ul(data, key, value, is_cached);
     }
-    */
-
+    
 })( jQuery );