Bug 5877 : Offline circulation improvements : upload all files, apply at once
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / lib / calendar / calendar-setup.js
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 /**
23  *  This function "patches" an input field (or other element) to use a calendar
24  *  widget for date selection.
25  *
26  *  The "params" is a single object that can have the following properties:
27  *
28  *    prop. name   | description
29  *  -------------------------------------------------------------------------------------------------
30  *   inputField    | the ID of an input field to store the date
31  *   displayArea   | the ID of a DIV or other element to show the date
32  *   button        | ID of a button or other element that will trigger the calendar
33  *   eventName     | event that will trigger the calendar, without the "on" prefix (default: "click")
34  *   ifFormat      | date format that will be stored in the input field
35  *   daFormat      | the date format that will be used to display the date in displayArea
36  *   singleClick   | (true/false) whether the calendar is in single click mode or not (default: true)
37  *   firstDay      | numeric: 0 to 6.  "0" means display Sunday first, "1" means display Monday first, etc.
38  *   align         | alignment (default: "Br"); if you don't know what's this see the calendar documentation
39  *   range         | array with 2 elements.  Default: [1900, 2999] -- the range of years available
40  *   weekNumbers   | (true/false) if it's true (default) the calendar will display week numbers
41  *   flat          | null or element ID; if not null the calendar will be a flat calendar having the parent with the given ID
42  *   flatCallback  | function that receives a JS Date object and returns an URL to point the browser to (for flat calendar)
43  *   disableFunc   | function that receives a JS Date object and should return true if that date has to be disabled in the calendar
44  *   onSelect      | function that gets called when a date is selected.  You don't _have_ to supply this (the default is generally okay)
45  *   onClose       | function that gets called when the calendar is closed.  [default]
46  *   onUpdate      | function that gets called after the date is updated in the input field.  Receives a reference to the calendar.
47  *   date          | the date that the calendar will be initially displayed to
48  *   showsTime     | default: false; if true the calendar will include a time selector
49  *   timeFormat    | the time format; can be "12" or "24", default is "12"
50  *   electric      | if true (default) then given fields/date areas are updated for each move; otherwise they're updated only on close
51  *   step          | configures the step of the years in drop-down boxes; default: 2
52  *   position      | configures the calendar absolute position; default: null
53  *   cache         | if "true" (but default: "false") it will reuse the same calendar object, where possible
54  *   showOthers    | if "true" (but default: "false") it will show days from other months too
55  *
56  *  None of them is required, they all have default values.  However, if you
57  *  pass none of "inputField", "displayArea" or "button" you'll get a warning
58  *  saying "nothing to setup".
59  */
60 Calendar.setup = function (params) {
61         function param_default(pname, def) { if (typeof params[pname] == "undefined") { params[pname] = def; } };
62
63         param_default("inputField",     null);
64         param_default("displayArea",    null);
65         param_default("button",         null);
66         param_default("eventName",      "click");
67         param_default("ifFormat",       "%Y/%m/%d");
68         param_default("daFormat",       "%Y/%m/%d");
69         param_default("singleClick",    true);
70         param_default("disableFunc",    'dateStatusHandler');
71         param_default("dateStatusFunc", params["disableFunc"]); // takes precedence if both are defined
72         param_default("firstDay",       0); // defaults to "Sunday" first
73         param_default("align",          "Br");
74         param_default("range",          [1900, 2999]);
75         param_default("weekNumbers",    true);
76         param_default("flat",           null);
77         param_default("flatCallback",   null);
78         param_default("onSelect",       null);
79         param_default("onClose",        null);
80         param_default("onUpdate",       null);
81         param_default("date",           null);
82         param_default("showsTime",      false);
83         param_default("timeFormat",     "24");
84         param_default("electric",       true);
85         param_default("step",           2);
86         param_default("position",       null);
87         param_default("cache",          false);
88         param_default("showOthers",     false);
89
90         var tmp = ["inputField", "displayArea", "button"];
91         for (var i in tmp) {
92                 if (typeof params[tmp[i]] == "string") {
93                         params[tmp[i]] = document.getElementById(params[tmp[i]]);
94                 }
95         }
96         if (!(params.flat || params.inputField || params.displayArea || params.button)) {
97                 alert("Calendar.setup:\n  Nothing to setup (no fields found).  Please check your code");
98                 return false;
99         }
100
101         function onSelect(cal) {
102                 var p = cal.params;
103                 var update = (cal.dateClicked || p.electric);
104                 if (update && p.flat) {
105                         if (typeof p.flatCallback == "function")
106                                 p.flatCallback(cal);
107                         else
108                                 alert("No flatCallback given -- doing nothing.");
109                         return false;
110                 }
111                 if (update && p.inputField) {
112                         p.inputField.value = cal.date.print(p.ifFormat);
113                         if (typeof p.inputField.onchange == "function")
114                                 p.inputField.onchange();
115                 }
116                 if (update && p.displayArea)
117                         p.displayArea.innerHTML = cal.date.print(p.daFormat);
118                 if (update && p.singleClick && cal.dateClicked)
119                         cal.callCloseHandler();
120                 if (update && typeof p.onUpdate == "function")
121                         p.onUpdate(cal);
122         };
123
124         if (params.flat != null) {
125                 if (typeof params.flat == "string")
126                         params.flat = document.getElementById(params.flat);
127                 if (!params.flat) {
128                         alert("Calendar.setup:\n  Flat specified but can't find parent.");
129                         return false;
130                 }
131                 var cal = new Calendar(params.firstDay, params.date, params.onSelect || onSelect);
132                 cal.showsTime = params.showsTime;
133                 cal.time24 = (params.timeFormat == "24");
134                 cal.params = params;
135                 cal.weekNumbers = params.weekNumbers;
136                 cal.setRange(params.range[0], params.range[1]);
137                 cal.setDateStatusHandler(params.dateStatusFunc);
138                 cal.create(params.flat);
139                 cal.show();
140                 return false;
141         }
142
143         var triggerEl = params.button || params.displayArea || params.inputField;
144         triggerEl["on" + params.eventName] = function() {
145                 var dateEl = params.inputField || params.displayArea;
146                 var dateFmt = params.inputField ? params.ifFormat : params.daFormat;
147                 var mustCreate = false;
148                 var cal = window.calendar;
149                 if (!(cal && params.cache)) {
150                         window.calendar = cal = new Calendar(params.firstDay,
151                                                              params.date,
152                                                              params.onSelect || onSelect,
153                                                              params.onClose || function(cal) { cal.hide(); });
154                         cal.showsTime = params.showsTime;
155                         cal.time24 = (params.timeFormat == "24");
156                         cal.weekNumbers = params.weekNumbers;
157                         mustCreate = true;
158                 } else {
159                         if (params.date)
160                                 cal.setDate(params.date);
161                         cal.hide();
162                 }
163                 cal.showsOtherMonths = params.showOthers;
164                 cal.yearStep = params.step;
165                 cal.setRange(params.range[0], params.range[1]);
166                 cal.params = params;
167                 cal.setDateStatusHandler(params.dateStatusFunc);
168                 cal.setDateFormat(dateFmt);
169                 if (mustCreate)
170                         cal.create();
171                 cal.parseDate(dateEl.value || dateEl.innerHTML);
172                 cal.refresh();
173                 if (!params.position)
174                         cal.showAtElement(params.button || params.displayArea || params.inputField, params.align);
175                 else
176                         cal.showAt(params.position[0], params.position[1]);
177                 return false;
178         };
179 };