#

API Documentation for: NEXT
Show: Inherited Protected Private Deprecated

# File:easeljs\display\Shadow.js

    /*
    * Shadow
    * 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:
    	/**
    	 * This class encapsulates the properties required to define a shadow to apply to a {{#crossLink "DisplayObject"}}{{/crossLink}}
    	 * via its <code>shadow</code> property.
    	 *
    	 * <h4>Example</h4>
    	 *
    	 *      myImage.shadow = new createjs.Shadow("#000000", 5, 5, 10);
    	 *
    	 * @class Shadow
    	 * @constructor
    	 * @param {String} color The color of the shadow. This can be any valid CSS color value.
    	 * @param {Number} offsetX The x offset of the shadow in pixels.
    	 * @param {Number} offsetY The y offset of the shadow in pixels.
    	 * @param {Number} blur The size of the blurring effect.
    	 **/
    	function Shadow(color, offsetX, offsetY, blur) {

    	// public properties:
    		/**
    		 * The color of the shadow. This can be any valid CSS color value.
    		 * @property color
    		 * @type String
    		 * @default null
    		 */
    		this.color = color||"black";

    		/** The x offset of the shadow.
    		 * @property offsetX
    		 * @type Number
    		 * @default 0
    		 */
    		this.offsetX = offsetX||0;

    		/** The y offset of the shadow.
    		 * @property offsetY
    		 * @type Number
    		 * @default 0
    		 */
    		this.offsetY = offsetY||0;

    		/** The blur of the shadow.
    		 * @property blur
    		 * @type Number
    		 * @default 0
    		 */
    		this.blur = blur||0;
    	}
    	var p = Shadow.prototype;

    	/**
    	 * <strong>REMOVED</strong>. Removed in favor of using `MySuperClass_constructor`.
    	 * See {{#crossLink "Utility Methods/extend"}}{{/crossLink}} and {{#crossLink "Utility Methods/promote"}}{{/crossLink}}
    	 * for details.
    	 *
    	 * There is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.
    	 *
    	 * @method initialize
    	 * @protected
    	 * @deprecated
    	 */
    	// p.initialize = function() {}; // searchable for devs wondering where it is.

    // static public properties:
    	/**
    	 * An identity shadow object (all properties are set to 0).
    	 * @property identity
    	 * @type Shadow
    	 * @static
    	 * @final
    	 * @readonly
    	 **/
    	Shadow.identity = new Shadow("transparent", 0, 0, 0);

    // public methods:
    	/**
    	 * Returns a string representation of this object.
    	 * @method toString
    	 * @return {String} a string representation of the instance.
    	 **/
    	p.toString = function() {
    		return "[Shadow]";
    	};

    	/**
    	 * Returns a clone of this Shadow instance.
    	 * @method clone
    	 * @return {Shadow} A clone of the current Shadow instance.
    	 **/
    	p.clone = function() {
    		return new Shadow(this.color, this.offsetX, this.offsetY, this.blur);
    	};

    	createjs.Shadow = Shadow;
    }());