js/CXGN/Base.js

   1 JSAN.use('MochiKit.Logging');
   2
   3 /*
   4
   5 =head1 NAME
   6
   7 CXGN.Base
   8
   9 =head1 SYNOPSIS
  10
  11 Basic SGN javascript functions to export to all pages
  12
  13 =head1 AUTHOR
  14
  15 Christopher Carpita <csc32@cornell.edu>
  16
  17 =cut
  18
  19 */
  20
  21 /*
  22
  23 =head2 alertBeta(content)
  24
  25 Special Alert for development sites with beta users, same pop-up alert box, but other information pre-pended, telling the beta user that the alert box is temporary and stuff.
  26
  27 =cut
  28
  29 */
  30
  31 function alertBeta(content) {
  32         var notification = "======== Developer Error Box ======== \n";
  33                 notification += "There was a problem in the Javascript:\n";
  34         notification += content;
  35         alert(notification);
  36 }
  37
  38 /*
  39
  40 =head2 notify(content)
  41
  42 Set the notification in a closable box at the top of the page.
  43 Similar to the Undo notifications on GMail.  For make benefit glorious user.
  44
  45 =cut
  46
  47 */
  48
  49 function notify(content) {
  50         var NOTIFY_BOX_ID = "SGN_NOTIFY_BOX"; //site-wide standard
  51         var NOTIFY_CONTENT_ID = "SGN_NOTIFY_CONTENT";
  52         document.getElementById("SGN_NOTIFY_BOX").style.display = "block";
  53         if(!document.getElementById(NOTIFY_CONTENT_ID) || !document.getElementById(NOTIFY_BOX_ID)){
  54                 var warning = "The developer should have used the notify box at the top\nof the page, but the notifier page element with the\nIDs: '" + NOTIFY_BOX_ID + "' or '" + NOTIFY_CONTENT_ID + "' were not found.\n\nNotification: ";
  55                 alertBeta(warning + content);
  56                 return false;
  57         }
  58         var notify_content = document.getElementById(NOTIFY_CONTENT_ID);
  59         notify_content.innerHTML = content;
  60         var notify_box = document.getElementById(NOTIFY_BOX_ID);
  61         notify_box.style.display = "block";
  62         return true;
  63         //The box will take care of closing itself (setting display to "none")
  64 }
  65
  66 /*
  67
  68 =head1 alert()
  69
  70  Redefine the javascript function.  An sgn user should never see an alert
  71  box.  Instead, write the alert to the MochiKit Logger.
  72
  73 */
  74
  75