plugin.js

/**
\file plugin.js
Skeleton template for all boomerang plugins.  Use this code as a starting point for your
own plugins.
*/

//////////////////////////////////////////////////////////
//    DO NOT INCLUDE THIS FILE IN YOUR HTML DOCUMENT    //
//               THIS IS A SAMPLE PLUGIN                //
//////////////////////////////////////////////////////////

// w is the window object
(function(w) {

var d=w.document;

// First make sure BOOMR is actually defined.  It's possible that your plugin is loaded before boomerang, in which case
// you'll need this.
BOOMR = BOOMR || {};
BOOMR.plugins = BOOMR.plugins || {};

// A private object to encapsulate all your implementation details
// This is optional, but the way we recommend you do it.
var impl = {
};
	
BOOMR.plugins.MyPlugin = {
	init: function(config) {
		var i, properties = ["prop1", "prop2"];	// list of user configurable properties in O

		// This block is only needed if you actually have user configurable properties
		BOOMR.utils.pluginConfig(impl, config, "MyPlugin", properties);

		// Other initialisation code here

		// Subscribe to any BOOMR events here.
		// Unless your code will explicitly be called by the developer
		// or by another plugin, you must to do this.

		return this;
	},

	// Any other public methods would be defined here

	is_complete: function() {
		// This method should determine if the plugin has completed doing what it
		/// needs to do and return true if so or false otherwise
	}
};

}(window));