update jscalendar
[freeside.git] / httemplate / elements / calendar-setup.js
index de6ff59..55e22b9 100644 (file)
@@ -1,20 +1,25 @@
-/*  Copyright Mihai Bazon, 2002, 2003  |  http://students.infoiasi.ro/~mishoo
+/*  Copyright Mihai Bazon, 2002, 2003  |  http://dynarch.com/mishoo/
  * ---------------------------------------------------------------------------
  *
  * The DHTML Calendar
  *
  * Details and latest version at:
- * http://students.infoiasi.ro/~mishoo/site/calendar.epl
+ * http://dynarch.com/mishoo/calendar.epl
  *
- * Feel free to use this script under the terms of the GNU Lesser General
- * Public License, as long as you do not remove or alter this notice.
+ * This script is distributed under the GNU Lesser General Public License.
+ * Read the entire license text here: http://www.gnu.org/licenses/lgpl.html
  *
  * This file defines helper functions for setting up the calendar.  They are
  * intended to help non-programmers get a working calendar on their site
- * quickly.
+ * quickly.  This script should not be seen as part of the calendar.  It just
+ * shows you what one can do with the calendar, while in the same time
+ * providing a quick and simple method for setting it up.  If you need
+ * exhaustive customization of the calendar creation process feel free to
+ * modify this code to suit your needs (this is recommended and much better
+ * than modifying calendar.js itself).
  */
 
