#

API Documentation for: 0.8.1
Show: Inherited Protected Private Deprecated

# File:MouseEvent.js

    /*
    * MouseEvent
    * Visit http://createjs.com/ for documentation, updates and examples.
    *
    * Copyright (c) 2010 gskinner.com, inc.
    *
    * 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.
    */

    /**
     * @module EaselJS
     */

    // namespace:
    //this.createjs = this.createjs||{};

    (function() {
    	"use strict";

    // constructor:
    	/**
    	 * Passed as the parameter to all mouse/pointer/touch related events. For a listing of mouse events and their properties,
    	 * see the {{#crossLink "DisplayObject"}}{{/crossLink}} and {{#crossLink "Stage"}}{{/crossLink}} event listings.
    	 * @class MouseEvent
    	 * @param {String} type The event type.
    	 * @param {Boolean} bubbles Indicates whether the event will bubble through the display list.
    	 * @param {Boolean} cancelable Indicates whether the default behaviour of this event can be cancelled.
    	 * @param {Number} stageX The normalized x position relative to the stage.
    	 * @param {Number} stageY The normalized y position relative to the stage.
    	 * @param {MouseEvent} nativeEvent The native DOM event related to this mouse event.
    	 * @param {Number} pointerID The unique id for the pointer.
    	 * @param {Boolean} primary Indicates whether this is the primary pointer in a multitouch environment.
    	 * @param {Number} rawX The raw x position relative to the stage.
    	 * @param {Number} rawY The raw y position relative to the stage.
    	 * @param {DisplayObject} relatedTarget The secondary target for the event.
    	 * @extends Event
    	 * @constructor
    	 **/
    	function MouseEvent(type, bubbles, cancelable, stageX, stageY, nativeEvent, pointerID, primary, rawX, rawY, relatedTarget) {
    		this.Event_constructor(type, bubbles, cancelable);

    	// public properties:
    		/**
    		 * The normalized x position on the stage. This will always be within the range 0 to stage width.
    		 * @property stageX
    		 * @type Number
    		*/
    		this.stageX = stageX;

    		/**
    		 * The normalized y position on the stage. This will always be within the range 0 to stage height.
    		 * @property stageY
    		 * @type Number
    		 **/
    		this.stageY = stageY;

    		/**
    		 * The raw x position relative to the stage. Normally this will be the same as the stageX value, unless
    		 * stage.mouseMoveOutside is true and the pointer is outside of the stage bounds.
    		 * @property rawX
    		 * @type Number
    		*/
    		this.rawX = (rawX==null)?stageX:rawX;

    		/**
    		 * The raw y position relative to the stage. Normally this will be the same as the stageY value, unless
    		 * stage.mouseMoveOutside is true and the pointer is outside of the stage bounds.
    		 * @property rawY
    		 * @type Number
    		*/
    		this.rawY = (rawY==null)?stageY:rawY;

    		/**
    		 * The native MouseEvent generated by the browser. The properties and API for this
    		 * event may differ between browsers. This property will be null if the
    		 * EaselJS property was not directly generated from a native MouseEvent.
    		 * @property nativeEvent
    		 * @type HtmlMouseEvent
    		 * @default null
    		 **/
    		this.nativeEvent = nativeEvent;

    		/**
    		 * The unique id for the pointer (touch point or cursor). This will be either -1 for the mouse, or the system
    		 * supplied id value.
    		 * @property pointerID
    		 * @type {Number}
    		 */
    		this.pointerID = pointerID;

    		/**
    		 * Indicates whether this is the primary pointer in a multitouch environment. This will always be true for the mouse.
    		 * For touch pointers, the first pointer in the current stack will be considered the primary pointer.
    		 * @property primary
    		 * @type {Boolean}
    		 */
    		this.primary = !!primary;

    		/**
    		 * The secondary target for the event, if applicable. This is used for mouseout/rollout
    		 * events to indicate the object that the mouse entered from, mouseover/rollover for the object the mouse exited,
    		 * and stagemousedown/stagemouseup events for the object that was the under the cursor, if any.
    		 *
    		 * Only valid interaction targets will be returned (ie. objects with mouse listeners or a cursor set).
    		 * @property relatedTarget
    		 * @type {DisplayObject}
    		 */
    		this.relatedTarget = relatedTarget;
    	}
    	var p = createjs.extend(MouseEvent, createjs.Event);

    	// TODO: deprecated
    	// p.initialize = function() {}; // searchable for devs wondering where it is. REMOVED. See docs for details.

    // getter / setters:
    	/**
    	 * Returns the x position of the mouse in the local coordinate system of the current target (ie. the dispatcher).
    	 * @property localX
    	 * @type {Number}
    	 * @readonly
    	 */
    	p._get_localX = function() {
    		return this.currentTarget.globalToLocal(this.rawX, this.rawY).x;
    	};

    	/**
    	 * Returns the y position of the mouse in the local coordinate system of the current target (ie. the dispatcher).
    	 * @property localY
    	 * @type {Number}
    	 * @readonly
    	 */
    	p._get_localY = function() {
    		return this.currentTarget.globalToLocal(this.rawX, this.rawY).y;
    	};

    	/**
    	 * Indicates whether the event was generated by a touch input (versus a mouse input).
    	 * @property isTouch
    	 * @type {Boolean}
    	 * @readonly
    	 */
    	p._get_isTouch = function() {
    		return this.pointerID !== -1;
    	};

    	try {
    		Object.defineProperties(p, {
    			localX: { get: p._get_localX },
    			localY: { get: p._get_localY },
    			isTouch: { get: p._get_isTouch }
    		});
    	} catch (e) {} // TODO: use Log

    // public methods:
    	/**
    	 * Returns a clone of the MouseEvent instance.
    	 * @method clone
    	 * @return {MouseEvent} a clone of the MouseEvent instance.
    	 **/
    	p.clone = function() {
    		return new MouseEvent(this.type, this.bubbles, this.cancelable, this.stageX, this.stageY, this.nativeEvent, this.pointerID, this.primary, this.rawX, this.rawY);
    	};

    	/**
    	 * Returns a string representation of this object.
    	 * @method toString
    	 * @return {String} a string representation of the instance.
    	 **/
    	p.toString = function() {
    		return "[MouseEvent (type="+this.type+" stageX="+this.stageX+" stageY="+this.stageY+")]";
    	};

    	createjs.MouseEvent = createjs.promote(MouseEvent, "Event");
    }());