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   * Cet objet regroupe des fonctions utilitaires (helpers) permettant notamment de :
  23   *  - afficher une boite de message
  24   *  - afficher une bulle d'aide lié à un élément
  25   *  - manipuler le curseur et réaliser des sélections sur des zones de saisie (<input>)
  26   * @formateur permet de formater les messages affichés à l'aide de messageDialogue (facultatif), voir "formateur.js".
  27   */
  28 euphorik.Util = function (formateur) {
  29    $("#info .fermer").click(function() {
  30       $("#info").slideUp(50);
  31    });
  32
  33    $("body").append('<div id="flecheBulle"></div>').append('<div id="messageBulle"><p></p></div>');
  34
  35    this.formateur = formateur;
  36    this.bulleActive = true;
  37 };
  38
  39 euphorik.Util.messageType = {informatif: 0, question: 1, erreur: 2};
  40
  41 /**
  42   * Affiche une boite de dialogue avec un message à l'intérieur.
  43   * @param message le message (string)
  44   * @param type voir 'messageType'. par défaut messageType.informatif
  45   * @param les boutons sous la forme d'un objet ou les clefs sont les labels des boutons
  46   *        et les valeurs les fonctions executées lorsqu'un bouton est activé.
  47   *        Lorsqu'un bouton est activé le message se ferme.
  48   * @param formate faut-il formaté le message ? true par défaut
  49   * @param temps le temps d'affichage du message en seconde, -1 pour une durée infinie
  50   */
  51 euphorik.Util.prototype.messageDialogue = function(message, type, boutons, formate, temps) {
  52    var thisUtil = this;
  53
  54    type = type || euphorik.Util.messageType.informatif;
  55    formate = formate === undefined ? true : formate;
  56
  57    if (this.timeoutMessageDialogue) {
  58       clearTimeout(this.timeoutMessageDialogue);
  59    }
  60
  61    var fermer = function() { $("#info").slideUp(100); };
  62    fermer();
  63
  64    $("#info .message").html(!thisUtil.formateur || !formate ? message : thisUtil.formateur.traitementComplet(message));
  65
  66    switch(type) {
  67       case euphorik.Util.messageType.informatif : $("#info #icone").attr("class", "information"); break;
  68       case euphorik.Util.messageType.question : $("#info #icone").attr("class", "interrogation"); break;
  69       case euphorik.Util.messageType.erreur : $("#info #icone").attr("class", "exclamation"); break;
  70    }
  71
  72    $("#info .boutons").html("");
  73    objectEach(boutons, function(nom, bouton) {
  74       $("#info .boutons").append("<div>" + nom + "</div>").find("div:last").click(bouton).click(fermer);
  75    });
  76
  77    $("#info").slideDown(200);
  78    if (temps !== -1) {
  79       this.timeoutMessageDialogue = setTimeout(fermer, temps || euphorik.conf.tempsAffichageMessageDialogue);
  80    }
  81 };
  82
  83 euphorik.Util.positionTypeX = {gauche: 0, gaucheRecouvrement: 1, centre: 2, droiteRecouvrement: 3, droite: 4};
  84 euphorik.Util.positionTypeY = {haut: 0, hautRecouvrement: 1, centre: 2, basRecouvrement: 3, bas: 4};
  85
  86 /**
  87   * Afficher une boite flottante (élément) par rapport à une cible.
  88   * La boite est affichée de manière à ne pas dépasser de la fenêtre.
  89   * @boite l'élément à afficher
  90   * @cible l'élément sur lequel est affiché la boite
  91   * @positionX de type positionTypeX
  92   * @positionY de type positionTypeY
  93   */
  94 euphorik.Util.prototype.afficherBoite = function(boite, cible, positionX, positionY) {
  95     var positionCible = cible.offset();
  96     var positionBoite = {
  97          left : positionX === euphorik.Util.positionTypeX.gauche ? positionCible.left - boite.width() :
  98             (positionX === euphorik.Util.positionTypeX.gaucheRecouvrement ? positionCible.left - boite.width() + cible.width() :
  99             (positionX === euphorik.Util.positionTypeX.droitelsRecouvrement ? positionCible.left :
 100             (positionX === euphorik.Util.positionTypeX.droite ? positionCible.left + cible.width() :
 101             positionCible.left + cible.width() / 2 - boite.width() / 2 ))), // centre
 102          top : positionY === euphorik.Util.positionTypeY.haut ? positionCible.top - boite.height() :
 103             (positionY === euphorik.Util.positionTypeY.hautRecouvrement ? positionCible.top - boite.height() + cible.height() :
 104             (positionY === euphorik.Util.positionTypeY.basRecouvrement ? positionCible.top :
 105             (positionY === euphorik.Util.positionTypeY.bas ? positionCible.top + cible.height() :
 106             positionCible.top + cible.height() / 2 - boite.height() / 2 ))) // centre
 107       };
 108
 109     // 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
 110     var marge = 10;
 111     positionBoite.left = positionBoite.left < marge + window.pageXOffset ? marge + window.pageXOffset :
 112       (boite.width() - $(window).width() + (positionBoite.left - window.pageXOffset) + marge > 0 ? $(window).width() - boite.width() - marge + window.pageXOffset : positionBoite.left);
 113     positionBoite.top = positionBoite.top < marge + window.pageYOffset ? marge + window.pageYOffset :
 114       (boite.height() - $(window).height() + (positionBoite.top - window.pageYOffset) + marge > 0 ? $(window).height() - boite.height() - marge + window.pageYOffset : positionBoite.top);
 115
 116     boite.css("top", positionBoite.top).css("left", positionBoite.left).show();
 117 };
 118
 119 euphorik.Util.positionBulleType = {haut : 0, droite : 1, bas : 2, gauche : 3};
 120
 121 /**
 122   * Affiche ou cache la barre d'attente.
 123   */
 124 euphorik.Util.prototype.showWaitBar = function() {
 125    $("#waitbar").show();
 126 };
 127 euphorik.Util.prototype.hideWaitBar = function() {
 128    $("#waitbar").hide();
 129 };
 130
 131 /**
 132   * Affiche un info bulle lorsque le curseur survole l'élément donné.
 133   * @param message le message à afficher
 134   * @param element l'élément DOM sur lesquel afficher la bulle
 135   * @param la position de la bulle, voir positionBulleType. Par défaut à 0 (haut)
 136   */
 137 euphorik.Util.prototype.infoBulle = function(message, element, position) {
 138    var thisUtil = this;
 139    var cacherBulle = function() {
 140       $("#flecheBulle").hide();
 141       $("#messageBulle").hide();
 142    };
 143
 144    position = position || euphorik.Util.positionBulleType.haut;
 145
 146    element.hover(
 147       function() {
 148          if (!thisUtil.bulleActive) {
 149             return;
 150          }
 151
 152          var m = $("#messageBulle");
 153          var f = $("#flecheBulle");
 154          f.removeClass().addClass(position === euphorik.Util.positionBulleType.haut ? "flecheBulleHaut" :
 155             (position === euphorik.Util.positionBulleType.droite ? "flecheBulleDroite" :
 156             (position === euphorik.Util.positionBulleType.bas ? "flecheBulleBas" : "flecheBulleGauche" )));
 157
 158          // remplie le paragraphe de la bulle avec le message
 159          $("p", m).html(message);
 160
 161          // réinitialise la position, évite le cas ou la boite est collé à droite et remplie avec un texte la faisant dépassé
 162          // dans ce cas la hauteur n'est pas calculé correctement
 163          m.css("top", 0).css("left", 0);
 164
 165          var positionFleche = {
 166             left : position === euphorik.Util.positionBulleType.haut || position === euphorik.Util.positionBulleType.bas ?
 167                 element.offset().left + element.outerWidth() / 2 - f.width() / 2 :
 168                 (position === euphorik.Util.positionBulleType.gauche ? element.offset().left - f.width() : element.offset().left + element.outerWidth()),
 169             top : position === euphorik.Util.positionBulleType.gauche || position === euphorik.Util.positionBulleType.droite ?
 170                 element.offset().top + element.outerHeight() / 2 - f.height() / 2 :
 171                 (position === euphorik.Util.positionBulleType.haut ? element.offset().top - f.height() : element.offset().top + element.outerHeight())
 172          };
 173          var positionMessage = {
 174             left : position === euphorik.Util.positionBulleType.haut || position === euphorik.Util.positionBulleType.bas ?
 175                 element.offset().left + element.width() / 2 - m.width() / 2 :
 176                 (position === euphorik.Util.positionBulleType.gauche ? element.offset().left - f.width() - m.width() : element.offset().left + f.width() + element.outerWidth()),
 177             top : position === euphorik.Util.positionBulleType.gauche || position === euphorik.Util.positionBulleType.droite ?
 178                 element.offset().top + element.outerHeight() / 2 - m.height() / 2 :
 179                 (position === euphorik.Util.positionBulleType.haut ? element.offset().top - f.height() - m.height() : element.offset().top + f.height() + element.outerHeight())
 180          };
 181          var depassementDroit = (positionMessage.left + m.width()) - $("body").width();
 182          if (depassementDroit > 0) {
 183             positionMessage.left -= depassementDroit;
 184          } else if (positionMessage.left < 0) {
 185             positionMessage.left = 0;
 186          }
 187
 188          m.css("top", positionMessage.top).css("left", positionMessage.left).show();
 189          f.css("top", positionFleche.top).css("left", positionFleche.left).show();
 190       },
 191       cacherBulle
 192    ).click(cacherBulle);
 193 };
 194
 195 /**
 196   * Utilisé pour l'envoie de données avec la méthode ajax de jQuery.
 197   * Obsolète : à virer
 198   */
 199 /*euphorik.Util.prototype.jsonVersAction = function(json) {
 200    return { action : JSON.stringify(json) };
 201 };*/
 202
 203 /**
 204   * Retourne un hash md5 d'une chaine, dépend de md5.js.
 205   * @param chaine un string quelconque
 206   * @return un string hashé
 207   */
 208 euphorik.Util.prototype.md5 = function(chaine) {
 209    return hex_md5(chaine);
 210 };
 211
 212 // pompé de http://www.faqts.com/knowledge_base/view.phtml/aid/13562/fid/130
 213 euphorik.Util.prototype.setSelectionRange = function(input, selectionStart, selectionEnd) {
 214    if (input.setSelectionRange) {
 215       input.focus();
 216       input.setSelectionRange(selectionStart, selectionEnd);
 217    } else if (input.createTextRange) {
 218       var range = input.createTextRange();
 219       range.collapse(true);
 220       range.moveEnd('character', selectionEnd);
 221       range.moveStart('character', selectionStart);
 222       range.select();
 223    }
 224 };
 225
 226 euphorik.Util.prototype.setCaretToEnd = function(input) {
 227    this.setSelectionRange(input, input.value.length, input.value.length);
 228 };
 229 euphorik.Util.prototype.setCaretToBegin = function(input) {
 230    this.setSelectionRange(input, 0, 0);
 231 };
 232 euphorik.Util.prototype.setCaretToPos = function(input, pos) {
 233    this.setSelectionRange(input, pos, pos);
 234 };
 235 euphorik.Util.prototype.selectString = function(input, string) {
 236    var match = new RegExp(string, "i").exec(input.value);
 237    if (match) {
 238       this.setSelectionRange (input, match.index, match.index + match[0].length);
 239    }
 240 };
 241 euphorik.Util.prototype.replaceSelection = function(input, replaceString) {
 242    if (input.setSelectionRange) {
 243       var selectionStart = input.selectionStart;
 244       var selectionEnd = input.selectionEnd;
 245       input.value = input.value.substring(0, selectionStart) + replaceString + input.value.substring(selectionEnd);
 246
 247       if (selectionStart != selectionEnd) { // has there been a selection
 248          this.setSelectionRange(input, selectionStart, selectionStart + replaceString.length);
 249       } else { // set caret
 250          this.setCaretToPos(input, selectionStart + replaceString.length);
 251       }
 252    } else if (document.selection) {
 253       input.focus();
 254       var range = document.selection.createRange();
 255       if (range.parentElement() === input) {
 256          var isCollapsed = range.text === '';
 257          range.text = replaceString;
 258          if (!isCollapsed) {
 259             range.moveStart('character', -replaceString.length);
 260          }
 261       }
 262    }
 263 };
 264
 265 /**
 266   * Rot13 d'une chaine, voir : http://fr.wikipedia.org/wiki/ROT13
 267   */
 268 euphorik.Util.prototype.rot13 = function(chaine) {
 269    var ACode = 'A'.charCodeAt(0);
 270    var aCode = 'a'.charCodeAt(0);
 271    var MCode = 'M'.charCodeAt(0);
 272    var mCode = 'm'.charCodeAt(0);
 273    var ZCode = 'Z'.charCodeAt(0);
 274    var zCode = 'z'.charCodeAt(0);
 275
 276    var f = function(ch, pos) {
 277       if (pos === ch.length) {
 278          return "";
 279       }
 280
 281       var c = ch.charCodeAt(pos);
 282       return String.fromCharCode(
 283          c +
 284          (c >= ACode && c <= MCode || c >= aCode && c <= mCode ? 13 :
 285          (c > MCode && c <= ZCode || c > mCode && c <= zCode ? -13 : 0))
 286       ) + f(ch, pos + 1);
 287    };
 288    return f(chaine, 0);
 289 };