-// $Id: calendar-setup.js,v 1.2 2003-09-30 08:23:15 ivan Exp $
+// $Id: calendar-setup.js,v 1.4 2004-09-22 11:04:41 ivan Exp $
 
 /**
  *  This function "patches" an input field (or other element) to use a calendar
  *   ifFormat      | date format that will be stored in the input field
  *   daFormat      | the date format that will be used to display the date in displayArea
  *   singleClick   | (true/false) wether the calendar is in single click mode or not (default: true)
- *   mondayFirst   | (true/false) if true Monday is the first day of week, Sunday otherwise (default: false)
- *   align         | alignment (default: "Bl"); if you don't know what's this see the calendar documentation
+ *   firstDay      | numeric: 0 to 6.  "0" means display Sunday first, "1" means display Monday first, etc.
+ *   align         | alignment (default: "Br"); if you don't know what's this see the calendar documentation
  *   range         | array with 2 elements.  Default: [1900, 2999] -- the range of years available
  *   weekNumbers   | (true/false) if it's true (default) the calendar will display week numbers
  *   flat          | null or element ID; if not null the calendar will be a flat calendar having the parent with the given ID
  *   flatCallback  | function that receives a JS Date object and returns an URL to point the browser to (for flat calendar)
  *   disableFunc   | function that receives a JS Date object and should return true if that date has to be disabled in the calendar
+ *   onSelect      | function that gets called when a date is selected.  You don't _have_ to supply this (the default is generally okay)
+ *   onClose       | function that gets called when the calendar is closed.  [default]
+ *   onUpdate      | function that gets called after the date is updated in the input field.  Receives a reference to the calendar.
+ *   date          | the date that the calendar will be initially displayed to
+ *   showsTime     | default: false; if true the calendar will include a time selector
+ *   timeFormat    | the time format; can be "12" or "24", default is "12"
+ *   electric      | if true (default) then given fields/date areas are updated for each move; otherwise they're updated only on close
+ *   step          | configures the step of the years in drop-down boxes; default: 2
+ *   position      | configures the calendar absolute position; default: null
+ *   cache         | if "true" (but default: "false") it will reuse the same calendar object, where possible
+ *   showOthers    | if "true" (but default: "false") it will show days from other months too
  *
  *  None of them is required, they all have default values.  However, if you
  *  pass none of "inputField", "displayArea" or "button" you'll get a warning
 Calendar.setup = function (params) {
        function param_default(pname, def) { if (typeof params[pname] == "undefined") { params[pname] = def; } };
 
-       param_default("inputField",    null);
-       param_default("displayArea",   null);
-       param_default("button",        null);
-       param_default("eventName",     "click");
-       param_default("ifFormat",      "y/mm/dd");
-       param_default("daFormat",      "y/mm/dd");
-       param_default("singleClick",   true);
-       param_default("disableFunc",   null);
-       param_default("mondayFirst",   false);
-       param_default("align",         "Bl");
-       param_default("range",         [1900, 2999]);
-       param_default("weekNumbers",   true);
-       param_default("flat",          null);
-       param_default("flatCallback",  null);
+       param_default("inputField",     null);
+       param_default("displayArea",    null);
+       param_default("button",         null);
+       param_default("eventName",      "click");
+       param_default("ifFormat",       "%Y/%m/%d");
+       param_default("daFormat",       "%Y/%m/%d");
+       param_default("singleClick",    true);
+       param_default("disableFunc",    null);
+       param_default("dateStatusFunc", params["disableFunc"]); // takes precedence if both are defined
+       param_default("firstDay",       0); // defaults to "Sunday" first
+       param_default("align",          "Br");
+       param_default("range",          [1900, 2999]);
+       param_default("weekNumbers",    true);
+       param_default("flat",           null);
+       param_default("flatCallback",   null);
+       param_default("onSelect",       null);
+       param_default("onClose",        null);
+       param_default("onUpdate",       null);
+       param_default("date",           null);
+       param_default("showsTime",      false);
+       param_default("timeFormat",     "24");
+       param_default("electric",       true);
+       param_default("step",           2);
+       param_default("position",       null);
+       param_default("cache",          false);
+       param_default("showOthers",     false);
 
        var tmp = ["inputField", "displayArea", "button"];
        for (var i in tmp) {
@@ -73,36 +101,42 @@ Calendar.setup = function (params) {
        }
 
        function onSelect(cal) {
-               if (cal.params.flat) {
-                       if (typeof cal.params.flatCallback == "function") {
-                               cal.params.flatCallback(cal);
-                       } else {
+               var p = cal.params;
+               var update = (cal.dateClicked || p.electric);
+               if (update && p.flat) {
+                       if (typeof p.flatCallback == "function")
+                               p.flatCallback(cal);
+                       else
                                alert("No flatCallback given -- doing nothing.");
-                       }
                        return false;
                }
-               if (cal.params.inputField) {
-                       cal.params.inputField.value = cal.date.print(cal.params.ifFormat);
+               if (update && p.inputField) {
+                       p.inputField.value = cal.date.print(p.ifFormat);
+                       if (typeof p.inputField.onchange == "function")
+                               p.inputField.onchange();
                }
-               if (cal.params.displayArea) {
-                       cal.params.displayArea.innerHTML = cal.date.print(cal.params.daFormat);
-               }
-               if (cal.params.singleClick && cal.dateClicked) {
+               if (update && p.displayArea)
+                       p.displayArea.innerHTML = cal.date.print(p.daFormat);
+               if (update && p.singleClick && cal.dateClicked)
                        cal.callCloseHandler();
-               }
+               if (update && typeof p.onUpdate == "function")
+                       p.onUpdate(cal);
        };
 
        if (params.flat != null) {
-               params.flat = document.getElementById(params.flat);
+               if (typeof params.flat == "string")
+                       params.flat = document.getElementById(params.flat);
                if (!params.flat) {
                        alert("Calendar.setup:\n  Flat specified but can't find parent.");
                        return false;
                }
-               var cal = new Calendar(params.mondayFirst, null, onSelect);
+               var cal = new Calendar(params.firstDay, params.date, params.onSelect || onSelect);
+               cal.showsTime = params.showsTime;
+               cal.time24 = (params.timeFormat == "24");
                cal.params = params;
                cal.weekNumbers = params.weekNumbers;
                cal.setRange(params.range[0], params.range[1]);
-               cal.setDisabledHandler(params.disableFunc);
+               cal.setDateStatusHandler(params.dateStatusFunc);
                cal.create(params.flat);
                cal.show();
                return false;
@@ -113,23 +147,35 @@ Calendar.setup = function (params) {
                var dateEl = params.inputField || params.displayArea;
                var dateFmt = params.inputField ? params.ifFormat : params.daFormat;
                var mustCreate = false;
-               if (!window.calendar) {
-                       window.calendar = new Calendar(params.mondayFirst, null, onSelect, function(cal) { cal.hide(); });
-                       window.calendar.weekNumbers = params.weekNumbers;
+               var cal = window.calendar;
+               if (!(cal && params.cache)) {
+                       window.calendar = cal = new Calendar(params.firstDay,
+                                                            params.date,
+                                                            params.onSelect || onSelect,
+                                                            params.onClose || function(cal) { cal.hide(); });
+                       cal.showsTime = params.showsTime;
+                       cal.time24 = (params.timeFormat == "24");
+                       cal.weekNumbers = params.weekNumbers;
                        mustCreate = true;
                } else {
-                       window.calendar.hide();
-               }
-               window.calendar.setRange(params.range[0], params.range[1]);
-               window.calendar.params = params;
-               window.calendar.setDisabledHandler(params.disableFunc);
-               window.calendar.setDateFormat(dateFmt);
-               if (mustCreate) {
-                       window.calendar.create();
+                       if (params.date)
+                               cal.setDate(params.date);
+                       cal.hide();
                }
-               window.calendar.parseDate(dateEl.value || dateEl.innerHTML);
-               window.calendar.refresh();
-               window.calendar.showAtElement(params.displayArea || params.inputField, params.align);
+               cal.showsOtherMonths = params.showOthers;
+               cal.yearStep = params.step;
+               cal.setRange(params.range[0], params.range[1]);
+               cal.params = params;
+               cal.setDateStatusHandler(params.dateStatusFunc);
+               cal.setDateFormat(dateFmt);
+               if (mustCreate)
+                       cal.create();
+               cal.parseDate(dateEl.value || dateEl.innerHTML);
+               cal.refresh();
+               if (!params.position)
+                       cal.showAtElement(params.button || params.displayArea || params.inputField, params.align);
+               else
+                       cal.showAt(params.position[0], params.position[1]);
                return false;
        };
 };