Update to the new library 'json2'
[euphorik.git] / js / util.js
index 2c66959..39f89b0 100644 (file)
 /*jslint laxbreak:true */\r
 \r
 /**\r
-  * Cette classe regroupe des fonctions utilitaires (helpers) permettant notamment de :\r
-  *  - afficher une boite de message\r
-  *  - afficher une bulle d'aide lié à un élément\r
-  *  - manipuler le curseur et réaliser des sélections sur des zones de saisie (<input>)\r
-  * @formateur permet de formater les messages affichés à l'aide de messageDialogue (facultatif), voir "formateur.js".\r
+  * This object brings some utility functions.\r
+  *  - Print a message box to display some information for the user.\r
+  *  - Set a tooltip for a HTML element.\r
+  *  - Some text manipulation for input area.\r
+  * @formatter An object for string format\r
   */\r
-euphorik.Util = function (formateur) {\r
-   $("#info .fermer").click(function() {\r
+euphorik.Util = function (formatter) {\r
+   $("#info .close").click(function() {\r
       $("#info").slideUp(50);\r
    });\r
-   \r
-   $("body").append('<div id="flecheBulle"></div>').append('<div id="messageBulle"><p></p></div>');\r
-   \r
-   this.formateur = formateur;\r
+\r
+   $("body").append('<div id="tooltipArrow"></div>').append('<div id="tooltipMessage"><p></p></div>');\r
+\r
+   this.formatter = formatter;\r
    this.bulleActive = true;\r
 };\r
 \r
 euphorik.Util.messageType = {informatif: 0, question: 1, erreur: 2};\r
 \r
 /**\r
-  * Affiche une boite de dialogue avec un message à l'intérieur.\r
-  * @param message le message (string)\r
-  * @param type voir 'messageType'. par défaut messageType.informatif\r
-  * @param les boutons sous la forme d'un objet ou les clefs sont les labels des boutons\r
-  *        et les valeurs les fonctions executées lorsqu'un bouton est activé.\r
-  * @param formate faut-il formaté le message ? true par défaut\r
+  * Display a message box.\r
+  * @message [String] The message.\r
+  * @type [euphorik.Util.messageType] The message type like 'information' or 'error'. Default is messageType.informatif.\r
+  * @buttons An object where the properties are the labels and the values are functions which will be executed when a button is clicked.\r
+  * @format [bool] The message should be formated. (see 'formatter.js')\r
+  * @time The time while the message is displayed. -1 for infinity.\r
   */\r
-euphorik.Util.prototype.messageDialogue = function(message, type, boutons, formate) {\r
+euphorik.Util.prototype.messageDialog = function(message, type, buttons, format, time) {\r
    var thisUtil = this;\r
 \r
    type = type || euphorik.Util.messageType.informatif;\r
-   formate = formate || true;\r
+   format = format === undefined ? true : format;\r
 \r
-   if (this.timeoutMessageDialogue) {\r
-      clearTimeout(this.timeoutMessageDialogue);\r
+   if (this.timeoutMessageDialog) {\r
+      clearTimeout(this.timeoutMessageDialog);\r
    }\r
-      \r
-   var fermer = function() { $("#info").slideUp(100); };\r
-   fermer();\r
-   \r
-   $("#info .message").html(!thisUtil.formateur || !formate ? message : thisUtil.formateur.traitementComplet(message));\r
-   \r
+\r
+   var close = function() { $("#info").slideUp(100); };\r
+   close();\r
+\r
+   $("#info .message").html(!thisUtil.formatter || !format ? message : thisUtil.formatter.completeProcessing(message));\r
+\r
    switch(type) {\r
       case euphorik.Util.messageType.informatif : $("#info #icone").attr("class", "information"); break;\r
       case euphorik.Util.messageType.question : $("#info #icone").attr("class", "interrogation"); break;\r
       case euphorik.Util.messageType.erreur : $("#info #icone").attr("class", "exclamation"); break;\r
    }\r
-   \r
-   $("#info .boutons").html("");\r
-   objectEach(boutons, function(nom, bouton) {\r
-      $("#info .boutons").append("<div>" + nom + "</div>").find("div:last").click(bouton).click(fermer);\r
+\r
+   $("#info .buttons").html("");\r
+   objectEach(buttons, function(name, bouton) {\r
+      $("#info .buttons").append("<div>" + name + "</div>").find("div:last").click(bouton).click(close);\r
    });\r
-   \r
+\r
    $("#info").slideDown(200);\r
-   this.timeoutMessageDialogue = setTimeout(fermer, euphorik.conf.tempsAffichageMessageDialogue);\r
+   if (time !== -1) {\r
+      this.timeoutMessageDialog = setTimeout(close, time || euphorik.conf.tooltipDisplayDefaultTime);\r
+   }\r
 };\r
 \r
 euphorik.Util.positionTypeX = {gauche: 0, gaucheRecouvrement: 1, centre: 2, droiteRecouvrement: 3, droite: 4};\r
@@ -91,29 +93,39 @@ euphorik.Util.prototype.afficherBoite = function(boite, cible, positionX, positi
     var positionCible = cible.offset();\r
     var positionBoite = {\r
          left : positionX === euphorik.Util.positionTypeX.gauche ? positionCible.left - boite.width() :\r
-            (positionX === euphorik.Util.positionTypeX.gaucheRecouvrement ? positionCible.left - boite.width() + cible.width() : \r
+            (positionX === euphorik.Util.positionTypeX.gaucheRecouvrement ? positionCible.left - boite.width() + cible.width() :\r
             (positionX === euphorik.Util.positionTypeX.droitelsRecouvrement ? positionCible.left :\r
             (positionX === euphorik.Util.positionTypeX.droite ? positionCible.left + cible.width() :\r
             positionCible.left + cible.width() / 2 - boite.width() / 2 ))), // centre\r
          top : positionY === euphorik.Util.positionTypeY.haut ? positionCible.top - boite.height() :\r
-            (positionY === euphorik.Util.positionTypeY.hautRecouvrement ? positionCible.top - boite.height() + cible.height() : \r
+            (positionY === euphorik.Util.positionTypeY.hautRecouvrement ? positionCible.top - boite.height() + cible.height() :\r
             (positionY === euphorik.Util.positionTypeY.basRecouvrement ? positionCible.top :\r
             (positionY === euphorik.Util.positionTypeY.bas ? positionCible.top + cible.height() :\r
             positionCible.top + cible.height() / 2 - boite.height() / 2 ))) // centre\r
       };\r
-      \r
+\r
     // 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\r
-    var marge = 10; \r
+    var marge = 10;\r
     positionBoite.left = positionBoite.left < marge + window.pageXOffset ? marge + window.pageXOffset :\r
       (boite.width() - $(window).width() + (positionBoite.left - window.pageXOffset) + marge > 0 ? $(window).width() - boite.width() - marge + window.pageXOffset : positionBoite.left);\r
     positionBoite.top = positionBoite.top < marge + window.pageYOffset ? marge + window.pageYOffset :\r
       (boite.height() - $(window).height() + (positionBoite.top - window.pageYOffset) + marge > 0 ? $(window).height() - boite.height() - marge + window.pageYOffset : positionBoite.top);\r
-    \r
+\r
     boite.css("top", positionBoite.top).css("left", positionBoite.left).show();\r
 };\r
 \r
 euphorik.Util.positionBulleType = {haut : 0, droite : 1, bas : 2, gauche : 3};\r
 \r
+/**\r
+  * Affiche ou cache la barre d'attente.\r
+  */\r
+euphorik.Util.prototype.showWaitBar = function() {\r
+   $("#waitbar").show();\r
+};\r
+euphorik.Util.prototype.hideWaitBar = function() {\r
+   $("#waitbar").hide();\r
+};\r
+\r
 /**\r
   * Affiche un info bulle lorsque le curseur survole l'élément donné.\r
   * @param message le message à afficher\r
@@ -122,11 +134,11 @@ euphorik.Util.positionBulleType = {haut : 0, droite : 1, bas : 2, gauche : 3};
   */\r
 euphorik.Util.prototype.infoBulle = function(message, element, position) {\r
    var thisUtil = this;\r
-   var cacherBulle = function() {   \r
-      $("#flecheBulle").hide();\r
-      $("#messageBulle").hide();\r
+   var cacherBulle = function() {\r
+      $("#tooltipArrow").hide();\r
+      $("#tooltipMessage").hide();\r
    };\r
-   \r
+\r
    position = position || euphorik.Util.positionBulleType.haut;\r
 \r
    element.hover(\r
@@ -135,19 +147,19 @@ euphorik.Util.prototype.infoBulle = function(message, element, position) {
             return;\r
          }\r
 \r
-         var m = $("#messageBulle");\r
-         var f = $("#flecheBulle");\r
-         f.removeClass().addClass(position === euphorik.Util.positionBulleType.haut ? "flecheBulleHaut" :\r
-            (position === euphorik.Util.positionBulleType.droite ? "flecheBulleDroite" : \r
-            (position === euphorik.Util.positionBulleType.bas ? "flecheBulleBas" : "flecheBulleGauche" )));\r
-         \r
+         var m = $("#tooltipMessage");\r
+         var f = $("#tooltipArrow");\r
+         f.removeClass().addClass(position === euphorik.Util.positionBulleType.haut ? "tooltipArrowTop" :\r
+            (position === euphorik.Util.positionBulleType.droite ? "tooltipArrowRight" :\r
+            (position === euphorik.Util.positionBulleType.bas ? "tooltipArrowBottom" : "tooltipArrowLeft" )));\r
+\r
          // remplie le paragraphe de la bulle avec le message\r
          $("p", m).html(message);\r
-         \r
+\r
          // réinitialise la position, évite le cas ou la boite est collé à droite et remplie avec un texte la faisant dépassé\r
          // dans ce cas la hauteur n'est pas calculé correctement\r
          m.css("top", 0).css("left", 0);\r
-         \r
+\r
          var positionFleche = {\r
             left : position === euphorik.Util.positionBulleType.haut || position === euphorik.Util.positionBulleType.bas ?\r
                 element.offset().left + element.outerWidth() / 2 - f.width() / 2 :\r
@@ -170,7 +182,7 @@ euphorik.Util.prototype.infoBulle = function(message, element, position) {
          } else if (positionMessage.left < 0) {\r
             positionMessage.left = 0;\r
          }\r
-         \r
+\r
          m.css("top", positionMessage.top).css("left", positionMessage.left).show();\r
          f.css("top", positionFleche.top).css("left", positionFleche.left).show();\r
       },\r
@@ -178,14 +190,6 @@ euphorik.Util.prototype.infoBulle = function(message, element, position) {
    ).click(cacherBulle);\r
 };\r
 \r
-/**\r
-  * Utilisé pour l'envoie de données avec la méthode ajax de jQuery.\r
-  * Obsolète : à virer\r
-  */\r
-euphorik.Util.prototype.jsonVersAction = function(json) {\r
-   return { action : JSON.stringify(json) };\r
-};\r
-\r
 /**\r
   * Retourne un hash md5 d'une chaine, dépend de md5.js.\r
   * @param chaine un string quelconque\r
@@ -195,7 +199,7 @@ euphorik.Util.prototype.md5 = function(chaine) {
    return hex_md5(chaine);\r
 };\r
 \r
-// pompé de http://www.faqts.com/knowledge_base/view.phtml/aid/13562/fid/130\r
+// Taken from http://www.faqts.com/knowledge_base/view.phtml/aid/13562/fid/130\r
 euphorik.Util.prototype.setSelectionRange = function(input, selectionStart, selectionEnd) {\r
    if (input.setSelectionRange) {\r
       input.focus();\r
@@ -229,7 +233,7 @@ euphorik.Util.prototype.replaceSelection = function(input, replaceString) {
       var selectionStart = input.selectionStart;\r
       var selectionEnd = input.selectionEnd;\r
       input.value = input.value.substring(0, selectionStart) + replaceString + input.value.substring(selectionEnd);\r
-      \r
+\r
       if (selectionStart != selectionEnd) { // has there been a selection\r
          this.setSelectionRange(input, selectionStart, selectionStart + replaceString.length);\r
       } else { // set caret\r
@@ -249,9 +253,10 @@ euphorik.Util.prototype.replaceSelection = function(input, replaceString) {
 };\r
 \r
 /**\r
-  * Rot13 d'une chaine, voir : http://fr.wikipedia.org/wiki/ROT13\r
+  * Applies rot13 to a given string. See : http://en.wikipedia.org/wiki/ROT13.\r
+  * @param str the string.\r
   */\r
-euphorik.Util.prototype.rot13 = function(chaine) {\r
+euphorik.Util.prototype.rot13 = function(str) {\r
    var ACode = 'A'.charCodeAt(0);\r
    var aCode = 'a'.charCodeAt(0);\r
    var MCode = 'M'.charCodeAt(0);\r
@@ -263,7 +268,7 @@ euphorik.Util.prototype.rot13 = function(chaine) {
       if (pos === ch.length) {\r
          return "";\r
       }\r
-      \r
+\r
       var c = ch.charCodeAt(pos);\r
       return String.fromCharCode(\r
          c +\r
@@ -271,5 +276,5 @@ euphorik.Util.prototype.rot13 = function(chaine) {
          (c > MCode && c <= ZCode || c > mCode && c <= zCode ? -13 : 0))\r
       ) + f(ch, pos + 1);\r
    };\r
-   return f(chaine, 0);\r
+   return f(str, 0);\r
 };\r