2 * univbris: test plugin for Bristol University
4 * Description: just testing plugin in myslice
5 * Requires: js/plugin.js
6 * URL: http://www.myslice.info
7 * Author: Frederic Francois <f.francois@bristol.ac.uk>
8 * Copyright: Copyright 2012-2013 Bristol University
14 var Univbris = Plugin.extend({
17 * @brief Plugin constructor
18 * @param options : an associative array of setting values
20 * @return : a jQuery collection of objects on which the plugin is
21 * applied, which allows to maintain chainability of calls
23 init: function(options, element) {
24 // Call the parent constructor, see FAQ when forgotten
25 this._super(options, element);
27 /* Member variables */
31 /* Setup query and record handlers */
33 // Explain this will allow query events to be handled
34 // What happens when we don't define some events ?
35 // Some can be less efficient
36 this.listen_query(options.query_uuid);
37 this.listen_query(options.query_uuid, 'all');
39 /* GUI setup and event binding */
42 alert("univbris plugin 2");
47 // on_show like in querytable
52 // a function to bind events here: click change
53 // how to raise manifold events
56 /* GUI MANIPULATION */
58 // We advise you to write function to change behaviour of the GUI
59 // Will use naming helpers to access content _inside_ the plugin
60 // always refer to these functions in the remaining of the code
62 show_hide_button: function()
64 // this.id, this.el, this.cl, this.elts
65 // same output as a jquery selector with some guarantees
70 // see in the html template
71 // How to load a template, use of mustache
75 // How to make sure the plugin is not desynchronized
76 // He should manifest its interest in filters, fields or records
77 // functions triggered only if the proper listen is done
81 on_filter_added: function(filter)
86 // ... be sure to list all events here
89 on_all_new_record: function(record)
94 /* INTERNAL FUNCTIONS */
96 // only convention, not strictly enforced at the moment
101 /* Plugin registration */
102 $.plugin('Univbris', Univbris);
104 // TODO Here use cases for instanciating plugins in different ways like in the pastie.