Copyright (c) 2005, 2006 Rafael Robayna Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. CanvasWidget is a base class that handles all mouse event listening for a canvas element, implements a widget event listener than you can use to trigger events remotely on widget state changes and encapsulates a few useful helper functions. To create widget using CanvasWidget all you need to do is the following: var YourWidget = CanvasWidget.extend({ widget_value_1: null, constructor: function(canvasName, position) { this.inherit(canvasName, position); }, checkWidgetMouseEvent: function(e) { var mousePos = this.getCanvasMousePos(e); //interpret the mouse position this.drawWidget(); }, drawWidget: function() { //your canvas drawing code } }); //initialize an instance of your widget var yourWidget = new YourWidget("canvas_name", {x: canvasPosX, y: canvasPosY}); //initialize an instance of your widget yourWidget.addWidgetListener(function () { //assign your widget value to something else something = this.widget_value_1; });

  
  var CanvasWidget = Base.extend({
          canvas: null,
          context: null,
          position: null,
          widgetListeners: null,
  
          

constuctor
parameter: {String} canvasName - the id of the corresponding canvas html element
parameter: {Array} position - the absolute position of the canvas html elemnt, {x:#,y:#}

  
          constructor: function(canvasElementID, position) {
                  this.canvas = document.getElementById(canvasElementID);
                  this.context = this.canvas.getContext('2d');
                  this.drawWidget();
                  this.initMouseListeners();
                  this.position = position;
                  this.widgetListeners = new Array();
          },
  
          

Initializes all the mouse listeners for the widget.

  
          initMouseListeners: function() {
                  this.mouseMoveTrigger = new Function();
                  if (document.all) {
                          this.canvas.attachEvent("onmousedown", this.mouseDownActionPerformed.bindAsEventListener(this));
                          this.canvas.attachEvent("onmousemove", this.mouseMoveActionPerformed.bindAsEventListener(this));
                          this.canvas.attachEvent("onmouseup", this.mouseUpActionPerformed.bindAsEventListener(this));
                          this.canvas.attachEvent("onmouseout", this.mouseUpActionPerformed.bindAsEventListener(this));
                  } else {
                          this.canvas.addEventListener("mousedown", this.mouseDownActionPerformed.bindAsEventListener(this), false);
                          this.canvas.addEventListener("mousemove", this.mouseMoveActionPerformed.bindAsEventListener(this), false);
                          this.canvas.addEventListener("mouseup", this.mouseUpActionPerformed.bindAsEventListener(this), false);
                          this.canvas.addEventListener("mouseout", this.mouseUpActionPerformed.bindAsEventListener(this), false);
                  }
          },
  
          

Triggered by any mousedown event on the widget. This function calls checkWidgetMouseEvent() and links the mousemove listener to checkWidgetEvent(). Override this function if you want direct access to mousedown events.
parameter: {Event} e

  
          mouseDownActionPerformed: function(e) {
                  this.mouseMoveTrigger = function(e) {
                          this.checkWidgetEvent(e);
                  }
                  this.checkWidgetEvent(e);
          },
          
          

Triggered by any mousemove event on the widget. Override this function if you want direct access to mousemove events.
parameter: {Event} e

  
          mouseMoveActionPerformed: function(e) {
                  this.mouseMoveTrigger(e);
          },
          
          

Triggered by any mouseup or mouseout event on the widget. Override this function if you want direct access to mouseup events.
parameter: {Event} e

  
          mouseUpActionPerformed: function(e) {
                  this.mouseMoveTrigger = new Function();
          },
  
          

Called by the mousedown and mousemove event listeners by default. This function must be implemented by any class extending CPWidget.
parameter: {Event} e

  
          checkWidgetMouseEvent: function(e) {},
          
          

Draws the widget. This function must be implemented by any class extending CPWidget.

  
          drawWidget: function() {},
  
          

Used to add event listeners directly to the widget. Listeners registered with this function are triggered every time the widget's state changes.
parameter: {Function} eventListener

  
          addWidgetListener: function(eventListener) {
                  this.widgetListeners[this.widgetListeners.length] = eventListener;
          },
          
          

Executs all functions registered as widgetListeners. Should be called every time the widget's state changes.

  
          callWidgetListeners: function() {
                  if(this.widgetListeners.length != 0) {
                          for(var i=0; i < this.widgetListeners.length; i++) 
                                  this.widgetListeners[i]();
                  }
          },
          
          

Helper function to get the mouse position relative to the canvas position.
parameter: {Event} e

  
          getCanvasMousePos: function(e) {
                  return {x: e.clientX - this.position.x, y: e.clientY - this.position.y};
          }
  
  });
  
  var CanvasHelper = {
          canvasExists: function(canvasName) {
                  var canvas = document.getElementById(canvasName);
                  return canvas.getContext('2d');
          }
  }

---

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

---

(C) Æliens 20/2/2008

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.