calendar popups!
[freeside.git] / httemplate / elements / calendar-setup.js
diff --git a/httemplate/elements/calendar-setup.js b/httemplate/elements/calendar-setup.js
new file mode 100644 (file)
index 0000000..de6ff59
--- /dev/null
@@ -0,0 +1,135 @@
+/*  Copyright Mihai Bazon, 2002, 2003  |  http://students.infoiasi.ro/~mishoo
+ * ---------------------------------------------------------------------------
+ *
+ * The DHTML Calendar
+ *
+ * Details and latest version at:
+ * http://students.infoiasi.ro/~mishoo/site/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 file defines helper functions for setting up the calendar.  They are
+ * intended to help non-programmers get a working calendar on their site
+ * quickly.
+ */
+
+// $Id: calendar-setup.js,v 1.2 2003-09-30 08:23:15 ivan Exp $
+
+/**
+ *  This function "patches" an input field (or other element) to use a calendar
+ *  widget for date selection.
+ *
+ *  The "params" is a single object that can have the following properties:
+ *
+ *    prop. name   | description
+ *  -------------------------------------------------------------------------------------------------
+ *   inputField    | the ID of an input field to store the date
+ *   displayArea   | the ID of a DIV or other element to show the date
+ *   button        | ID of a button or other element that will trigger the calendar
+ *   eventName     | event that will trigger the calendar, without the "on" prefix (default: "click")
+ *   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
+ *   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
+ *
+ *  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
+ *  saying "nothing to setup".
+ */
+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);
+
+       var tmp = ["inputField", "displayArea", "button"];
+       for (var i in tmp) {
+               if (typeof params[tmp[i]] == "string") {
+                       params[tmp[i]] = document.getElementById(params[tmp[i]]);
+               }
+       }
+       if (!(params.flat || params.inputField || params.displayArea || params.button)) {
+               alert("Calendar.setup:\n  Nothing to setup (no fields found).  Please check your code");
+               return false;
+       }
+
+       function onSelect(cal) {
+               if (cal.params.flat) {
+                       if (typeof cal.params.flatCallback == "function") {
+                               cal.params.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 (cal.params.displayArea) {
+                       cal.params.displayArea.innerHTML = cal.date.print(cal.params.daFormat);
+               }
+               if (cal.params.singleClick && cal.dateClicked) {
+                       cal.callCloseHandler();
+               }
+       };
+
+       if (params.flat != null) {
+               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);
+               cal.params = params;
+               cal.weekNumbers = params.weekNumbers;
+               cal.setRange(params.range[0], params.range[1]);
+               cal.setDisabledHandler(params.disableFunc);
+               cal.create(params.flat);
+               cal.show();
+               return false;
+       }
+
+       var triggerEl = params.button || params.displayArea || params.inputField;
+       triggerEl["on" + params.eventName] = function() {
+               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;
+                       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();
+               }
+               window.calendar.parseDate(dateEl.value || dateEl.innerHTML);
+               window.calendar.refresh();
+               window.calendar.showAtElement(params.displayArea || params.inputField, params.align);
+               return false;
+       };
+};