/**
- * MySlice MyPlugin demonstration plugin
- * Version: 0.1.0
- * URL: http://www.myslice.info
- * Description: Template for writing new plugins and illustrating the different possibilities of the plugin API
- * Requires:
- * Author: The MySlice Team
- * Copyright: Copyright 2012-2013 UPMC Sorbonne Universités
- * License: GPLv3
+ * MyPlugin: demonstration plugin
+ * Version: 0.1
+ * Description: Template for writing new plugins and illustrating the different
+ * possibilities of the plugin API.
+ * This file is part of the Manifold project
+ * Requires: js/plugin.js
+ * URL: http://www.myslice.info
+ * Author: Jordan Augé <jordan.auge@lip6.fr>
+ * Copyright: Copyright 2012-2013 UPMC Sorbonne Universités
+ * License: GPLv3
*/
-/*
- * It's a best practice to pass jQuery to an IIFE (Immediately Invoked Function
- * Expression) that maps it to the dollar sign so it can't be overwritten by
- * another library in the scope of its execution.
- */
-(function( $ ){
-
- var PLUGIN_NAME = 'MyPlugin';
-
- // Routing calls
- jQuery.fn.ResourcesSelected = function( method ) {
- 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' + PLUGIN_NAME );
- }
+(function($){
- };
+ var MyPlugin = Plugin.extend({
- /***************************************************************************
- * Public methods
- ***************************************************************************/
-
- var methods = {
-
- /**
- * @brief Plugin initialization
+ /** XXX to check
+ * @brief Plugin constructor
* @param options : an associative array of setting values
+ * @param element :
* @return : a jQuery collection of objects on which the plugin is
* applied, which allows to maintain chainability of calls
*/
- init : function( options ) {
+ init: function(options, element) {
+ // Call the parent constructor, see FAQ when forgotten
+ this._super(options, element);
- return this.each(function(){
+ /* Member variables */
- var $this = $(this);
+ /* Plugin events */
- /* An object that will hold private variables and methods */
- var s = new ResourcesSelected(options);
- $(this).data('Manifold', s);
-
- }); // this.each
- }, // init
+ /* Setup query and record handlers */
- /**
- * @brief Plugin destruction
- * @return : a jQuery collection of objects on which the plugin is
- * applied, which allows to maintain chainability of calls
- */
- destroy : function( ) {
+ // Explain this will allow query events to be handled
+ // What happens when we don't define some events ?
+ // Some can be less efficient
+ this.listen_query(options.query_uuid);
+ this.listen_query(options.query_uuid, 'all');
+
+ /* GUI setup and event binding */
+ // call function
+
+ },
+
+ /* PLUGIN EVENTS */
+ // on_show like in hazelnut
+
+
+ /* GUI EVENTS */
+
+ // a function to bind events here: click change
+ // how to raise manifold events
+
+
+ /* GUI MANIPULATION */
+
+ // We advise you to write function to change behaviour of the GUI
+ // Will use naming helpers to access content _inside_ the plugin
+ // always refer to these functions in the remaining of the code
+
+ show_hide_button: function()
+ {
+ // this.id, this.el, this.cl, this.elts
+ // same output as a jquery selector with some guarantees
+ },
+
+ /* TEMPLATES */
+
+ // see in the html template
+ // How to load a template, use of mustache
+
+ /* QUERY HANDLERS */
+
+ // How to make sure the plugin is not desynchronized
+ // He should manifest its interest in filters, fields or records
+ // functions triggered only if the proper listen is done
- return this.each(function(){
- var $this = jQuery(this), data = $this.data('Manifold');
- jQuery(window).unbind('Manifold');
- data.Manifold.remove();
- $this.removeData('Manifold');
- })
+ // no prefix
- }, // destroy
+ on_filter_added: function(filter)
+ {
- }; // var methods
+ },
- /***************************************************************************
- * ResourcesSelected object
- ***************************************************************************/
+ // ... be sure to list all events here
- function MyPlugin(options)
- {
- /* member variables */
+ /* RECORD HANDLERS */
+
+ on_record_received: function(record)
+ {
+ //
+ },
- this.options = options;
+ /* INTERNAL FUNCTIONS */
+ _dummy: function() {
+ // only convention, not strictly enforced at the moment
+ },
- /* methods */
+ });
- /* constructor */
+ /* Plugin registration */
+ $.plugin('MyPlugin', MyPlugin);
- } // function MyPlugin
+ // TODO Here use cases for instanciating plugins in different ways like in the pastie.
})(jQuery);
git://git.onelab.eu / myslice.git / blobdiff