dGrowl.js

define(["dojo/text",
		"dojo/_base/declare",
		"dijit/_WidgetBase",
		"dijit/_TemplatedMixin",
		"dojo/topic",
		"dojo/dom-construct",
		"NotificationNode",
		"dojo/query",
		"dojo/_base/lang",
		"dojo/dom-class",
		"dojo/text!./templates/dGrowl.css",
		"dojo/text!./templates/dGrowl.html"],
function(t, declare, base, templated, topic, domCon, NotificationNode, query, lang, domClass, css, template) {
	return declare('dGrowl', [base, templated], {
		'templateString': template,
		'channels': [{
			name: 'default',
			pos: 0
		}],
		'topic': 'messageQueue',
		// channel user definitions
		'orientation': 'topRight',
		'defaultChannel': null,
		'buildRendering': function() {
			this.inherited(arguments);
			domCon.place("<style>" + css + "</style>", query('head')[0]);
		},
		'postCreate': function() {
			this.inherited(arguments);
			if (!this.channels instanceof Array) {
				this.channels = [this.channels];
			}
			// we trying to set this or do I need to..?
			if (this.defaultChannel === null) {
				this.defaultChannel = this.channels[0].name; // first specified = default
			}
			this.channels.sort(this.sortChannels);
			this.chanDefs = {}; // channel definitions indexed by channel name
			// build nodes for the channels
			for (var i = 0; i < this.channels.length; i++) {
				this.addChannel(this.channels[i].name, this.channels[i]);
			}
			// event
			this._s = topic.subscribe(this.topic, lang.hitch(this, this._subscribedChannels));
			// style myself..
			domClass.add(this.domNode, 'dGrowl-' + this.orientation);
			// push myself to the window..
			var b = query('body')[0];
			domCon.place(this.domNode, b, 'top');
		},
		'destroy': function() // cleanup!! important to get rid of our awesomeness, when noone loves us anymore.
		{
			for (var i = 0; i < this.chanDefs.length; i++) {
				topic.unsubscribe(this.chanDefs[i]._s);
			}
			topic.unsubscribe(this._s);
			this.inherited(arguments);
		},
		'_subscribedChannels': function() {
			return this.addNotification(arguments[0], arguments[1])
		},
		'addChannel': function(c, o) {
			this.chanDefs[c] = o; // main def
			this.chanDefs[c].node = domCon.create('li', {
				'class': "dGrowl-channel dGrowl-channel-" + c
			}); // node
			domCon.place(this.chanDefs[c].node, this.channelsN);
		},
		// creates and displays a new notification widget
		'addNotification': function(m, o) {
			// option undefined, create default
			if (o == undefined) o = {
				channel: this.defaultChannel
			};
			else if (o.channel == undefined) o.channel = this.defaultChannel;
			// verify the channel exists
			if (this.chanDefs[o.channel] != undefined) {
				// moosh options/message together and kick off the notification...
				o.message = m;
				var n = new NotificationNode(o);
				domCon.place(n.domNode, this.chanDefs[o.channel].node); // push to page
				n.show();
				return n;
			} else
			console.error(o.channel + ' channel was not found!');
			return false;
		},
		// sorts the channel definitions based on the pos numeric property
		'sortChannels': function(a, b) {
			if (a.pos == undefined) {
				return -1;
			}
			if (b.pos == undefined) {
				return 1;
			}
			if (a.pos > b.pos) return 1;
			else if (a.pos == b.pos) return 0;
			else
			return -1;
		}
	});
});