js/util.js

   1 // coding: utf-8
   2 // Copyright 2008 Grégory Burri
   3 //
   4 // This file is part of Euphorik.
   5 //
   6 // Euphorik is free software: you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation, either version 3 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // Euphorik is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 /*jslint laxbreak:true */
  20
  21 /**
  22   * This object brings some utility functions.
  23   *  - Print a message box to display some information for the user.
  24   *  - Set a tooltip for a HTML element.
  25   *  - Some text manipulation for input area.
  26   * @formater An object for string format
  27   */
  28 euphorik.Util = function (formater) {
  29    $("#info .close").click(function() {
  30       $("#info").slideUp(50);
  31    });
  32
  33    $("body").append('<div id="tooltipArrow"></div>').append('<div id="tooltipMessage"><p></p></div>');
  34
  35    this.formater = formater;
  36    this.bulleActive = true;
  37 };
  38
  39 euphorik.Util.messageType = {informatif: 0, question: 1, erreur: 2};
  40
  41 /**
  42   * Display a message box.
  43   * @message [String] The message.
  44   * @type [euphorik.Util.messageType] The message type like 'information' or 'error'. Default is messageType.informatif.
  45   * @buttons An object where the properties are the labels and the values are functions which will be executed when a button is clicked.
  46   * @format [bool] The message should be formated. (see 'formater.js')
  47   * @time The time while the message is displayed. -1 for infinity.
  48   */
  49 euphorik.Util.prototype.messageDialog = function(message, type, buttons, format, time) {
  50    var thisUtil = this;
  51
  52    type = type || euphorik.Util.messageType.informatif;
  53    format = format === undefined ? true : format;
  54
  55    if (this.timeoutMessageDialog) {
  56       clearTimeout(this.timeoutMessageDialog);
  57    }
  58
  59    var close = function() { $("#info").slideUp(100); };
  60    close();
  61
  62    $("#info .message").html(!thisUtil.formater || !format ? message : thisUtil.formater.traitementComplet(message));
  63
  64    switch(type) {
  65       case euphorik.Util.messageType.informatif : $("#info #icone").attr("class", "information"); break;
  66       case euphorik.Util.messageType.question : $("#info #icone").attr("class", "interrogation"); break;
  67       case euphorik.Util.messageType.erreur : $("#info #icone").attr("class", "exclamation"); break;
  68    }
  69
  70    $("#info .buttons").html("");
  71    objectEach(buttons, function(nom, bouton) {
  72       $("#info .buttons").append("<div>" + nom + "</div>").find("div:last").click(bouton).click(close);
  73    });
  74
  75    $("#info").slideDown(200);
  76    if (time !== -1) {
  77       this.timeoutMessageDialog = setTimeout(close, time || euphorik.conf.tooltipDisplayDefaultTime);
  78    }
  79 };
  80
  81 euphorik.Util.positionTypeX = {gauche: 0, gaucheRecouvrement: 1, centre: 2, droiteRecouvrement: 3, droite: 4};
  82 euphorik.Util.positionTypeY = {haut: 0, hautRecouvrement: 1, centre: 2, basRecouvrement: 3, bas: 4};
  83
  84 /**
  85   * Afficher une boite flottante (élément) par rapport à une cible.
  86   * La boite est affichée de manière à ne pas dépasser de la fenêtre.
  87   * @boite l'élément à afficher
  88   * @cible l'élément sur lequel est affiché la boite
  89   * @positionX de type positionTypeX
  90   * @positionY de type positionTypeY
  91   */
  92 euphorik.Util.prototype.afficherBoite = function(boite, cible, positionX, positionY) {
  93     var positionCible = cible.offset();
  94     var positionBoite = {
  95          left : positionX === euphorik.Util.positionTypeX.gauche ? positionCible.left - boite.width() :
  96             (positionX === euphorik.Util.positionTypeX.gaucheRecouvrement ? positionCible.left - boite.width() + cible.width() :
  97             (positionX === euphorik.Util.positionTypeX.droitelsRecouvrement ? positionCible.left :
  98             (positionX === euphorik.Util.positionTypeX.droite ? positionCible.left + cible.width() :
  99             positionCible.left + cible.width() / 2 - boite.width() / 2 ))), // centre
 100          top : positionY === euphorik.Util.positionTypeY.haut ? positionCible.top - boite.height() :
 101             (positionY === euphorik.Util.positionTypeY.hautRecouvrement ? positionCible.top - boite.height() + cible.height() :
 102             (positionY === euphorik.Util.positionTypeY.basRecouvrement ? positionCible.top :
 103             (positionY === euphorik.Util.positionTypeY.bas ? positionCible.top + cible.height() :
 104             positionCible.top + cible.height() / 2 - boite.height() / 2 ))) // centre
 105       };
 106
 107     // calcul les décalages en x et en y pour éviter que la boite ne sorte de la fenêtre, tient compte de la position des barres de défilement
 108     var marge = 10;
 109     positionBoite.left = positionBoite.left < marge + window.pageXOffset ? marge + window.pageXOffset :
 110       (boite.width() - $(window).width() + (positionBoite.left - window.pageXOffset) + marge > 0 ? $(window).width() - boite.width() - marge + window.pageXOffset : positionBoite.left);
 111     positionBoite.top = positionBoite.top < marge + window.pageYOffset ? marge + window.pageYOffset :
 112       (boite.height() - $(window).height() + (positionBoite.top - window.pageYOffset) + marge > 0 ? $(window).height() - boite.height() - marge + window.pageYOffset : positionBoite.top);
 113
 114     boite.css("top", positionBoite.top).css("left", positionBoite.left).show();
 115 };
 116
 117 euphorik.Util.positionBulleType = {haut : 0, droite : 1, bas : 2, gauche : 3};
 118
 119 /**
 120   * Affiche ou cache la barre d'attente.
 121   */
 122 euphorik.Util.prototype.showWaitBar = function() {
 123    $("#waitbar").show();
 124 };
 125 euphorik.Util.prototype.hideWaitBar = function() {
 126    $("#waitbar").hide();
 127 };
 128
 129 /**
 130   * Affiche un info bulle lorsque le curseur survole l'élément donné.
 131   * @param message le message à afficher
 132   * @param element l'élément DOM sur lesquel afficher la bulle
 133   * @param la position de la bulle, voir positionBulleType. Par défaut à 0 (haut)
 134   */
 135 euphorik.Util.prototype.infoBulle = function(message, element, position) {
 136    var thisUtil = this;
 137    var cacherBulle = function() {
 138       $("#tooltipArrow").hide();
 139       $("#tooltipMessage").hide();
 140    };
 141
 142    position = position || euphorik.Util.positionBulleType.haut;
 143
 144    element.hover(
 145       function() {
 146          if (!thisUtil.bulleActive) {
 147             return;
 148          }
 149
 150          var m = $("#tooltipMessage");
 151          var f = $("#tooltipArrow");
 152          f.removeClass().addClass(position === euphorik.Util.positionBulleType.haut ? "tooltipArrowTop" :
 153             (position === euphorik.Util.positionBulleType.droite ? "tooltipArrowRight" :
 154             (position === euphorik.Util.positionBulleType.bas ? "tooltipArrowBottom" : "tooltipArrowLeft" )));
 155
 156          // remplie le paragraphe de la bulle avec le message
 157          $("p", m).html(message);
 158
 159          // réinitialise la position, évite le cas ou la boite est collé à droite et remplie avec un texte la faisant dépassé
 160          // dans ce cas la hauteur n'est pas calculé correctement
 161          m.css("top", 0).css("left", 0);
 162
 163          var positionFleche = {
 164             left : position === euphorik.Util.positionBulleType.haut || position === euphorik.Util.positionBulleType.bas ?
 165                 element.offset().left + element.outerWidth() / 2 - f.width() / 2 :
 166                 (position === euphorik.Util.positionBulleType.gauche ? element.offset().left - f.width() : element.offset().left + element.outerWidth()),
 167             top : position === euphorik.Util.positionBulleType.gauche || position === euphorik.Util.positionBulleType.droite ?
 168                 element.offset().top + element.outerHeight() / 2 - f.height() / 2 :
 169                 (position === euphorik.Util.positionBulleType.haut ? element.offset().top - f.height() : element.offset().top + element.outerHeight())
 170          };
 171          var positionMessage = {
 172             left : position === euphorik.Util.positionBulleType.haut || position === euphorik.Util.positionBulleType.bas ?
 173                 element.offset().left + element.width() / 2 - m.width() / 2 :
 174                 (position === euphorik.Util.positionBulleType.gauche ? element.offset().left - f.width() - m.width() : element.offset().left + f.width() + element.outerWidth()),
 175             top : position === euphorik.Util.positionBulleType.gauche || position === euphorik.Util.positionBulleType.droite ?
 176                 element.offset().top + element.outerHeight() / 2 - m.height() / 2 :
 177                 (position === euphorik.Util.positionBulleType.haut ? element.offset().top - f.height() - m.height() : element.offset().top + f.height() + element.outerHeight())
 178          };
 179          var depassementDroit = (positionMessage.left + m.width()) - $("body").width();
 180          if (depassementDroit > 0) {
 181             positionMessage.left -= depassementDroit;
 182          } else if (positionMessage.left < 0) {
 183             positionMessage.left = 0;
 184          }
 185
 186          m.css("top", positionMessage.top).css("left", positionMessage.left).show();
 187          f.css("top", positionFleche.top).css("left", positionFleche.left).show();
 188       },
 189       cacherBulle
 190    ).click(cacherBulle);
 191 };
 192
 193 /**
 194   * Utilisé pour l'envoie de données avec la méthode ajax de jQuery.
 195   * Obsolète : à virer
 196   */
 197 /*euphorik.Util.prototype.jsonVersAction = function(json) {
 198    return { action : JSON.stringify(json) };
 199 };*/
 200
 201 /**
 202   * Retourne un hash md5 d'une chaine, dépend de md5.js.
 203   * @param chaine un string quelconque
 204   * @return un string hashé
 205   */
 206 euphorik.Util.prototype.md5 = function(chaine) {
 207    return hex_md5(chaine);
 208 };
 209
 210 // pompé de http://www.faqts.com/knowledge_base/view.phtml/aid/13562/fid/130
 211 euphorik.Util.prototype.setSelectionRange = function(input, selectionStart, selectionEnd) {
 212    if (input.setSelectionRange) {
 213       input.focus();
 214       input.setSelectionRange(selectionStart, selectionEnd);
 215    } else if (input.createTextRange) {
 216       var range = input.createTextRange();
 217       range.collapse(true);
 218       range.moveEnd('character', selectionEnd);
 219       range.moveStart('character', selectionStart);
 220       range.select();
 221    }
 222 };
 223
 224 euphorik.Util.prototype.setCaretToEnd = function(input) {
 225    this.setSelectionRange(input, input.value.length, input.value.length);
 226 };
 227 euphorik.Util.prototype.setCaretToBegin = function(input) {
 228    this.setSelectionRange(input, 0, 0);
 229 };
 230 euphorik.Util.prototype.setCaretToPos = function(input, pos) {
 231    this.setSelectionRange(input, pos, pos);
 232 };
 233 euphorik.Util.prototype.selectString = function(input, string) {
 234    var match = new RegExp(string, "i").exec(input.value);
 235    if (match) {
 236       this.setSelectionRange (input, match.index, match.index + match[0].length);
 237    }
 238 };
 239 euphorik.Util.prototype.replaceSelection = function(input, replaceString) {
 240    if (input.setSelectionRange) {
 241       var selectionStart = input.selectionStart;
 242       var selectionEnd = input.selectionEnd;
 243       input.value = input.value.substring(0, selectionStart) + replaceString + input.value.substring(selectionEnd);
 244
 245       if (selectionStart != selectionEnd) { // has there been a selection
 246          this.setSelectionRange(input, selectionStart, selectionStart + replaceString.length);
 247       } else { // set caret
 248          this.setCaretToPos(input, selectionStart + replaceString.length);
 249       }
 250    } else if (document.selection) {
 251       input.focus();
 252       var range = document.selection.createRange();
 253       if (range.parentElement() === input) {
 254          var isCollapsed = range.text === '';
 255          range.text = replaceString;
 256          if (!isCollapsed) {
 257             range.moveStart('character', -replaceString.length);
 258          }
 259       }
 260    }
 261 };
 262
 263 /**
 264   * Rot13 d'une chaine, voir : http://fr.wikipedia.org/wiki/ROT13
 265   */
 266 euphorik.Util.prototype.rot13 = function(chaine) {
 267    var ACode = 'A'.charCodeAt(0);
 268    var aCode = 'a'.charCodeAt(0);
 269    var MCode = 'M'.charCodeAt(0);
 270    var mCode = 'm'.charCodeAt(0);
 271    var ZCode = 'Z'.charCodeAt(0);
 272    var zCode = 'z'.charCodeAt(0);
 273
 274    var f = function(ch, pos) {
 275       if (pos === ch.length) {
 276          return "";
 277       }
 278
 279       var c = ch.charCodeAt(pos);
 280       return String.fromCharCode(
 281          c +
 282          (c >= ACode && c <= MCode || c >= aCode && c <= mCode ? 13 :
 283          (c > MCode && c <= ZCode || c > mCode && c <= zCode ? -13 : 0))
 284       ) + f(ch, pos + 1);
 285    };
 286    return f(chaine, 0);
 287 };