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