1 // Copyright (c) 2005, 2006 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us)
2 // (c) 2005, 2006 Ivan Krstic (http://blogs.law.harvard.edu/ivan)
3 // (c) 2005, 2006 Jon Tirsen (http://www.tirsen.com)
9 // script.aculo.us is freely distributable under the terms of an MIT-style license.
10 // For details, see the script.aculo.us web site: http://script.aculo.us/
12 // Autocompleter.Base handles all the autocompletion functionality
13 // that's independent of the data source for autocompletion. This
14 // includes drawing the autocompletion menu, observing keyboard
15 // and mouse events, and similar.
17 // Specific autocompleters need to provide, at the very least,
18 // a getUpdatedChoices function that will be invoked every time
19 // the text inside the monitored textbox changes. This method
20 // should get the text for which to provide autocompletion by
21 // invoking this.getToken(), NOT by directly accessing
22 // this.element.value. This is to allow incremental tokenized
23 // autocompletion. Specific auto-completion logic (AJAX, etc)
24 // belongs in getUpdatedChoices.
26 // Tokenized incremental autocompletion is enabled automatically
27 // when an autocompleter is instantiated with the 'tokens' option
28 // in the options parameter, e.g.:
29 // new Ajax.Autocompleter('id','upd', '/url/', { tokens: ',' });
30 // will incrementally autocomplete with a comma as the token.
31 // Additionally, ',' in the above example can be replaced with
32 // a token array, e.g. { tokens: [',', '\n'] } which
33 // enables autocompletion on multiple tokens. This is most
34 // useful when one of the tokens is \n (a newline), as it
35 // allows smart autocompletion after linebreaks.
37 if(typeof Effect == 'undefined')
38 throw("controls.js requires including script.aculo.us' effects.js library");
40 var Autocompleter = {}
41 Autocompleter.Base = function() {};
42 Autocompleter.Base.prototype = {
43 baseInitialize: function(element, update, options) {
44 this.element = $(element);
45 this.update = $(update);
46 this.hasFocus = false;
53 this.setOptions(options);
55 this.options = options || {};
57 this.options.paramName = this.options.paramName || this.element.name;
58 this.options.tokens = this.options.tokens || [];
59 this.options.frequency = this.options.frequency || 0.4;
60 this.options.minChars = this.options.minChars || 1;
61 this.options.onShow = this.options.onShow ||
62 function(element, update){
63 if(!update.style.position || update.style.position=='absolute') {
64 update.style.position = 'absolute';
65 Position.clone(element, update, {
67 offsetTop: element.offsetHeight
70 Effect.Appear(update,{duration:0.15});
72 this.options.onHide = this.options.onHide ||
73 function(element, update){ new Effect.Fade(update,{duration:0.15}) };
75 if(typeof(this.options.tokens) == 'string')
76 this.options.tokens = new Array(this.options.tokens);
80 this.element.setAttribute('autocomplete','off');
82 Element.hide(this.update);
84 Event.observe(this.element, "blur", this.onBlur.bindAsEventListener(this));
85 Event.observe(this.element, "keypress", this.onKeyPress.bindAsEventListener(this));
89 if(Element.getStyle(this.update, 'display')=='none') this.options.onShow(this.element, this.update);
91 (navigator.appVersion.indexOf('MSIE')>0) &&
92 (navigator.userAgent.indexOf('Opera')<0) &&
93 (Element.getStyle(this.update, 'position')=='absolute')) {
94 new Insertion.After(this.update,
95 '<iframe id="' + this.update.id + '_iefix" '+
96 'style="display:none;position:absolute;filter:progid:DXImageTransform.Microsoft.Alpha(opacity=0);" ' +
97 'src="javascript:false;" frameborder="0" scrolling="no"></iframe>');
98 this.iefix = $(this.update.id+'_iefix');
100 if(this.iefix) setTimeout(this.fixIEOverlapping.bind(this), 50);
103 fixIEOverlapping: function() {
104 Position.clone(this.update, this.iefix, {setTop:(!this.update.style.height)});
105 this.iefix.style.zIndex = 1;
106 this.update.style.zIndex = 2;
107 Element.show(this.iefix);
111 this.stopIndicator();
112 if(Element.getStyle(this.update, 'display')!='none') this.options.onHide(this.element, this.update);
113 if(this.iefix) Element.hide(this.iefix);
116 startIndicator: function() {
117 if(this.options.indicator) Element.show(this.options.indicator);
120 stopIndicator: function() {
121 if(this.options.indicator) Element.hide(this.options.indicator);
124 onKeyPress: function(event) {
126 switch(event.keyCode) {
128 case Event.KEY_RETURN:
137 case Event.KEY_RIGHT:
142 if(navigator.appVersion.indexOf('AppleWebKit')>0) Event.stop(event);
147 if(navigator.appVersion.indexOf('AppleWebKit')>0) Event.stop(event);
151 if(event.keyCode==Event.KEY_TAB || event.keyCode==Event.KEY_RETURN ||
152 (navigator.appVersion.indexOf('AppleWebKit') > 0 && event.keyCode == 0)) return;
155 this.hasFocus = true;
157 if(this.observer) clearTimeout(this.observer);
159 setTimeout(this.onObserverEvent.bind(this), this.options.frequency*1000);
162 activate: function() {
163 this.changed = false;
164 this.hasFocus = true;
165 this.getUpdatedChoices();
168 onHover: function(event) {
169 var element = Event.findElement(event, 'LI');
170 if(this.index != element.autocompleteIndex)
172 this.index = element.autocompleteIndex;
178 onClick: function(event) {
179 var element = Event.findElement(event, 'LI');
180 this.index = element.autocompleteIndex;
185 onBlur: function(event) {
186 // needed to make click events working
187 setTimeout(this.hide.bind(this), 250);
188 this.hasFocus = false;
193 if(this.entryCount > 0) {
194 for (var i = 0; i < this.entryCount; i++)
196 Element.addClassName(this.getEntry(i),"selected") :
197 Element.removeClassName(this.getEntry(i),"selected");
209 markPrevious: function() {
210 if(this.index > 0) this.index--
211 else this.index = this.entryCount-1;
212 this.getEntry(this.index).scrollIntoView(true);
215 markNext: function() {
216 if(this.index < this.entryCount-1) this.index++
218 this.getEntry(this.index).scrollIntoView(false);
221 getEntry: function(index) {
222 return this.update.firstChild.childNodes[index];
225 getCurrentEntry: function() {
226 return this.getEntry(this.index);
229 selectEntry: function() {
231 this.updateElement(this.getCurrentEntry());
234 updateElement: function(selectedElement) {
235 if (this.options.updateElement) {
236 this.options.updateElement(selectedElement);
240 if (this.options.select) {
241 var nodes = document.getElementsByClassName(this.options.select, selectedElement) || [];
242 if(nodes.length>0) value = Element.collectTextNodes(nodes[0], this.options.select);
244 value = Element.collectTextNodesIgnoreClass(selectedElement, 'informal');
246 var lastTokenPos = this.findLastToken();
247 if (lastTokenPos != -1) {
248 var newValue = this.element.value.substr(0, lastTokenPos + 1);
249 var whitespace = this.element.value.substr(lastTokenPos + 1).match(/^\s+/);
251 newValue += whitespace[0];
252 this.element.value = newValue + value;
254 this.element.value = value;
256 this.element.focus();
258 if (this.options.afterUpdateElement)
259 this.options.afterUpdateElement(this.element, selectedElement);
262 updateChoices: function(choices) {
263 if(!this.changed && this.hasFocus) {
264 this.update.innerHTML = choices;
265 Element.cleanWhitespace(this.update);
266 Element.cleanWhitespace(this.update.down());
268 if(this.update.firstChild && this.update.down().childNodes) {
270 this.update.down().childNodes.length;
271 for (var i = 0; i < this.entryCount; i++) {
272 var entry = this.getEntry(i);
273 entry.autocompleteIndex = i;
274 this.addObservers(entry);
280 this.stopIndicator();
283 if(this.entryCount==1 && this.options.autoSelect) {
292 addObservers: function(element) {
293 Event.observe(element, "mouseover", this.onHover.bindAsEventListener(this));
294 Event.observe(element, "click", this.onClick.bindAsEventListener(this));
297 onObserverEvent: function() {
298 this.changed = false;
299 if(this.getToken().length>=this.options.minChars) {
300 this.startIndicator();
301 this.getUpdatedChoices();
308 getToken: function() {
309 var tokenPos = this.findLastToken();
311 var ret = this.element.value.substr(tokenPos + 1).replace(/^\s+/,'').replace(/\s+$/,'');
313 var ret = this.element.value;
315 return /\n/.test(ret) ? '' : ret;
318 findLastToken: function() {
319 var lastTokenPos = -1;
321 for (var i=0; i<this.options.tokens.length; i++) {
322 var thisTokenPos = this.element.value.lastIndexOf(this.options.tokens[i]);
323 if (thisTokenPos > lastTokenPos)
324 lastTokenPos = thisTokenPos;
330 Ajax.Autocompleter = Class.create();
331 Object.extend(Object.extend(Ajax.Autocompleter.prototype, Autocompleter.Base.prototype), {
332 initialize: function(element, update, url, options) {
333 this.baseInitialize(element, update, options);
334 this.options.asynchronous = true;
335 this.options.onComplete = this.onComplete.bind(this);
336 this.options.defaultParams = this.options.parameters || null;
340 getUpdatedChoices: function() {
341 entry = encodeURIComponent(this.options.paramName) + '=' +
342 encodeURIComponent(this.getToken());
344 this.options.parameters = this.options.callback ?
345 this.options.callback(this.element, entry) : entry;
347 if(this.options.defaultParams)
348 this.options.parameters += '&' + this.options.defaultParams;
350 new Ajax.Request(this.url, this.options);
353 onComplete: function(request) {
354 this.updateChoices(request.responseText);
359 // The local array autocompleter. Used when you'd prefer to
360 // inject an array of autocompletion options into the page, rather
361 // than sending out Ajax queries, which can be quite slow sometimes.
363 // The constructor takes four parameters. The first two are, as usual,
364 // the id of the monitored textbox, and id of the autocompletion menu.
365 // The third is the array you want to autocomplete from, and the fourth
366 // is the options block.
368 // Extra local autocompletion options:
369 // - choices - How many autocompletion choices to offer
371 // - partialSearch - If false, the autocompleter will match entered
372 // text only at the beginning of strings in the
373 // autocomplete array. Defaults to true, which will
374 // match text at the beginning of any *word* in the
375 // strings in the autocomplete array. If you want to
376 // search anywhere in the string, additionally set
377 // the option fullSearch to true (default: off).
379 // - fullSsearch - Search anywhere in autocomplete array strings.
381 // - partialChars - How many characters to enter before triggering
382 // a partial match (unlike minChars, which defines
383 // how many characters are required to do any match
384 // at all). Defaults to 2.
386 // - ignoreCase - Whether to ignore case when autocompleting.
389 // It's possible to pass in a custom function as the 'selector'
390 // option, if you prefer to write your own autocompletion logic.
391 // In that case, the other options above will not apply unless
394 Autocompleter.Local = Class.create();
395 Autocompleter.Local.prototype = Object.extend(new Autocompleter.Base(), {
396 initialize: function(element, update, array, options) {
397 this.baseInitialize(element, update, options);
398 this.options.array = array;
401 getUpdatedChoices: function() {
402 this.updateChoices(this.options.selector(this));
405 setOptions: function(options) {
406 this.options = Object.extend({
412 selector: function(instance) {
413 var ret = []; // Beginning matches
414 var partial = []; // Inside matches
415 var entry = instance.getToken();
418 for (var i = 0; i < instance.options.array.length &&
419 ret.length < instance.options.choices ; i++) {
421 var elem = instance.options.array[i];
422 var foundPos = instance.options.ignoreCase ?
423 elem.toLowerCase().indexOf(entry.toLowerCase()) :
426 while (foundPos != -1) {
427 if (foundPos == 0 && elem.length != entry.length) {
428 ret.push("<li><strong>" + elem.substr(0, entry.length) + "</strong>" +
429 elem.substr(entry.length) + "</li>");
431 } else if (entry.length >= instance.options.partialChars &&
432 instance.options.partialSearch && foundPos != -1) {
433 if (instance.options.fullSearch || /\s/.test(elem.substr(foundPos-1,1))) {
434 partial.push("<li>" + elem.substr(0, foundPos) + "<strong>" +
435 elem.substr(foundPos, entry.length) + "</strong>" + elem.substr(
436 foundPos + entry.length) + "</li>");
441 foundPos = instance.options.ignoreCase ?
442 elem.toLowerCase().indexOf(entry.toLowerCase(), foundPos + 1) :
443 elem.indexOf(entry, foundPos + 1);
448 ret = ret.concat(partial.slice(0, instance.options.choices - ret.length))
449 return "<ul>" + ret.join('') + "</ul>";
455 // AJAX in-place editor
457 // see documentation on http://wiki.script.aculo.us/scriptaculous/show/Ajax.InPlaceEditor
459 // Use this if you notice weird scrolling problems on some browsers,
460 // the DOM might be a bit confused when this gets called so do this
461 // waits 1 ms (with setTimeout) until it does the activation
462 Field.scrollFreeActivate = function(field) {
463 setTimeout(function() {
464 Field.activate(field);
468 Ajax.InPlaceEditor = Class.create();
469 Ajax.InPlaceEditor.defaultHighlightColor = "#FFFF99";
470 Ajax.InPlaceEditor.prototype = {
471 initialize: function(element, url, options) {
473 this.element = $(element);
475 this.options = Object.extend({
480 cancelText: "cancel",
481 savingText: "Saving...",
482 clickToEditText: "Click to edit",
485 onComplete: function(transport, element) {
486 new Effect.Highlight(element, {startcolor: this.options.highlightcolor});
488 onFailure: function(transport) {
489 alert("Error communicating with the server: " + transport.responseText.stripTags());
491 callback: function(form) {
492 return Form.serialize(form);
494 handleLineBreaks: true,
495 loadingText: 'Loading...',
496 savingClassName: 'inplaceeditor-saving',
497 loadingClassName: 'inplaceeditor-loading',
498 formClassName: 'inplaceeditor-form',
499 highlightcolor: Ajax.InPlaceEditor.defaultHighlightColor,
500 highlightendcolor: "#FFFFFF",
501 externalControl: null,
507 if(!this.options.formId && this.element.id) {
508 this.options.formId = this.element.id + "-inplaceeditor";
509 if ($(this.options.formId)) {
510 // there's already a form with that name, don't specify an id
511 this.options.formId = null;
515 if (this.options.externalControl) {
516 this.options.externalControl = $(this.options.externalControl);
519 this.originalBackground = Element.getStyle(this.element, 'background-color');
520 if (!this.originalBackground) {
521 this.originalBackground = "transparent";
524 this.element.title = this.options.clickToEditText;
526 this.onclickListener = this.enterEditMode.bindAsEventListener(this);
527 this.mouseoverListener = this.enterHover.bindAsEventListener(this);
528 this.mouseoutListener = this.leaveHover.bindAsEventListener(this);
529 Event.observe(this.element, 'click', this.onclickListener);
530 Event.observe(this.element, 'mouseover', this.mouseoverListener);
531 Event.observe(this.element, 'mouseout', this.mouseoutListener);
532 if (this.options.externalControl) {
533 Event.observe(this.options.externalControl, 'click', this.onclickListener);
534 Event.observe(this.options.externalControl, 'mouseover', this.mouseoverListener);
535 Event.observe(this.options.externalControl, 'mouseout', this.mouseoutListener);
538 enterEditMode: function(evt) {
539 if (this.saving) return;
540 if (this.editing) return;
542 this.onEnterEditMode();
543 if (this.options.externalControl) {
544 Element.hide(this.options.externalControl);
546 Element.hide(this.element);
548 this.element.parentNode.insertBefore(this.form, this.element);
549 if (!this.options.loadTextURL) Field.scrollFreeActivate(this.editField);
550 // stop the event to avoid a page refresh in Safari
556 createForm: function() {
557 this.form = document.createElement("form");
558 this.form.id = this.options.formId;
559 Element.addClassName(this.form, this.options.formClassName)
560 this.form.onsubmit = this.onSubmit.bind(this);
562 this.createEditField();
564 if (this.options.textarea) {
565 var br = document.createElement("br");
566 this.form.appendChild(br);
569 if (this.options.okButton) {
570 okButton = document.createElement("input");
571 okButton.type = "submit";
572 okButton.value = this.options.okText;
573 okButton.className = 'editor_ok_button';
574 this.form.appendChild(okButton);
577 if (this.options.cancelLink) {
578 cancelLink = document.createElement("a");
579 cancelLink.href = "#";
580 cancelLink.appendChild(document.createTextNode(this.options.cancelText));
581 cancelLink.onclick = this.onclickCancel.bind(this);
582 cancelLink.className = 'editor_cancel';
583 this.form.appendChild(cancelLink);
586 hasHTMLLineBreaks: function(string) {
587 if (!this.options.handleLineBreaks) return false;
588 return string.match(/<br/i) || string.match(/<p>/i);
590 convertHTMLLineBreaks: function(string) {
591 return string.replace(/<br>/gi, "\n").replace(/<br\/>/gi, "\n").replace(/<\/p>/gi, "\n").replace(/<p>/gi, "");
593 createEditField: function() {
595 if(this.options.loadTextURL) {
596 text = this.options.loadingText;
598 text = this.getText();
603 if (this.options.rows == 1 && !this.hasHTMLLineBreaks(text)) {
604 this.options.textarea = false;
605 var textField = document.createElement("input");
606 textField.obj = this;
607 textField.type = "text";
608 textField.name = this.options.paramName;
609 textField.value = text;
610 textField.style.backgroundColor = this.options.highlightcolor;
611 textField.className = 'editor_field';
612 var size = this.options.size || this.options.cols || 0;
613 if (size != 0) textField.size = size;
614 if (this.options.submitOnBlur)
615 textField.onblur = this.onSubmit.bind(this);
616 this.editField = textField;
618 this.options.textarea = true;
619 var textArea = document.createElement("textarea");
621 textArea.name = this.options.paramName;
622 textArea.value = this.convertHTMLLineBreaks(text);
623 textArea.rows = this.options.rows;
624 textArea.cols = this.options.cols || 40;
625 textArea.className = 'editor_field';
626 if (this.options.submitOnBlur)
627 textArea.onblur = this.onSubmit.bind(this);
628 this.editField = textArea;
631 if(this.options.loadTextURL) {
632 this.loadExternalText();
634 this.form.appendChild(this.editField);
636 getText: function() {
637 return this.element.innerHTML;
639 loadExternalText: function() {
640 Element.addClassName(this.form, this.options.loadingClassName);
641 this.editField.disabled = true;
643 this.options.loadTextURL,
646 onComplete: this.onLoadedExternalText.bind(this)
647 }, this.options.ajaxOptions)
650 onLoadedExternalText: function(transport) {
651 Element.removeClassName(this.form, this.options.loadingClassName);
652 this.editField.disabled = false;
653 this.editField.value = transport.responseText.stripTags();
654 Field.scrollFreeActivate(this.editField);
656 onclickCancel: function() {
658 this.leaveEditMode();
661 onFailure: function(transport) {
662 this.options.onFailure(transport);
663 if (this.oldInnerHTML) {
664 this.element.innerHTML = this.oldInnerHTML;
665 this.oldInnerHTML = null;
669 onSubmit: function() {
670 // onLoading resets these so we need to save them away for the Ajax call
671 var form = this.form;
672 var value = this.editField.value;
674 // do this first, sometimes the ajax call returns before we get a chance to switch on Saving...
675 // which means this will actually switch on Saving... *after* we've left edit mode causing Saving...
676 // to be displayed indefinitely
679 if (this.options.evalScripts) {
681 this.url, Object.extend({
682 parameters: this.options.callback(form, value),
683 onComplete: this.onComplete.bind(this),
684 onFailure: this.onFailure.bind(this),
687 }, this.options.ajaxOptions));
690 { success: this.element,
691 // don't update on failure (this could be an option)
693 this.url, Object.extend({
694 parameters: this.options.callback(form, value),
695 onComplete: this.onComplete.bind(this),
696 onFailure: this.onFailure.bind(this)
697 }, this.options.ajaxOptions));
699 // stop the event to avoid a page refresh in Safari
700 if (arguments.length > 1) {
701 Event.stop(arguments[0]);
705 onLoading: function() {
711 showSaving: function() {
712 this.oldInnerHTML = this.element.innerHTML;
713 this.element.innerHTML = this.options.savingText;
714 Element.addClassName(this.element, this.options.savingClassName);
715 this.element.style.backgroundColor = this.originalBackground;
716 Element.show(this.element);
718 removeForm: function() {
720 if (this.form.parentNode) Element.remove(this.form);
724 enterHover: function() {
725 if (this.saving) return;
726 this.element.style.backgroundColor = this.options.highlightcolor;
728 this.effect.cancel();
730 Element.addClassName(this.element, this.options.hoverClassName)
732 leaveHover: function() {
733 if (this.options.backgroundColor) {
734 this.element.style.backgroundColor = this.oldBackground;
736 Element.removeClassName(this.element, this.options.hoverClassName)
737 if (this.saving) return;
738 this.effect = new Effect.Highlight(this.element, {
739 startcolor: this.options.highlightcolor,
740 endcolor: this.options.highlightendcolor,
741 restorecolor: this.originalBackground
744 leaveEditMode: function() {
745 Element.removeClassName(this.element, this.options.savingClassName);
748 this.element.style.backgroundColor = this.originalBackground;
749 Element.show(this.element);
750 if (this.options.externalControl) {
751 Element.show(this.options.externalControl);
753 this.editing = false;
755 this.oldInnerHTML = null;
756 this.onLeaveEditMode();
758 onComplete: function(transport) {
759 this.leaveEditMode();
760 this.options.onComplete.bind(this)(transport, this.element);
762 onEnterEditMode: function() {},
763 onLeaveEditMode: function() {},
764 dispose: function() {
765 if (this.oldInnerHTML) {
766 this.element.innerHTML = this.oldInnerHTML;
768 this.leaveEditMode();
769 Event.stopObserving(this.element, 'click', this.onclickListener);
770 Event.stopObserving(this.element, 'mouseover', this.mouseoverListener);
771 Event.stopObserving(this.element, 'mouseout', this.mouseoutListener);
772 if (this.options.externalControl) {
773 Event.stopObserving(this.options.externalControl, 'click', this.onclickListener);
774 Event.stopObserving(this.options.externalControl, 'mouseover', this.mouseoverListener);
775 Event.stopObserving(this.options.externalControl, 'mouseout', this.mouseoutListener);
780 Ajax.InPlaceCollectionEditor = Class.create();
781 Object.extend(Ajax.InPlaceCollectionEditor.prototype, Ajax.InPlaceEditor.prototype);
782 Object.extend(Ajax.InPlaceCollectionEditor.prototype, {
783 createEditField: function() {
784 if (!this.cached_selectTag) {
785 var selectTag = document.createElement("select");
786 var collection = this.options.collection || [];
788 collection.each(function(e,i) {
789 optionTag = document.createElement("option");
790 optionTag.value = (e instanceof Array) ? e[0] : e;
791 if((typeof this.options.value == 'undefined') &&
792 ((e instanceof Array) ? this.element.innerHTML == e[1] : e == optionTag.value)) optionTag.selected = true;
793 if(this.options.value==optionTag.value) optionTag.selected = true;
794 optionTag.appendChild(document.createTextNode((e instanceof Array) ? e[1] : e));
795 selectTag.appendChild(optionTag);
797 this.cached_selectTag = selectTag;
800 this.editField = this.cached_selectTag;
801 if(this.options.loadTextURL) this.loadExternalText();
802 this.form.appendChild(this.editField);
803 this.options.callback = function(form, value) {
804 return "value=" + encodeURIComponent(value);
809 // Delayed observer, like Form.Element.Observer,
810 // but waits for delay after last key input
811 // Ideal for live-search fields
813 Form.Element.DelayedObserver = Class.create();
814 Form.Element.DelayedObserver.prototype = {
815 initialize: function(element, delay, callback) {
816 this.delay = delay || 0.5;
817 this.element = $(element);
818 this.callback = callback;
820 this.lastValue = $F(this.element);
821 Event.observe(this.element,'keyup',this.delayedListener.bindAsEventListener(this));
823 delayedListener: function(event) {
824 if(this.lastValue == $F(this.element)) return;
825 if(this.timer) clearTimeout(this.timer);
826 this.timer = setTimeout(this.onTimerEvent.bind(this), this.delay * 1000);
827 this.lastValue = $F(this.element);
829 onTimerEvent: function() {
831 this.callback(this.element, $F(this.element));