plugins/myplugin/static/js/myplugin.js

   1 /**
   2  * MyPlugin:    demonstration plugin
   3  * Version:     0.1
   4  * Description: Template for writing new plugins and illustrating the different
   5  *              possibilities of the plugin API.
   6  *              This file is part of the Manifold project
   7  * Requires:    js/plugin.js
   8  * URL:         http://www.myslice.info
   9  * Author:      Jordan Augé <jordan.auge@lip6.fr>
  10  * Copyright:   Copyright 2012-2013 UPMC Sorbonne Universités
  11  * License:     GPLv3
  12  */
  13
  14 (function($){
  15
  16     var MyPlugin = Plugin.extend({
  17
  18         /** XXX to check
  19          * @brief Plugin constructor
  20          * @param options : an associative array of setting values
  21          * @param element :
  22          * @return : a jQuery collection of objects on which the plugin is
  23          *     applied, which allows to maintain chainability of calls
  24          */
  25         init: function(options, element) {
  26             // for debugging tools
  27             this.classname="myplugin";
  28             // Call the parent constructor, see FAQ when forgotten
  29             this._super(options, element);
  30
  31             /* Member variables */
  32
  33             /* Plugin events */
  34
  35             /* Setup query and record handlers */
  36
  37             // Explain this will allow query events to be handled
  38             // What happens when we don't define some events ?
  39             // Some can be less efficient
  40             this.listen_query(options.query_uuid);
  41             this.listen_query(options.query_uuid, 'all');
  42
  43             /* GUI setup and event binding */
  44             // call function
  45
  46         },
  47
  48         /* PLUGIN EVENTS */
  49         // on_show like in querytable
  50
  51
  52         /* GUI EVENTS */
  53
  54         // a function to bind events here: click change
  55         // how to raise manifold events
  56
  57
  58         /* GUI MANIPULATION */
  59
  60         // We advise you to write function to change behaviour of the GUI
  61         // Will use naming helpers to access content _inside_ the plugin
  62         // always refer to these functions in the remaining of the code
  63
  64         show_hide_button: function()
  65         {
  66             // this.id, this.el, this.cl, this.elts
  67             // same output as a jquery selector with some guarantees
  68         },
  69
  70         /* TEMPLATES */
  71
  72         // see in the html template
  73         // How to load a template, use of mustache
  74
  75         /* QUERY HANDLERS */
  76
  77         // How to make sure the plugin is not desynchronized
  78         // He should manifest its interest in filters, fields or records
  79         // functions triggered only if the proper listen is done
  80
  81         // no prefix
  82
  83         on_filter_added: function(filter)
  84         {
  85
  86         },
  87
  88         // ... be sure to list all events here
  89
  90         /* RECORD HANDLERS */
  91         on_all_new_record: function(record)
  92         {
  93             //
  94         },
  95
  96         /* INTERNAL FUNCTIONS */
  97         _dummy: function() {
  98             // only convention, not strictly enforced at the moment
  99         },
 100
 101     });
 102
 103     /* Plugin registration */
 104     $.plugin('MyPlugin', MyPlugin);
 105
 106     // TODO Here use cases for instanciating plugins in different ways like in the pastie.
 107
 108 })(jQuery);