Further accessibility improvements regarding keyboard navigation and docume...

Thomas Bruederli

2014-05-07 b2992dd2283c3d0ac95f3293497dfaed0493f607

 program/js/common.js

@@ -1,18 +1,30 @@
/*
 +-----------------------------------------------------------------------+
 | Roundcube common js library                                           |
 |                                                                       |
 | This file is part of the Roundcube web development suite              |
 | Copyright (C) 2005-2012, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
 | See the README file for a full license statement.                     |
 |                                                                       |
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+
*/
/**
 * Roundcube common js library
 *
 * This file is part of the Roundcube Webmail client
 *
 * @licstart  The following is the entire license notice for the
 * JavaScript code in this file.
 *
 * Copyright (c) 2005-2014, The Roundcube Dev Team
 *
 * The JavaScript code in this page is free software: you can
 * redistribute it and/or modify it under the terms of the GNU
 * General Public License (GNU GPL) as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option)
 * any later version.  The code is distributed WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
 *
 * As additional permission under GNU GPL version 3 section 7, you
 * may distribute non-source (e.g., minimized or compacted) forms of
 * that code without the copy of the GNU GPL normally required by
 * section 4, provided you include this license notice and a URL
 * through which recipients can access the Corresponding Source.
 *
 * @licend  The above is the entire license notice
 * for the JavaScript code in this file.
 */

// Constants
var CONTROL_KEY = 1;
@@ -49,28 +61,30 @@
  this.dom = document.getElementById ? true : false;
  this.dom2 = document.addEventListener && document.removeEventListener;

  this.webkit = this.agent_lc.indexOf('applewebkit') > 0;
  this.ie = (document.all && !window.opera) || (this.win && this.agent_lc.indexOf('trident/') > 0);

  if (this.ie) {
    this.ie6 = this.appver.indexOf('MSIE 6') > 0;
    this.ie7 = this.appver.indexOf('MSIE 7') > 0;
    this.ie8 = this.appver.indexOf('MSIE 8') > 0;
    this.ie9 = this.appver.indexOf('MSIE 9') > 0;
  }
  else if (window.opera) {
    this.opera = true;
    this.vendver = opera.version();
  }
  else {
    this.chrome = this.agent_lc.indexOf('chrome') > 0;
    this.safari = !this.chrome && (this.agent_lc.indexOf('safari') > 0 || this.agent_lc.indexOf('applewebkit') > 0);
    this.safari = !this.chrome && (this.webkit || this.agent_lc.indexOf('safari') > 0);
    this.konq = this.agent_lc.indexOf('konqueror') > 0;
    this.mz = this.dom && !this.chrome && !this.safari && !this.konq && this.agent.indexOf('Mozilla') >= 0;
    this.iphone = this.safari && (this.agent_lc.indexOf('iphone') > 0 || this.agent_lc.indexOf('ipod') > 0);
    this.ipad = this.safari && this.agent_lc.indexOf('ipad') > 0;
    this.opera = window.opera ? true : false;
    this.webkit = this.safari || this.chrome;
  }

  if (!this.vendver) {
    // common version strings
    this.vendver = /(khtml|chrome|safari|applewebkit|opera|msie)(\s|\/)([0-9\.]+)/.test(this.agent_lc) ? parseFloat(RegExp.$3) : 0;
    this.vendver = /(opera|opr|khtml|chrome|safari|applewebkit|msie)(\s|\/)([0-9\.]+)/.test(this.agent_lc) ? parseFloat(RegExp.$3) : 0;

    // any other (Mozilla, Camino, IE>=11)
    if (!this.vendver)
@@ -117,7 +131,7 @@
      classname += ' iphone';
    else if (this.ipad)
      classname += ' ipad';
    else if (this.safari || this.chrome)
    else if (this.webkit)
      classname += ' webkit';

    if (this.mobile)
@@ -253,14 +267,38 @@
cancel: function(evt)
{
  var e = evt ? evt : window.event;

  if (e.preventDefault)
    e.preventDefault();
  else
    e.returnValue = false;

  if (e.stopPropagation)
    e.stopPropagation();

  e.cancelBubble = true;
  e.returnValue = false;

  return false;
},

/**
 * Determine whether the given event was trigered from keyboard
 */
is_keyboard: function(e)
{
  return e && (
      (e.mozInputSource && e.mozInputSource == e.MOZ_SOURCE_KEYBOARD) ||
      (!e.pageX && (e.pageY || 0) <= 0 && !e.clientX && (e.clientY || 0) <= 0)
    );
},

/**
 * Accept event if triggered from keyboard action (e.g. <Enter>)
 */
keyboard_only: function(e)
{
  console.log(e);
  return rcube_event.is_keyboard(e) ? true : rcube_event.cancel(e);
},

touchevent: function(e)
@@ -324,13 +362,17 @@
triggerEvent: function(evt, e)
{
  var ret, h;

  if (e === undefined)
    e = this;
  else if (typeof e === 'object')
    e.event = evt;

  if (this._events && this._events[evt] && !this._event_exec) {
    this._event_exec = true;
  if (!this._event_exec)
    this._event_exec = {};

  if (this._events && this._events[evt] && !this._event_exec[evt]) {
    this._event_exec[evt] = true;
    for (var i=0; i < this._events[evt].length; i++) {
      if ((h = this._events[evt][i])) {
        if (typeof h.func === 'function')
@@ -353,7 +395,8 @@
    }
  }

  this._event_exec = false;
  delete this._event_exec[evt];

  if (e.event) {
    try {
      delete e.event;
@@ -527,36 +570,6 @@
roundcube_browser.prototype.set_cookie = setCookie;
roundcube_browser.prototype.get_cookie = getCookie;

// tiny replacement for Firebox functionality
function rcube_console()
{
  this.log = function(msg)
  {
    var box = rcube_find_object('dbgconsole');

    if (box) {
      if (msg.charAt(msg.length-1)=='\n')
        msg += '--------------------------------------\n';
      else
        msg += '\n--------------------------------------\n';

      // Konqueror doesn't allow to just change the value of hidden element
      if (bw.konq) {
        box.innerText += msg;
        box.value = box.innerText;
      } else
        box.value += msg;
    }
  };

  this.reset = function()
  {
    var box = rcube_find_object('dbgconsole');
    if (box)
      box.innerText = box.value = '';
  };
};

var bw = new roundcube_browser();
bw.set_html_class();

@@ -592,20 +605,6 @@
    position = position || 0;
    return this.slice(position, search.length) === search;
  };
}

// Make getElementById() case-sensitive on IE
if (bw.ie) {
  document._getElementById = document.getElementById;
  document.getElementById = function(id) {
    var i = 0, obj = document._getElementById(id);

    if (obj && obj.id != id)
      while ((obj = document.all[i]) && obj.id != id)
        i++;

    return obj;
  }
}

// jQuery plugin to emulate HTML5 placeholder attributes on input elements