[Sommaire] [Imprimer]

   1  /*  Copyright Mihai Bazon, 2002, 2003  |  http://dynarch.com/mishoo/
   2   * ---------------------------------------------------------------------------
   3   *
   4   * The DHTML Calendar
   5   *
   6   * Details and latest version at:
   7   * http://dynarch.com/mishoo/calendar.epl
   8   *
   9   * This script is distributed under the GNU Lesser General Public License.
  10   * Read the entire license text here: http://www.gnu.org/licenses/lgpl.html
  11   *
  12   * This file defines helper functions for setting up the calendar.  They are
  13   * intended to help non-programmers get a working calendar on their site
  14   * quickly.  This script should not be seen as part of the calendar.  It just
  15   * shows you what one can do with the calendar, while in the same time
  16   * providing a quick and simple method for setting it up.  If you need
  17   * exhaustive customization of the calendar creation process feel free to
  18   * modify this code to suit your needs (this is recommended and much better
  19   * than modifying calendar.js itself).
  20   */
  21  
  22  // $Id: calendar-setup.js 5728 2006-05-03 21:19:46Z allanbush $
  23  
  24  /**
  25   *  This function "patches" an input field (or other element) to use a calendar
  26   *  widget for date selection.
  27   *
  28   *  The "params" is a single object that can have the following properties:
  29   *
  30   *    prop. name   | description
  31   *  -------------------------------------------------------------------------------------------------
  32   *   inputField    | the ID of an input field to store the date
  33   *   displayArea   | the ID of a DIV or other element to show the date
  34   *   button        | ID of a button or other element that will trigger the calendar
  35   *   eventName     | event that will trigger the calendar, without the "on" prefix (default: "click")
  36   *   ifFormat      | date format that will be stored in the input field
  37   *   daFormat      | the date format that will be used to display the date in displayArea
  38   *   singleClick   | (true/false) wether the calendar is in single click mode or not (default: true)
  39   *   firstDay      | numeric: 0 to 6.  "0" means display Sunday first, "1" means display Monday first, etc.
  40   *   align         | alignment (default: "Br"); if you don't know what's this see the calendar documentation
  41   *   range         | array with 2 elements.  Default: [1900, 2999] -- the range of years available
  42   *   weekNumbers   | (true/false) if it's true (default) the calendar will display week numbers
  43   *   flat          | null or element ID; if not null the calendar will be a flat calendar having the parent with the given ID
  44   *   flatCallback  | function that receives a JS Date object and returns an URL to point the browser to (for flat calendar)
  45   *   disableFunc   | function that receives a JS Date object and should return true if that date has to be disabled in the calendar
  46   *   onSelect      | function that gets called when a date is selected.  You don't _have_ to supply this (the default is generally okay)
  47   *   onClose       | function that gets called when the calendar is closed.  [default]
  48   *   onUpdate      | function that gets called after the date is updated in the input field.  Receives a reference to the calendar.
  49   *   date          | the date that the calendar will be initially displayed to
  50   *   showsTime     | default: false; if true the calendar will include a time selector
  51   *   timeFormat    | the time format; can be "12" or "24", default is "12"
  52   *   electric      | if true (default) then given fields/date areas are updated for each move; otherwise they're updated only on close
  53   *   step          | configures the step of the years in drop-down boxes; default: 2
  54   *   position      | configures the calendar absolute position; default: null
  55   *   cache         | if "true" (but default: "false") it will reuse the same calendar object, where possible
  56   *   showOthers    | if "true" (but default: "false") it will show days from other months too
  57   *
  58   *  None of them is required, they all have default values.  However, if you
  59   *  pass none of "inputField", "displayArea" or "button" you'll get a warning
  60   *  saying "nothing to setup".
  61   */
  62  Calendar.setup = function (params) {
  63  	function param_default(pname, def) { if (typeof params[pname] == "undefined") { params[pname] = def; } };
  64  
  65      param_default("inputField",     null);
  66      param_default("displayArea",    null);
  67      param_default("button",         null);
  68      param_default("eventName",      "click");
  69      param_default("ifFormat",       "%Y/%m/%d");
  70      param_default("daFormat",       "%Y/%m/%d");
  71      param_default("singleClick",    true);
  72      param_default("disableFunc",    null);
  73      param_default("dateStatusFunc", params["disableFunc"]);    // takes precedence if both are defined
  74      param_default("firstDay",       0); // defaults to "Sunday" first
  75      param_default("align",          "Br");
  76      param_default("range",          [1900, 2999]);
  77      param_default("weekNumbers",    true);
  78      param_default("flat",           null);
  79      param_default("flatCallback",   null);
  80      param_default("onSelect",       null);
  81      param_default("onClose",        null);
  82      param_default("onUpdate",       null);
  83      param_default("date",           null);
  84      param_default("showsTime",      false);
  85      param_default("timeFormat",     "24");
  86      param_default("electric",       true);
  87      param_default("step",           2);
  88      param_default("position",       null);
  89      param_default("cache",          false);
  90      param_default("showOthers",     false);
  91  
  92      var tmp = ["inputField", "displayArea", "button"];
  93      for (var i in tmp) {
  94          if (typeof params[tmp[i]] == "string") {
  95              params[tmp[i]] = document.getElementById(params[tmp[i]]);
  96          }
  97      }
  98      if (!(params.flat || params.inputField || params.displayArea || params.button)) {
  99          alert("Calendar.setup:\n  Nothing to setup (no fields found).  Please check your code");
 100          return false;
 101      }
 102  
 103  	function onSelect(cal) {
 104          var p = cal.params;
 105          var update = (cal.dateClicked || p.electric);
 106          if (update && p.flat) {
 107              if (typeof p.flatCallback == "function")
 108                  p.flatCallback(cal);
 109              else
 110                  alert("No flatCallback given -- doing nothing.");
 111              return false;
 112          }
 113          if (update && p.inputField) {
 114              p.inputField.value = cal.date.print(p.ifFormat);
 115              if (typeof p.inputField.onchange == "function")
 116                  p.inputField.onchange();
 117          }
 118          if (update && p.displayArea)
 119              p.displayArea.innerHTML = cal.date.print(p.daFormat);
 120          if (update && p.singleClick && cal.dateClicked)
 121              cal.callCloseHandler();
 122          if (update && typeof p.onUpdate == "function")
 123              p.onUpdate(cal);
 124      };
 125  
 126      if (params.flat != null) {
 127          if (typeof params.flat == "string")
 128              params.flat = document.getElementById(params.flat);
 129          if (!params.flat) {
 130              alert("Calendar.setup:\n  Flat specified but can't find parent.");
 131              return false;
 132          }
 133          var cal = new Calendar(params.firstDay, params.date, params.onSelect || onSelect);
 134          cal.showsTime = params.showsTime;
 135          cal.time24 = (params.timeFormat == "24");
 136          cal.params = params;
 137          cal.weekNumbers = params.weekNumbers;
 138          cal.setRange(params.range[0], params.range[1]);
 139          cal.setDateStatusHandler(params.dateStatusFunc);
 140          cal.create(params.flat);
 141          cal.show();
 142          return false;
 143      }
 144  
 145      var triggerEl = params.button || params.displayArea || params.inputField;
 146      triggerEl["on" + params.eventName] = function() {
 147          var dateEl = params.inputField || params.displayArea;
 148          var dateFmt = params.inputField ? params.ifFormat : params.daFormat;
 149          var mustCreate = false;
 150          var cal = window.calendar;
 151          if (!(cal && params.cache)) {
 152              window.calendar = cal = new Calendar(params.firstDay,
 153                                   params.date,
 154                                   params.onSelect || onSelect,
 155                                   params.onClose || function(cal) { cal.hide(); });
 156              cal.showsTime = params.showsTime;
 157              cal.time24 = (params.timeFormat == "24");
 158              cal.weekNumbers = params.weekNumbers;
 159              mustCreate = true;
 160          } else {
 161              if (params.date)
 162                  cal.setDate(params.date);
 163              cal.hide();
 164          }
 165          cal.showsOtherMonths = params.showOthers;
 166          cal.yearStep = params.step;
 167          cal.setRange(params.range[0], params.range[1]);
 168          cal.params = params;
 169          cal.setDateStatusHandler(params.dateStatusFunc);
 170          cal.setDateFormat(dateFmt);
 171          if (mustCreate)
 172              cal.create();
 173          cal.parseDate(dateEl.value || dateEl.innerHTML);
 174          cal.refresh();
 175          if (!params.position)
 176              cal.showAtElement(params.button || params.displayArea || params.inputField, params.align);
 177          else
 178              cal.showAt(params.position[0], params.position[1]);
 179          return false;
 180      };
 181  };