MOD french -> english (5)
[euphorik.git] / js / util.js
index 9e19ed7..aff9d6e 100644 (file)
   *  - 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
-  * @formater an object for string format\r
+  * @formater An object for string format\r
   */\r
 euphorik.Util = function (formater) {\r
-   $("#info .fermer").click(function() {\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
+   $("body").append('<div id="tooltipArrow"></div>').append('<div id="tooltipMessage"><p></p></div>');\r
    \r
    this.formater = formater;\r
    this.bulleActive = true;\r
@@ -39,29 +39,27 @@ euphorik.Util = function (formater) {
 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é.
-  *        Lorsqu'un bouton est activé le message se ferme.     \r
-  * @param formate faut-il formaté le message ? true par défaut
-  * @param temps le temps d'affichage du message en seconde, -1 pour une durée infinie\r
-  */\r
-euphorik.Util.prototype.messageDialog = function(message, type, boutons, formate, temps) {\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 'formater.js')\r
+  * @time The time while the message is displayed. -1 for infinity.\r
+  */  \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 === undefined ? true : formate;\r
+   format = format === undefined ? true : format;\r
 \r
    if (this.timeoutMessageDialog) {\r
       clearTimeout(this.timeoutMessageDialog);\r
    }\r
       \r
-   var fermer = function() { $("#info").slideUp(100); };\r
-   fermer();\r
+   var close = function() { $("#info").slideUp(100); };\r
+   close();\r
 \r
-   $("#info .message").html(!thisUtil.formater || !formate ? message : thisUtil.formater.traitementComplet(message));\r
+   $("#info .message").html(!thisUtil.formater || !format ? message : thisUtil.formater.traitementComplet(message));\r
    \r
    switch(type) {\r
       case euphorik.Util.messageType.informatif : $("#info #icone").attr("class", "information"); break;\r
@@ -69,14 +67,14 @@ euphorik.Util.prototype.messageDialog = function(message, type, boutons, formate
       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
+   $("#info .buttons").html("");\r
+   objectEach(buttons, function(nom, bouton) {\r
+      $("#info .buttons").append("<div>" + nom + "</div>").find("div:last").click(bouton).click(close);\r
    });\r
    \r
    $("#info").slideDown(200);
-   if (temps !== -1) {\r
-      this.timeoutMessageDialog = setTimeout(fermer, temps || euphorik.conf.tempsAffichageMessageDialogue);
+   if (time !== -1) {\r
+      this.timeoutMessageDialog = setTimeout(close, time || euphorik.conf.tooltipDisplayDefaultTime);
    }\r
 };\r
 \r
@@ -137,8 +135,8 @@ euphorik.Util.prototype.hideWaitBar = function() {
 euphorik.Util.prototype.infoBulle = function(message, element, position) {\r
    var thisUtil = this;\r
    var cacherBulle = function() {   \r
-      $("#flecheBulle").hide();\r
-      $("#messageBulle").hide();\r
+      $("#tooltipArrow").hide();\r
+      $("#tooltipMessage").hide();\r
    };\r
    \r
    position = position || euphorik.Util.positionBulleType.haut;\r
@@ -149,11 +147,11 @@ 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
+         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