/*

Copyright (c) 2009, Yahoo! Inc. All rights reserved.

Code licensed under the BSD License:

http://developer.yahoo.net/yui/license.txt

version: 3.0.0b1

build: 1163

*/

YUI.add('event-simulate', function(Y) {

(function() {

/**

 * Synthetic DOM events

 * @module event-simulate

 */

//shortcuts

var L   = Y.Lang,

    array       = Y.Array,

    isFunction  = L.isFunction,

    isString    = L.isString,

    isBoolean   = L.isBoolean,

    isObject    = L.isObject,

    isNumber    = L.isNumber,

    doc         = Y.config.doc,

    //mouse events supported

    mouseEvents = {

        click:      1,

        dblclick:   1,

        mouseover:  1,

        mouseout:   1,

        mousedown:  1,

        mouseup:    1,

        mousemove:  1

    },

    //key events supported

    keyEvents   = {

        keydown:    1,

        keyup:      1,

        keypress:   1

    };

/*

 * Note: Intentionally not for YUIDoc generation.

 * Simulates a key event using the given event information to populate

 * the generated event object. This method does browser-equalizing

 * calculations to account for differences in the DOM and IE event models

 * as well as different browser quirks. Note: keydown causes Safari 2.x to

 * crash.

 * @method simulateKeyEvent

 * @private

 * @static

 * @param {HTMLElement} target The target of the given event.

 * @param {String} type The type of event to fire. This can be any one of

 *      the following: keyup, keydown, and keypress.

 * @param {Boolean} bubbles (Optional) Indicates if the event can be

 *      bubbled up. DOM Level 3 specifies that all key events bubble by

 *      default. The default is true.

 * @param {Boolean} cancelable (Optional) Indicates if the event can be

 *      canceled using preventDefault(). DOM Level 3 specifies that all

 *      key events can be cancelled. The default 

 *      is true.

 * @param {Window} view (Optional) The view containing the target. This is

 *      typically the window object. The default is window.

 * @param {Boolean} ctrlKey (Optional) Indicates if one of the CTRL keys

 *      is pressed while the event is firing. The default is false.

 * @param {Boolean} altKey (Optional) Indicates if one of the ALT keys

 *      is pressed while the event is firing. The default is false.

 * @param {Boolean} shiftKey (Optional) Indicates if one of the SHIFT keys

 *      is pressed while the event is firing. The default is false.

 * @param {Boolean} metaKey (Optional) Indicates if one of the META keys

 *      is pressed while the event is firing. The default is false.

 * @param {int} keyCode (Optional) The code for the key that is in use. 

 *      The default is 0.

 * @param {int} charCode (Optional) The Unicode code for the character

 *      associated with the key being used. The default is 0.

 */

function simulateKeyEvent(target /*:HTMLElement*/, type /*:String*/, 

                             bubbles /*:Boolean*/,  cancelable /*:Boolean*/,    

                             view /*:Window*/,

                             ctrlKey /*:Boolean*/,    altKey /*:Boolean*/, 

                             shiftKey /*:Boolean*/,   metaKey /*:Boolean*/, 

                             keyCode /*:int*/,        charCode /*:int*/) /*:Void*/                             

{

    //check target    

    if (!target){

        Y.error("simulateKeyEvent(): Invalid target.");

    }

    //check event type

    if (isString(type)){

        type = type.toLowerCase();

        switch(type){

            case "textevent": //DOM Level 3

                type = "keypress";

                break;

            case "keyup":

            case "keydown":

            case "keypress":

                break;

            default:

                Y.error("simulateKeyEvent(): Event type '" + type + "' not supported.");

        }

    } else {

        Y.error("simulateKeyEvent(): Event type must be a string.");

    }

    //setup default values

    if (!isBoolean(bubbles)){

        bubbles = true; //all key events bubble

    }

    if (!isBoolean(cancelable)){

        cancelable = true; //all key events can be cancelled

    }

    if (!isObject(view)){

        view = window; //view is typically window

    }

    if (!isBoolean(ctrlKey)){

        ctrlKey = false;

    }

    if (!isBoolean(altKey)){

        altKey = false;

    }

    if (!isBoolean(shiftKey)){

        shiftKey = false;

    }

    if (!isBoolean(metaKey)){

        metaKey = false;

    }

    if (!isNumber(keyCode)){

        keyCode = 0;

    }

    if (!isNumber(charCode)){

        charCode = 0; 

    }

    //try to create a mouse event

    var customEvent /*:MouseEvent*/ = null;

    //check for DOM-compliant browsers first

    if (isFunction(doc.createEvent)){

        try {

            //try to create key event

            customEvent = doc.createEvent("KeyEvents");

            /*

             * Interesting problem: Firefox implemented a non-standard

             * version of initKeyEvent() based on DOM Level 2 specs.

             * Key event was removed from DOM Level 2 and re-introduced

             * in DOM Level 3 with a different interface. Firefox is the

             * only browser with any implementation of Key Events, so for

             * now, assume it's Firefox if the above line doesn't error.

             */

            // @TODO: Decipher between Firefox's implementation and a correct one.

            customEvent.initKeyEvent(type, bubbles, cancelable, view, ctrlKey,

                altKey, shiftKey, metaKey, keyCode, charCode);       

        } catch (ex /*:Error*/){

            /*

             * If it got here, that means key events aren't officially supported. 

             * Safari/WebKit is a real problem now. WebKit 522 won't let you

             * set keyCode, charCode, or other properties if you use a

             * UIEvent, so we first must try to create a generic event. The

             * fun part is that this will throw an error on Safari 2.x. The

             * end result is that we need another try...catch statement just to

             * deal with this mess.

             */

            try {

                //try to create generic event - will fail in Safari 2.x

                customEvent = doc.createEvent("Events");

            } catch (uierror /*:Error*/){

                //the above failed, so create a UIEvent for Safari 2.x

                customEvent = doc.createEvent("UIEvents");

            } finally {

                customEvent.initEvent(type, bubbles, cancelable);

                //initialize

                customEvent.view = view;

                customEvent.altKey = altKey;

                customEvent.ctrlKey = ctrlKey;

                customEvent.shiftKey = shiftKey;

                customEvent.metaKey = metaKey;

                customEvent.keyCode = keyCode;

                customEvent.charCode = charCode;

            }          

        }

        //fire the event

        target.dispatchEvent(customEvent);

    } else if (isObject(doc.createEventObject)){ //IE

        //create an IE event object

        customEvent = doc.createEventObject();

        //assign available properties

        customEvent.bubbles = bubbles;

        customEvent.cancelable = cancelable;

        customEvent.view = view;

        customEvent.ctrlKey = ctrlKey;

        customEvent.altKey = altKey;

        customEvent.shiftKey = shiftKey;

        customEvent.metaKey = metaKey;

        /*

         * IE doesn't support charCode explicitly. CharCode should

         * take precedence over any keyCode value for accurate

         * representation.

         */

        customEvent.keyCode = (charCode > 0) ? charCode : keyCode;

        //fire the event

        target.fireEvent("on" + type, customEvent);  

    } else {

        Y.error("simulateKeyEvent(): No event simulation framework present.");

    }

}

/*

 * Note: Intentionally not for YUIDoc generation.

 * Simulates a mouse event using the given event information to populate

 * the generated event object. This method does browser-equalizing

 * calculations to account for differences in the DOM and IE event models

 * as well as different browser quirks.

 * @method simulateMouseEvent

 * @private

 * @static

 * @param {HTMLElement} target The target of the given event.

 * @param {String} type The type of event to fire. This can be any one of

 *      the following: click, dblclick, mousedown, mouseup, mouseout,

 *      mouseover, and mousemove.

 * @param {Boolean} bubbles (Optional) Indicates if the event can be

 *      bubbled up. DOM Level 2 specifies that all mouse events bubble by

 *      default. The default is true.

 * @param {Boolean} cancelable (Optional) Indicates if the event can be

 *      canceled using preventDefault(). DOM Level 2 specifies that all

 *      mouse events except mousemove can be cancelled. The default 

 *      is true for all events except mousemove, for which the default 

 *      is false.

 * @param {Window} view (Optional) The view containing the target. This is

 *      typically the window object. The default is window.

 * @param {int} detail (Optional) The number of times the mouse button has

 *      been used. The default value is 1.

 * @param {int} screenX (Optional) The x-coordinate on the screen at which

 *      point the event occured. The default is 0.

 * @param {int} screenY (Optional) The y-coordinate on the screen at which

 *      point the event occured. The default is 0.

 * @param {int} clientX (Optional) The x-coordinate on the client at which

 *      point the event occured. The default is 0.

 * @param {int} clientY (Optional) The y-coordinate on the client at which

 *      point the event occured. The default is 0.

 * @param {Boolean} ctrlKey (Optional) Indicates if one of the CTRL keys

 *      is pressed while the event is firing. The default is false.

 * @param {Boolean} altKey (Optional) Indicates if one of the ALT keys

 *      is pressed while the event is firing. The default is false.

 * @param {Boolean} shiftKey (Optional) Indicates if one of the SHIFT keys

 *      is pressed while the event is firing. The default is false.

 * @param {Boolean} metaKey (Optional) Indicates if one of the META keys

 *      is pressed while the event is firing. The default is false.

 * @param {int} button (Optional) The button being pressed while the event

 *      is executing. The value should be 0 for the primary mouse button

 *      (typically the left button), 1 for the terciary mouse button

 *      (typically the middle button), and 2 for the secondary mouse button

 *      (typically the right button). The default is 0.

 * @param {HTMLElement} relatedTarget (Optional) For mouseout events,

 *      this is the element that the mouse has moved to. For mouseover

 *      events, this is the element that the mouse has moved from. This

 *      argument is ignored for all other events. The default is null.

 */

function simulateMouseEvent(target /*:HTMLElement*/, type /*:String*/, 

                               bubbles /*:Boolean*/,  cancelable /*:Boolean*/,    

                               view /*:Window*/,        detail /*:int*/, 

                               screenX /*:int*/,        screenY /*:int*/, 

                               clientX /*:int*/,        clientY /*:int*/,       

                               ctrlKey /*:Boolean*/,    altKey /*:Boolean*/, 

                               shiftKey /*:Boolean*/,   metaKey /*:Boolean*/, 

                               button /*:int*/,         relatedTarget /*:HTMLElement*/) /*:Void*/

{

    //check target   

    if (!target){

        Y.error("simulateMouseEvent(): Invalid target.");

    }

    //check event type

    if (isString(type)){

        type = type.toLowerCase();

        //make sure it's a supported mouse event

        if (!mouseEvents[type]){

            Y.error("simulateMouseEvent(): Event type '" + type + "' not supported.");

        }

    } else {

        Y.error("simulateMouseEvent(): Event type must be a string.");

    }

    //setup default values

    if (!isBoolean(bubbles)){

        bubbles = true; //all mouse events bubble

    }

    if (!isBoolean(cancelable)){

        cancelable = (type != "mousemove"); //mousemove is the only one that can't be cancelled

    }

    if (!isObject(view)){

        view = window; //view is typically window

    }

    if (!isNumber(detail)){

        detail = 1;  //number of mouse clicks must be at least one

    }

    if (!isNumber(screenX)){

        screenX = 0; 

    }

    if (!isNumber(screenY)){

        screenY = 0; 

    }

    if (!isNumber(clientX)){

        clientX = 0; 

    }

    if (!isNumber(clientY)){

        clientY = 0; 

    }

    if (!isBoolean(ctrlKey)){

        ctrlKey = false;

    }

    if (!isBoolean(altKey)){

        altKey = false;

    }

    if (!isBoolean(shiftKey)){

        shiftKey = false;

    }

    if (!isBoolean(metaKey)){

        metaKey = false;

    }

    if (!isNumber(button)){

        button = 0; 

    }

    //try to create a mouse event

    var customEvent /*:MouseEvent*/ = null;

    //check for DOM-compliant browsers first

    if (isFunction(doc.createEvent)){

        customEvent = doc.createEvent("MouseEvents");

        //Safari 2.x (WebKit 418) still doesn't implement initMouseEvent()

        if (customEvent.initMouseEvent){

            customEvent.initMouseEvent(type, bubbles, cancelable, view, detail,

                                 screenX, screenY, clientX, clientY, 

                                 ctrlKey, altKey, shiftKey, metaKey, 

                                 button, relatedTarget);

        } else { //Safari

            //the closest thing available in Safari 2.x is UIEvents

            customEvent = doc.createEvent("UIEvents");

            customEvent.initEvent(type, bubbles, cancelable);

            customEvent.view = view;

            customEvent.detail = detail;

            customEvent.screenX = screenX;

            customEvent.screenY = screenY;

            customEvent.clientX = clientX;

            customEvent.clientY = clientY;

            customEvent.ctrlKey = ctrlKey;

            customEvent.altKey = altKey;

            customEvent.metaKey = metaKey;

            customEvent.shiftKey = shiftKey;

            customEvent.button = button;

            customEvent.relatedTarget = relatedTarget;

        }

        /*

         * Check to see if relatedTarget has been assigned. Firefox

         * versions less than 2.0 don't allow it to be assigned via

         * initMouseEvent() and the property is readonly after event

         * creation, so in order to keep YAHOO.util.getRelatedTarget()

         * working, assign to the IE proprietary toElement property

         * for mouseout event and fromElement property for mouseover

         * event.

         */

        if (relatedTarget && !customEvent.relatedTarget){

            if (type == "mouseout"){

                customEvent.toElement = relatedTarget;

            } else if (type == "mouseover"){

                customEvent.fromElement = relatedTarget;

            }

        }

        //fire the event

        target.dispatchEvent(customEvent);

    } else if (isObject(doc.createEventObject)){ //IE

        //create an IE event object

        customEvent = doc.createEventObject();

        //assign available properties