Merge branch 'jordan' of ssh://git.onelab.eu/git/myslice into jordan
[myslice.git] / manifold / js / plugin.js
index 84ebbc4..dd12379 100644 (file)
@@ -40,7 +40,7 @@ var Plugin = Class.extend({
         return (typeof this.on_filter_added === 'function');
     },
 
-    _query_handler: function(e, event_type, data)
+    _query_handler: function(prefix, event_type, data)
     {
         // We suppose this.query_handler_prefix has been defined if this
         // callback is triggered    
@@ -68,7 +68,7 @@ var Plugin = Class.extend({
                 return;
         } // switch
         
-        fn = 'on_' + this.query_handler_prefix + fn;
+        fn = 'on_' + prefix + fn;
         if (typeof this[fn] === 'function') {
             // call with data as parameter
             // XXX implement anti loop
@@ -76,9 +76,54 @@ var Plugin = Class.extend({
         }
     },
 
-    listen_query: function(query_uuid, prefix) {
-        this.query_handler_prefix = (typeof prefix === 'undefined') ? '' : (prefix + manifold.separator);
-        this.$element.on(manifold.get_query_channel(query_uuid), $.proxy(this._query_handler, this));
+    _record_handler: function(prefix, event_type, record)
+    {
+        // We suppose this.query_handler_prefix has been defined if this
+        // callback is triggered    
+        var fn;
+        switch(event_type) {
+            case NEW_RECORD:
+                fn = 'new_record';
+                break;
+            case CLEAR_RECORDS:
+                fn = 'clear_records';
+                break;
+            case IN_PROGRESS:
+                fn = 'query_in_progress';
+                break;
+            case DONE:
+                fn = 'query_done';
+                break;
+            case FIELD_STATE_CHANGED:
+                fn = 'field_state_changed';
+                break;
+            default:
+                return;
+        } // switch
+        
+        fn = 'on_' + prefix + fn;
+        if (typeof this[fn] === 'function') {
+            // call with data as parameter
+            // XXX implement anti loop
+            this[fn](record);
+        }
+    },
+
+    get_handler_function: function(type, prefix)
+    {
+        
+        return $.proxy(function(e, event_type, record) {
+            return this['_' + type + '_handler'](prefix, event_type, record);
+        }, this);
+    },
+
+    listen_query: function(query_uuid, prefix)
+    {
+        // default: prefix = ''
+        prefix = (typeof prefix === 'undefined') ? '' : (prefix + '_');
+
+        this.$element.on(manifold.get_channel('query', query_uuid),  this.get_handler_function('query',  prefix));
+        this.$element.on(manifold.get_channel('record', query_uuid),  this.get_handler_function('record', prefix));
     },
 
     default_options: {},
@@ -155,4 +200,65 @@ var Plugin = Class.extend({
         return array[1];
     },
 
+    id_from_key: function(key_field, value)
+    {
+        
+        return key_field + manifold.separator + unfold.escape_id(value).replace(/\\/g, '');
+    },
+
+    id_from_record: function(method, record)
+    {
+        var keys = manifold.metadata.get_key(method);
+        if (!keys)
+            return;
+        if (keys.length > 1)
+            return;
+
+        var key = keys[0];
+        switch (Object.toType(key)) {
+            case 'string':
+                if (!(key in record))
+                    return null;
+                return this.id_from_key(key, record[key]);
+    
+            default:
+                throw 'Not implemented';
+        }
+    },
+
+    key_from_id: function(id)
+    {
+        // NOTE this works only for simple keys
+
+        var array;
+        if (typeof id === 'string') {
+            array = id.split(manifold.separator);
+        } else { // We suppose we have an array ('object')
+            array = id;
+        }
+
+        // arguments has the initial id but lacks the key field name (see id_from_key), so we are even
+        // we finally add +1 for the plugin_uuid at the beginning
+        return array[arguments.length + 1];
+    },
+
+    /* SPIN */
+
+    spin: function()
+    {
+        manifold.spin(this.element);
+    },
+
+    unspin: function()
+    {
+        manifold.spin(this.element, false);
+    },
+
+    /* TEMPLATE */
+
+    load_template: function(name, ctx)
+    {
+        return Mustache.render(this.el(name).html(), ctx);
+    },
+
 });