@oat-sa/tao-core-sdk/src/core/mouseEvent.js

Core libraries of TAO

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2016-2019 (original work) Open Assessment Technologies SA ;
 */
/**
 * Creates and triggers a mouseEvent
 * Deprecated method initMouseEvent is mainly used for current (2.1) PhantomJS compatibility
 *
 * @example triggerMouseEvent(
 *      document.getElementById('#button'),
 *      'click',
 *      {
 *          bubbles: true,
 *          cancelable: true
 *      }
 * );
 *
 * @author Jean-Sébastien Conan <jean-sebastien.conan@vesperiagroup.com>
 * @author Christophe Noël <christophe@taotesting.com>
 */

var dispatchEvent;
var allowedEvents = [
    'click',
    'contextmenu',
    'dblclick',
    'mousedown',
    'mouseenter',
    'mouseleave',
    'mousemove',
    'mouseout',
    'mouseover',
    'mouseup',
    'show'
];

/**
 * Creates an event (requires IE > 9)
 * @param {String} eventName
 * @param {*} eventOptions
 * @returns {Event}
 */
var createEvent = function createEvent(eventName, eventOptions) {
    var event;
    try {
        event = new MouseEvent(eventName, eventOptions);
    } catch (e) {
        event = document.createEvent('MouseEvents');
        event.initMouseEvent(
            eventName,
            eventOptions.bubbles || false,
            eventOptions.cancelable || false,
            eventOptions.view || null,
            eventOptions.detail || 0,
            eventOptions.screenX || 0,
            eventOptions.screenY || 0,
            eventOptions.clientX || 0,
            eventOptions.clientY || 0,
            eventOptions.ctrlKey || false,
            eventOptions.altKey || false,
            eventOptions.shiftKey || false,
            eventOptions.metaKey || false,
            eventOptions.button || 0,
            eventOptions.relatedTarget || null
        );
    }
    return event;
};

/**
 * Dispatches an event
 * @param {HTMLElement} element
 * @param {String} eventName
 * @param {Event} event
 * @returns {Boolean} Returns `true` if the event has been dispatched
 */
if (document.dispatchEvent) {
    dispatchEvent = function dispatchEventUsingDispatchEvent(element, eventName, event) {
        if (element) {
            element.dispatchEvent(event);
            return true;
        }
        return false;
    };
} else if (document.fireEvent) {
    dispatchEvent = function dispatchEventUsingFireEvent(element, eventName, event) {
        if (element) {
            element.fireEvent(`on${eventName}`, event);
            return true;
        }
        return false;
    };
} else {
    dispatchEvent = function dispatchEventDummy() {
        return false;
    };
}

/**
 * Triggers a mouse event using native methods
 * @param {HTMLElement} element
 * @param {String} eventName
 * @param {Object} eventOptions https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent
 * @returns {Boolean} Returns true if the event has been successfully triggered
 */
export default function triggerMouseEvent(element, eventName, eventOptions) {
    var event;

    if (allowedEvents.indexOf(eventName) === -1) {
        return false;
    }
    event = createEvent(eventName, eventOptions);
    return dispatchEvent(element, eventName, event);
}