topical media & game development

topical media & game development

[] 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) _

mobile-graphic-easel-src-easeljs-events-MouseEvent.js / 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.
  */
  
  // namespace:
  this.createjs = this.createjs||{};
  
  (function() {

This is passed as the parameter to mousedown, mouseup, mousemove, stagemouseup, stagemousedown, mouseover, mouseout and click events on {{#crossLink "DisplayObject"}}{{/crossLink}} instances. @class MouseEvent @uses EventDispatcher @constructor
parameter: {String} type The event type.
parameter: {Number} stageX The normalized x position relative to the stage.
parameter: {Number} stageY The normalized y position relative to the stage.
parameter: {DisplayObject} target The display object this event relates to. Note that this will be overwritten when the event is dispatched via EventDispatcher.
parameter: {MouseEvent} nativeEvent The native DOM event related to this mouse event.
parameter: {Number} pointerID The unique id for the pointer.
parameter: {Boolean} primary Indicates whether this is the primary pointer in a multitouch environment.
parameter: {Number} rawX The raw x position relative to the stage.
parameter: {Number} rawY The raw y position relative to the stage.


  
  var MouseEvent = function(type, stageX, stageY, target, nativeEvent, pointerID, primary, rawX, rawY) {
    this.initialize(type, stageX, stageY, target, nativeEvent, pointerID, primary, rawX, rawY);
  }
  var p = MouseEvent.prototype;
  
  // events:

For MouseEvent objects of type "mousedown", mousemove events will be dispatched from the event object until the user releases the mouse anywhere. This enables you to listen to mouse move interactions for the duration of a press, which can be very useful for operations such as drag and drop. See the {{#crossLink "MouseEvent"}}{{/crossLink}} class for a listing of event properties. @event mousemove @since 0.6.0

For MouseEvent objects of type "mousedown", a mouseup event will be dispatched from the event object when the user releases the mouse anywhere. This enables you to listen for a corresponding mouse up from a specific press, which can be very useful for operations such as drag and drop. See the {{#crossLink "MouseEvent"}}{{/crossLink}} class for a listing of event properties. @event mouseup @since 0.6.0


  
  
  // public properties:

The normalized x position on the stage. This will always be within the range 0 to stage width. @property stageX @type Number


  
          p.stageX = 0;

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


  
          p.stageY = 0;

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


  
          p.rawX = 0;

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


  
          p.rawY = 0;

The type of mouse event. This will be the same as the handler it maps to (onPress, onMouseDown, onMouseUp, onMouseMove, or onClick). @property type @type String


  
          p.type = null;

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 MouseEvent @default null


  
          p.nativeEvent = null;

For events of type "onPress" only you can assign a handler to the onMouseMove property. This handler will be called every time the mouse is moved until the mouse is released. This is useful for operations such as drag and drop. @property onMouseMove @type Function @deprecated In favour of the "mousemove" event. Will be removed in a future version.


  
          p.onMouseMove = null;

For events of type "onPress" only you can assign a handler to the onMouseUp property. This handler will be called every time the mouse is moved until the mouse is released. This is useful for operations such as drag and drop. @property onMouseUp @type Function @deprecated In favour of the "mouseup" event. Will be removed in a future version.


  
          p.onMouseUp = null;

The display object this event relates to. @property target @type DisplayObject @default null


  
          p.target = null;

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}


  
          p.pointerID = 0;

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}


  
          p.primary = false;
          
          
  // mix-ins:
          // EventDispatcher methods:
          p.addEventListener = null;
          p.removeEventListener = null;
          p.removeAllEventListeners = null;
          p.dispatchEvent = null;
          p.hasEventListener = null;
          p._listeners = null;
          createjs.EventDispatcher.initialize(p); // inject EventDispatcher methods.
  
  // constructor:

Initialization method. @method initialize @protected


  
          p.initialize = function(type, stageX, stageY, target, nativeEvent, pointerID, primary, rawX, rawY) {
                  this.type = type;
                  this.stageX = stageX;
                  this.stageY = stageY;
                  this.target = target;
                  this.nativeEvent = nativeEvent;
                  this.pointerID = pointerID;
                  this.primary = primary;
                  this.rawX = (rawX==null)?stageX:rawX;
                  this.rawY = (rawY==null)?stageY:rawY;
          }
  
  // public methods:

Returns a clone of the MouseEvent instance. @method clone
returns: {MouseEvent} a clone of the MouseEvent instance.


  
          p.clone = function() {
                  return new MouseEvent(this.type, this.stageX, this.stageY, this.target, this.nativeEvent, this.pointerID, this.primary, this.rawX, this.rawY);
          }

Returns a string representation of this object. @method toString
returns: {String} a string representation of the instance.


  
          p.toString = function() {
                  return "[MouseEvent (type="+this.type+" stageX="+this.stageX+" stageY="+this.stageY+")]";
          }
  
  createjs.MouseEvent = MouseEvent;
  }());

[] 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) _

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.