[DS-236] Authority control for metadata fields and Choice Authority plugin framework

git-svn-id: http://scm.dspace.org/svn/repo/dspace/trunk@4365 9c30dcfa-912a-0410-8fc2-9e0234be79fd

dspace-ui-shared/src/main/webapp/static/js/choice-support.js

@@ -0,0 +1,575 @@
+/*
+ * choice-support.js
+ *
+ * Version: $Revision: 3705 $
+ *
+ * Date: $Date: 2009-04-11 13:02:24 -0400 (Sat, 11 Apr 2009) $
+ *
+ * Copyright (c) 2002-2009, The DSpace Foundation.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * - Neither the name of the DSpace Foundation nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+ * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ */
+
+// Client-side scripting to support DSpace Choice Control
+
+// IMPORTANT NOTE:
+//  This code depends on a *MODIFIED* version of the
+//  script.aculo.us controls v1.8.2, fixed to avoid a bug that
+//  affects autocomplete in Firefox 3.  This code is included in DSpace.
+
+// Entry points:
+//  1. DSpaceAutocomplete -- add autocomplete (suggest) to an input field
+//
+//  2.  DSpaceChoiceLookup -- create popup window with authority choices
+//
+//  @Author: Larry Stone  <lcs@hulmail.harvard.edu>
+//  $Revision $
+
+// -------------------- support for Autocomplete (Suggest)
+
+// Autocomplete utility:
+// Arguments:
+//   formID -- ID attribute of form tag
+//   args properties:
+//     metadataField -- metadata field e.g. dc_contributor_author
+//     inputName -- input field name for text input, or base of "Name" pair
+//     authorityName -- input field name in which to set authority
+//     containerID -- ID attribute of DIV to hold the menu objects
+//     indicatorID -- ID attribute of element to use as a "loading" indicator
+//     confidenceIndicatorID -- ID of element on which to set confidence
+//     confidenceName - NAME of confidence input (not ID)
+//     contextPath -- URL path prefix (i.e. webapp contextPath) for DSpace.
+//     collection -- db ID of dspace collection to serve as context
+//     isClosed -- true if authority value is required, false = non-auth allowed
+// XXX Can't really enforce "isClosed=true" with autocomplete, user can type anything
+//
+// NOTE: Successful autocomplete always sets confidence to 'accepted' since
+//  authority value (if any) *was* chosen interactively by a human.
+function DSpaceSetupAutocomplete(formID, args)
+{
+    if (args.authorityName == null)
+        args.authorityName = dspace_makeFieldInput(args.inputName,'_authority');
+    var form = document.getElementById(formID);
+    var inputID = form.elements[args.inputName].id;
+    var authorityID = null;
+    if (form.elements[args.authorityName] != null)
+        authorityID = form.elements[args.authorityName].id;
+
+    // AJAX menu source, can add &query=TEXT
+    var choiceURL = args.contextPath+"/choices/"+args.metadataField;
+
+    var collID = args.collection == null ? -1 : args.collection;
+
+    // field in whcih to store authority value
+    var options =
+      {
+        // class name of spans that contain value in li elements
+        select: "value",
+        // make up query args for AJAX callback
+        parameters: 'collection='+collID+'&format=ul',
+        callback:
+          function(inField, querystring) {
+            return querystring+"&query="+inField.value;
+          },
+        // called after target field is updated
+        afterUpdateElement:
+          function(ignoreField, li)
+            {
+                // NOTE: lookup element late because it might not be in DOM
+                // at the time we evaluate the function..
+                var authInput = document.getElementById(authorityID);
+                var authValue = li == null ? "" : li.getAttribute("authority");
+                if (authInput != null)
+                {
+                    authInput.value = authValue;
+                    // update confidence input's value too if available.
+                    if (args.confidenceName != null)
+                    {
+                        var confInput = authInput.form.elements[args.confidenceName];
+                        if (confInput != null)
+                            confInput.value = 'accepted';
+                    }
+                }
+                // make indicator blank if no authority value
+                DSpaceUpdateConfidence(document, args.confidenceIndicatorID,
+                    authValue == null || authValue == '' ? 'blank' :'accepted');
+            }
+      };
+
+      if (args.indicatorID != null)
+          options.indicator = args.indicatorID;
+
+    // be sure to turn off autocomplete, it absorbs arrow-key events!
+    form.elements[args.inputName].setAttribute("autocomplete", "off");
+
+    new Ajax.Autocompleter(inputID, args.containerID, choiceURL, options);
+}
+
+// -------------------- support for Lookup Popup
+
+// Create popup window with authority choices for value of an input field.
+// This is intended to be called by onClick of a "Lookup" or "Add"  button.
+function DSpaceChoiceLookup(url, field, formID, valueInput, authInput,
+    confIndicatorID, collectionID, isName, isRepeating)
+{
+    // fill in URL
+    url += '?field='+field+'&formID='+formID+'&valueInput='+valueInput+
+             '&authorityInput='+authInput+'&collection='+collectionID+
+             '&isName='+isName+'&isRepeating='+isRepeating+'&confIndicatorID='+confIndicatorID;
+
+    // primary input field - for positioning popup.
+    var inputFieldName = isName ? dspace_makeFieldInput(valueInput,'_last') : valueInput;
+    var inputField = document.getElementById(formID).elements[inputFieldName];
+    // scriptactulous magic to figure out true offset:
+    var cOffset = 0;
+    if (inputField != null)
+        cOffset = $(inputField).cumulativeOffset();
+    var width = 600;  // XXX guesses! these should be params, or configured..
+    var height = 470;
+    var left; var top;
+    if (window.screenX == null) {
+        left = window.screenLeft + cOffset.left - (width/2);
+        top = window.screenTop + cOffset.top - (height/2);
+    } else {
+        left = window.screenX + cOffset.left - (width/2);
+        top = window.screenY + cOffset.top - (height/2);
+    }
+    if (left < 0) left = 0;
+    if (top < 0) top = 0;
+    var pw = window.open(url, 'ignoreme',
+         'width='+width+',height='+height+',left='+left+',top='+top+
+         ',toolbar=no,menubar=no,location=no,status=no,resizable');
+    if (window.focus) pw.focus();
+    return false;
+}
+
+// Run this as the Lookup page is loaded to initialize DOM objects, load choices
+function DSpaceChoicesSetup(form)
+{
+    // find the "LEGEND" in fieldset, which acts as page title,
+    // and save it as a bogus form element, e.g. elements['statline']
+    var fieldset = document.getElementById('aspect_general_ChoiceLookupTransformer_list_choicesList');
+    for (i = 0; i < fieldset.childNodes.length; ++i)
+    {
+      if (fieldset.childNodes[i].nodeName == 'LEGEND')
+      {
+          form.statline = fieldset.childNodes[i];
+          form.statline_template = fieldset.childNodes[i].innerHTML;
+          fieldset.childNodes[i].innerHTML = "Loading...";
+          break;
+      }
+    }
+    DSpaceChoicesLoad(form);
+}
+
+
+// populate the "select" with options from ajax request
+// stash some parameters as properties of the "select" so we can add to
+// the last start index to query for next set of results.
+function DSpaceChoicesLoad(form)
+{
+    var field = form.elements['paramField'].value;
+    var value = form.elements['paramValue'].value;
+    var start = form.elements['paramStart'].value;
+    var limit = form.elements['paramLimit'].value;
+    var formID = form.elements['paramFormID'].value;
+    var collID = form.elements['paramCollection'].value;
+    var isName = form.elements['paramIsName'].value == 'true';
+    var isRepeating = form.elements['paramIsRepeating'].value == 'true';
+    var isClosed = form.elements['paramIsClosed'].value == 'true';
+    var contextPath = form.elements['contextPath'].value;
+    var fail = form.elements['paramFail'].value;
+    var nonAuthority = "";
+    if (form.elements['paramNonAuthority'] != null)
+        nonAuthority = form.elements['paramNonAuthority'].value;
+
+    // get value from form inputs in opener if not explicitly supplied
+    if (value.length == 0)
+    {
+        var of = window.opener.document.getElementById(formID);
+        var valueInput = form.elements['paramValueInput'].value;
+        if (isName)
+            value = makePersonName(of.elements[dspace_makeFieldInput(valueInput,'_last')].value,
+                                   of.elements[dspace_makeFieldInput(valueInput,'_first')].value);
+        else
+            value = of.elements[valueInput].value;
+    }
+
+    // start spinner
+    var indicator = document.getElementById('lookup_indicator_id');
+    if (indicator != null)
+        indicator.style.display = "inline";
+
+    new Ajax.Request(contextPath+"/choices/"+field,
+      {
+        method: "get",
+        parameters: {query: value, format: 'select', collection: collID,
+                     start: start, limit: limit},
+        // triggered by any exception, even in success
+        onException: function(req, e) {
+          window.alert(fail+" Exception="+e);
+          if (indicator != null) indicator.style.display = "none";
+        },
+        // when http load of choices fails
+        onFailure: function() {
+          window.alert(fail+" HTTP error resonse");
+          if (indicator != null) indicator.style.display = "none";
+        },
+        // format is <select><option authority="key" value="val">label</option>...
+        onSuccess: function(transport) {
+          var ul = transport.responseXML.firstChild;
+          var err = ul.getAttributeNode('error');
+          if (err != null && err.value == 'true')
+              window.alert(fail+" Server indicates error in response.");
+          var opts = ul.getElementsByTagName('option');
+
+          // update range message and update 'more' button
+          var oldStart = 1 * ul.getAttributeNode('start').value;
+          var nextStart = oldStart + opts.length;
+          var lastTotal = ul.getAttributeNode('total').value;
+          var resultMore = ul.getAttributeNode('more');
+          form.elements['more'].disabled = !(resultMore != null && resultMore.value == 'true');
+          form.elements['paramStart'].value = nextStart;
+
+          // clear select first
+          var select = form.elements['chooser'];
+          for (var i = select.length-1; i >= 0; --i)
+            select.remove(i);
+
+          // load select and look for default selection
+          var selectedByValue = -1; // select by value match
+          var selectedByChoices = -1;  // Choice says its selected
+          for (var i = 0; i < opts.length; ++i)
+          {
+            var opt = opts.item(i);
+            var olabel = "";
+            for (var j = 0; j < opt.childNodes.length; ++j)
+            {
+               var node = opt.childNodes[j];
+               if (node.nodeName == "#text")
+                 olabel += node.data;
+            }
+            var ovalue = opt.getAttributeNode('value').value;
+            var option = new Option(olabel, ovalue);
+            option.authority = opt.getAttributeNode('authority').value;
+            select.add(option, null);
+            if (value == ovalue)
+                selectedByValue = select.options.length - 1;
+            if (opt.getAttributeNode('selected') != null)
+                selectedByChoices = select.options.length - 1;
+          }
+          // add non-authority option if needed.
+          if (!isClosed)
+          {
+            select.add(new Option(dspace_formatMessage(nonAuthority, value), value), null);
+          }
+          var defaultSelected = -1;
+          if (selectedByChoices >= 0)
+            defaultSelected = selectedByChoices;
+          else if (selectedByValue >= 0)
+            defaultSelected = selectedByValue;
+          else if (select.options.length == 1)
+            defaultSelected = 0;
+
+          // load default-selected value
+          if (defaultSelected >= 0)
+          {
+            select.options[defaultSelected].defaultSelected = true;
+            var so = select.options[defaultSelected];
+            if (isName)
+            {
+                form.elements['text1'].value = lastNameOf(so.value);
+                form.elements['text2'].value = firstNameOf(so.value);
+            }
+            else
+                form.elements['text1'].value = so.value;
+          }
+
+          // turn off spinner
+          if (indicator != null)
+              indicator.style.display = "none";
+
+          // "results" status line
+          var statLast =  nextStart + (isClosed ? 2 : 1);
+
+          form.statline.innerHTML =
+            dspace_formatMessage(form.statline_template,
+              oldStart+1, statLast, Math.max(lastTotal,statLast), value);
+        }
+      });
+}
+
+// handler for change event on choice selector - load new values
+function DSpaceChoicesSelectOnChange ()
+{
+    // "this" is the window,
+    var form = document.getElementById('aspect_general_ChoiceLookupTransformer_div_lookup');
+    var select = form.elements['chooser'];
+    var so = select.options[select.selectedIndex];
+    var isName = form.elements['paramIsName'].value == 'true';
+
+    if (isName)
+    {
+        form.elements['text1'].value = lastNameOf(so.value);
+        form.elements['text2'].value = firstNameOf(so.value);
+    }
+    else
+        form.elements['text1'].value = so.value;
+}
+
+// handler for lookup popup's accept (or add) button
+//  stuff values back to calling page, force an add if necessary, and close.
+function DSpaceChoicesAcceptOnClick ()
+{
+    var select = this.form.elements['chooser'];
+    var isName = this.form.elements['paramIsName'].value == 'true';
+    var isRepeating = this.form.elements['paramIsRepeating'].value == 'true';
+    var valueInput = this.form.elements['paramValueInput'].value;
+    var authorityInput = this.form.elements['paramAuthorityInput'].value;
+    var formID = this.form.elements['paramFormID'].value;
+    var confIndicatorID = this.form.elements['paramConfIndicatorID'] == null?null:this.form.elements['paramConfIndicatorID'].value;
+
+    // default the authority input if not supplied.
+    if (authorityInput.length == 0)
+        authorityInput = dspace_makeFieldInput(valueInput,'_authority');
+
+    // always stuff text fields back into caller's value input(s)
+    if (valueInput.length > 0)
+    {
+        var of = window.opener.document.getElementById(formID);
+        if (isName)
+        {
+            of.elements[dspace_makeFieldInput(valueInput,'_last')].value = this.form.elements['text1'].value;
+            of.elements[dspace_makeFieldInput(valueInput,'_first')].value = this.form.elements['text2'].value;
+        }
+        else
+            of.elements[valueInput].value = this.form.elements['text1'].value;
+
+        if (authorityInput.length > 0 && of.elements[authorityInput] != null)
+        {
+            // conf input is auth input, substitute '_confidence' for '_authority'
+            // if conf fieldname is  FIELD_confidence_NUMBER, then '_authority_' => '_confidence_'
+            var confInput = "";
+
+            var ci = authorityInput.lastIndexOf("_authority_");
+            if (ci < 0)
+                confInput = authorityInput.substring(0, authorityInput.length-10)+'_confidence';
+            else
+                confInput = authorityInput.substring(0, ci)+"_confidence_"+authorityInput.substring(ci+11);
+            // DEBUG:
+            // window.alert('Setting fields auth="'+authorityInput+'", conf="'+confInput+'"');
+
+            var authValue = null;
+            if (select.selectedIndex >= 0 && select.options[select.selectedIndex].authority != null)
+            {
+                authValue = select.options[select.selectedIndex].authority;
+                of.elements[authorityInput].value = authValue;
+            }
+            if (of.elements[confInput] != null)
+                of.elements[confInput].value = 'accepted';
+            // make indicator blank if no authority value
+            DSpaceUpdateConfidence(window.opener.document, confIndicatorID,
+                    authValue == null || authValue == '' ? 'blank' :'accepted');
+        }
+
+        // force the submit button -- if there is an "add"
+        if (isRepeating)
+        {
+            var add = of.elements["submit_"+valueInput+"_add"];
+            if (add != null)
+                add.click();
+            else
+                alert('Sanity check: Cannot find button named "submit_'+valueInput+'_add"');
+        }
+    }
+    window.close();
+    return false;
+}
+
+// handler for lookup popup's more button
+function DSpaceChoicesMoreOnClick ()
+{
+    DSpaceChoicesLoad(this.form);
+}
+
+// handler for lookup popup's cancel button
+function DSpaceChoicesCancelOnClick ()
+{
+    window.close();
+    return false;
+}
+
+// -------------------- Utilities
+
+// DSpace person-name conventions, see DCPersonName
+function makePersonName(lastName, firstName)
+{
+    return (firstName == null || firstName.length == 0) ? lastName :
+        lastName+", "+firstName;
+}
+
+// DSpace person-name conventions, see DCPersonName
+function firstNameOf(personName)
+{
+    var comma = personName.indexOf(",");
+    return (comma < 0) ? "" : stringTrim(personName.substring(comma+1));
+}
+
+// DSpace person-name conventions, see DCPersonName
+function lastNameOf(personName)
+{
+    var comma = personName.indexOf(",");
+    return stringTrim((comma < 0) ? personName : personName.substring(0, comma));
+}
+
+// replicate java String.trim()
+function stringTrim(str)
+{
+    var start = 0;
+    var end = str.length;
+    for (; str.charAt(start) == ' '&& start < end; ++start) ;
+    for (; end > start && str.charAt(end-1) == ' '; --end) ;
+    return str.slice(start, end);
+}
+
+// format utility - replace @1@, @2@ etc with args 1, 2, 3..
+// NOTE params MUST be monotonically increasing
+// NOTE we can't use "{1}" like the i18n catalog because it elides them!!
+// ...UNLESS maybe it were to be fixed not to when no params...
+function dspace_formatMessage()
+{
+    var template = dspace_formatMessage.arguments[0];
+    var i;
+    for (i = 1; i < arguments.length; ++i)
+    {
+        var pattern = '@'+i+'@';
+        if (template.search(pattern) >= 0)
+            template = template.replace(pattern, dspace_formatMessage.arguments[i]);
+    }
+    return template;
+}
+
+// utility to make sub-field name of input field, e.g. _last, _first, _auth..
+// if name ends with _1, _2 etc, put sub-name BEFORE the number
+function dspace_makeFieldInput(name, sub)
+{
+    var i = name.search("_[0-9]+$");
+    if (i < 0)
+        return name+sub;
+    else
+        return name.substr(0, i)+sub+name.substr(i);
+}
+
+// update the class value of confidence-indicating element
+function DSpaceUpdateConfidence(doc, confIndicatorID, newValue)
+{
+    // sanity checks - need valid ID and a real DOM object
+    if (confIndicatorID == null || confIndicatorID == "")
+        return;
+    var confElt = doc.getElementById(confIndicatorID);
+    if (confElt == null)
+        return;
+
+    // add or update CSS class with new confidence value, e.g. "cf-accepted".
+    if (confElt.className == null)
+        confElt.className = "cf-"+newValue;
+    else
+    {
+        var classes = confElt.className.split(" ");
+        var newClasses = "";
+        var found = false;
+        for (var i = 0; i < classes.length; ++i)
+        {
+            if (classes[i].match('^cf-[a-zA-Z0-9]+$'))
+            {
+                newClasses += "cf-"+newValue+" ";
+                found = true;
+            }
+            else
+                newClasses += classes[i]+" ";
+        }
+        if (!found)
+            newClasses += "cf-"+newValue+" ";
+        confElt.className = newClasses;
+    }
+}
+
+// respond to "onchanged" event on authority input field
+// set confidence to 'accepted' if authority was changed by user.
+function DSpaceAuthorityOnChange(self, confValueID, confIndicatorID)
+{
+    var confidence = 'accepted';
+    if (confValueID != null && confValueID != '')
+    {
+        var confValueField = document.getElementById(confValueID);
+        if (confValueField != null)
+            confValueField.value = confidence;
+    }
+    DSpaceUpdateConfidence(document, confIndicatorID, confidence)
+    return false;
+}
+
+// respond to click on the authority-value lock button in Edit Item Metadata:
+// "button" is bound to the image input for the lock button, "this"
+function DSpaceToggleAuthorityLock(button, authInputID)
+{
+    // sanity checks - need valid ID and a real DOM object
+    if (authInputID == null || authInputID == '')
+        return false;
+    var authInput = document.getElementById(authInputID);
+    if (authInput == null)
+        return false;
+
+    // look for is-locked or is-unlocked in class list:
+    var classes = button.className.split(' ');
+    var newClass = '';
+    var newLocked = false;
+    var found = false;
+    for (var i = 0; i < classes.length; ++i)
+    {
+        if (classes[i] == 'is-locked')
+        {
+            newLocked = false;
+            found = true;
+        }
+        else if (classes[i] == 'is-unlocked')
+        {
+            newLocked = true;
+            found = true;
+        }
+        else
+            newClass += classes[i]+' ';
+    }
+    if (!found)
+        return false;
+    // toggle the image, and set readability
+    button.className = newClass + (newLocked ? 'is-locked' : 'is-unlocked') + ' ';
+    authInput.readOnly = newLocked;
+    return false;
+}

dspace-ui-shared/src/main/webapp/static/js/scriptaculous/builder.js

@@ -0,0 +1,136 @@
+// script.aculo.us builder.js v1.8.2, Tue Nov 18 18:30:58 +0100 2008
+
+// Copyright (c) 2005-2008 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us)
+//
+// script.aculo.us is freely distributable under the terms of an MIT-style license.
+// For details, see the script.aculo.us web site: http://script.aculo.us/
+
+var Builder = {
+  NODEMAP: {
+    AREA: 'map',
+    CAPTION: 'table',
+    COL: 'table',
+    COLGROUP: 'table',
+    LEGEND: 'fieldset',
+    OPTGROUP: 'select',
+    OPTION: 'select',
+    PARAM: 'object',
+    TBODY: 'table',
+    TD: 'table',
+    TFOOT: 'table',
+    TH: 'table',
+    THEAD: 'table',
+    TR: 'table'
+  },
+  // note: For Firefox < 1.5, OPTION and OPTGROUP tags are currently broken,
+  //       due to a Firefox bug
+  node: function(elementName) {
+    elementName = elementName.toUpperCase();
+
+    // try innerHTML approach
+    var parentTag = this.NODEMAP[elementName] || 'div';
+    var parentElement = document.createElement(parentTag);
+    try { // prevent IE "feature": http://dev.rubyonrails.org/ticket/2707
+      parentElement.innerHTML = "<" + elementName + "></" + elementName + ">";
+    } catch(e) {}
+    var element = parentElement.firstChild || null;
+
+    // see if browser added wrapping tags
+    if(element && (element.tagName.toUpperCase() != elementName))
+      element = element.getElementsByTagName(elementName)[0];
+
+    // fallback to createElement approach
+    if(!element) element = document.createElement(elementName);
+
+    // abort if nothing could be created
+    if(!element) return;
+
+    // attributes (or text)
+    if(arguments[1])
+      if(this._isStringOrNumber(arguments[1]) ||
+        (arguments[1] instanceof Array) ||
+        arguments[1].tagName) {
+          this._children(element, arguments[1]);
+        } else {
+          var attrs = this._attributes(arguments[1]);
+          if(attrs.length) {
+            try { // prevent IE "feature": http://dev.rubyonrails.org/ticket/2707
+              parentElement.innerHTML = "<" +elementName + " " +
+                attrs + "></" + elementName + ">";
+            } catch(e) {}
+            element = parentElement.firstChild || null;
+            // workaround firefox 1.0.X bug
+            if(!element) {
+              element = document.createElement(elementName);
+              for(attr in arguments[1])
+                element[attr == 'class' ? 'className' : attr] = arguments[1][attr];
+            }
+            if(element.tagName.toUpperCase() != elementName)
+              element = parentElement.getElementsByTagName(elementName)[0];
+          }
+        }
+
+    // text, or array of children
+    if(arguments[2])
+      this._children(element, arguments[2]);
+
+     return $(element);
+  },
+  _text: function(text) {
+     return document.createTextNode(text);
+  },
+
+  ATTR_MAP: {
+    'className': 'class',
+    'htmlFor': 'for'
+  },
+
+  _attributes: function(attributes) {
+    var attrs = [];
+    for(attribute in attributes)
+      attrs.push((attribute in this.ATTR_MAP ? this.ATTR_MAP[attribute] : attribute) +
+          '="' + attributes[attribute].toString().escapeHTML().gsub(/"/,'&quot;') + '"');
+    return attrs.join(" ");
+  },
+  _children: function(element, children) {
+    if(children.tagName) {
+      element.appendChild(children);
+      return;
+    }
+    if(typeof children=='object') { // array can hold nodes and text
+      children.flatten().each( function(e) {
+        if(typeof e=='object')
+          element.appendChild(e);
+        else
+          if(Builder._isStringOrNumber(e))
+            element.appendChild(Builder._text(e));
+      });
+    } else
+      if(Builder._isStringOrNumber(children))
+        element.appendChild(Builder._text(children));
+  },
+  _isStringOrNumber: function(param) {
+    return(typeof param=='string' || typeof param=='number');
+  },
+  build: function(html) {
+    var element = this.node('div');
+    $(element).update(html.strip());
+    return element.down();
+  },
+  dump: function(scope) {
+    if(typeof scope != 'object' && typeof scope != 'function') scope = window; //global scope
+
+    var tags = ("A ABBR ACRONYM ADDRESS APPLET AREA B BASE BASEFONT BDO BIG BLOCKQUOTE BODY " +
+      "BR BUTTON CAPTION CENTER CITE CODE COL COLGROUP DD DEL DFN DIR DIV DL DT EM FIELDSET " +
+      "FONT FORM FRAME FRAMESET H1 H2 H3 H4 H5 H6 HEAD HR HTML I IFRAME IMG INPUT INS ISINDEX "+
+      "KBD LABEL LEGEND LI LINK MAP MENU META NOFRAMES NOSCRIPT OBJECT OL OPTGROUP OPTION P "+
+      "PARAM PRE Q S SAMP SCRIPT SELECT SMALL SPAN STRIKE STRONG STYLE SUB SUP TABLE TBODY TD "+
+      "TEXTAREA TFOOT TH THEAD TITLE TR TT U UL VAR").split(/\s+/);
+
+    tags.each( function(tag){
+      scope[tag] = function() {
+        return Builder.node.apply(Builder, [tag].concat($A(arguments)));
+      };
+    });
+  }
+};

dspace-ui-shared/src/main/webapp/static/js/scriptaculous/controls.js

@@ -0,0 +1,980 @@
+// script.aculo.us controls.js v1.8.2, Tue Nov 18 18:30:58 +0100 2008
+
+// Copyright (c) 2005-2008 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us)
+//           (c) 2005-2008 Ivan Krstic (http://blogs.law.harvard.edu/ivan)
+//           (c) 2005-2008 Jon Tirsen (http://www.tirsen.com)
+// Contributors:
+//  Richard Livsey
+//  Rahul Bhargava
+//  Rob Wills
+//
+// script.aculo.us is freely distributable under the terms of an MIT-style license.
+// For details, see the script.aculo.us web site: http://script.aculo.us/
+
+// Autocompleter.Base handles all the autocompletion functionality
+// that's independent of the data source for autocompletion. This
+// includes drawing the autocompletion menu, observing keyboard
+// and mouse events, and similar.
+//
+// Specific autocompleters need to provide, at the very least,
+// a getUpdatedChoices function that will be invoked every time
+// the text inside the monitored textbox changes. This method
+// should get the text for which to provide autocompletion by
+// invoking this.getToken(), NOT by directly accessing
+// this.element.value. This is to allow incremental tokenized
+// autocompletion. Specific auto-completion logic (AJAX, etc)
+// belongs in getUpdatedChoices.
+//
+// Tokenized incremental autocompletion is enabled automatically
+// when an autocompleter is instantiated with the 'tokens' option
+// in the options parameter, e.g.:
+// new Ajax.Autocompleter('id','upd', '/url/', { tokens: ',' });
+// will incrementally autocomplete with a comma as the token.
+// Additionally, ',' in the above example can be replaced with
+// a token array, e.g. { tokens: [',', '\n'] } which
+// enables autocompletion on multiple tokens. This is most
+// useful when one of the tokens is \n (a newline), as it
+// allows smart autocompletion after linebreaks.
+
+if(typeof Effect == 'undefined')
+  throw("controls.js requires including script.aculo.us' effects.js library");
+
+var Autocompleter = { };
+Autocompleter.Base = Class.create({
+  baseInitialize: function(element, update, options) {
+    element          = $(element);
+    this.element     = element;
+    this.update      = $(update);
+    this.hasFocus    = false;
+    this.changed     = false;
+    this.active      = false;
+    this.index       = 0;
+    this.entryCount  = 0;
+    this.oldElementValue = this.element.value;
+
+    if(this.setOptions)
+      this.setOptions(options);
+    else
+      this.options = options || { };
+
+    this.options.paramName    = this.options.paramName || this.element.name;
+    this.options.tokens       = this.options.tokens || [];
+    this.options.frequency    = this.options.frequency || 0.4;
+    this.options.minChars     = this.options.minChars || 1;
+    this.options.onShow       = this.options.onShow ||
+      function(element, update){
+        if(!update.style.position || update.style.position=='absolute') {
+          update.style.position = 'absolute';
+          Position.clone(element, update, {
+            setHeight: false,
+            offsetTop: element.offsetHeight
+          });
+        }
+        Effect.Appear(update,{duration:0.15});
+      };
+    this.options.onHide = this.options.onHide ||
+      function(element, update){ new Effect.Fade(update,{duration:0.15}) };
+
+    if(typeof(this.options.tokens) == 'string')
+      this.options.tokens = new Array(this.options.tokens);
+    // Force carriage returns as token delimiters anyway
+    if (!this.options.tokens.include('\n'))
+      this.options.tokens.push('\n');
+
+    this.observer = null;
+
+    this.element.setAttribute('autocomplete','off');
+
+    Element.hide(this.update);
+
+    Event.observe(this.element, 'blur', this.onBlur.bindAsEventListener(this));
+    Event.observe(this.element, 'keydown', this.onKeyPress.bindAsEventListener(this));
+  },
+
+  show: function() {
+    if(Element.getStyle(this.update, 'display')=='none') this.options.onShow(this.element, this.update);
+    if(!this.iefix &&
+      (Prototype.Browser.IE) &&
+      (Element.getStyle(this.update, 'position')=='absolute')) {
+      new Insertion.After(this.update,
+       '<iframe id="' + this.update.id + '_iefix" '+
+       'style="display:none;position:absolute;filter:progid:DXImageTransform.Microsoft.Alpha(opacity=0);" ' +
+       'src="javascript:false;" frameborder="0" scrolling="no"></iframe>');
+      this.iefix = $(this.update.id+'_iefix');
+    }
+    if(this.iefix) setTimeout(this.fixIEOverlapping.bind(this), 50);
+  },
+
+  fixIEOverlapping: function() {
+    Position.clone(this.update, this.iefix, {setTop:(!this.update.style.height)});
+    this.iefix.style.zIndex = 1;
+    this.update.style.zIndex = 2;
+    Element.show(this.iefix);
+  },
+
+  hide: function() {
+    this.stopIndicator();
+    if(Element.getStyle(this.update, 'display')!='none') this.options.onHide(this.element, this.update);
+    if(this.iefix) Element.hide(this.iefix);
+  },
+
+  startIndicator: function() {
+    if(this.options.indicator) Element.show(this.options.indicator);
+  },
+
+  stopIndicator: function() {
+    if(this.options.indicator) Element.hide(this.options.indicator);
+  },
+
+  onKeyPress: function(event) {
+    if(this.active)
+      switch(event.keyCode) {
+       case Event.KEY_TAB:
+       case Event.KEY_RETURN:
+         this.selectEntry();
+         Event.stop(event);
+       case Event.KEY_ESC:
+         this.hide();
+         this.active = false;
+         Event.stop(event);
+         return;
+       case Event.KEY_LEFT:
+       case Event.KEY_RIGHT:
+         return;
+       case Event.KEY_UP:
+         this.markPrevious();
+         this.render();
+         Event.stop(event);
+         return;
+       case Event.KEY_DOWN:
+         this.markNext();
+         this.render();
+         Event.stop(event);
+         return;
+      }
+     else
+       if(event.keyCode==Event.KEY_TAB || event.keyCode==Event.KEY_RETURN ||
+         (Prototype.Browser.WebKit > 0 && event.keyCode == 0)) return;
+
+    this.changed = true;
+    this.hasFocus = true;
+
+    if(this.observer) clearTimeout(this.observer);
+      this.observer =
+        setTimeout(this.onObserverEvent.bind(this), this.options.frequency*1000);
+  },
+
+  activate: function() {
+    this.changed = false;
+    this.hasFocus = true;
+    this.getUpdatedChoices();
+  },
+
+  onHover: function(event) {
+    var element = Event.findElement(event, 'LI');
+    if(this.index != element.autocompleteIndex)
+    {
+        this.index = element.autocompleteIndex;
+        this.render();
+    }
+    Event.stop(event);
+  },
+
+  onClick: function(event) {
+    var element = Event.findElement(event, 'LI');
+    this.index = element.autocompleteIndex;
+    this.selectEntry();
+    this.hide();
+  },
+
+  onBlur: function(event) {
+    // needed to make click events working
+    setTimeout(this.hide.bind(this), 250);
+    this.hasFocus = false;
+    this.active = false;
+  },
+
+  render: function() {
+    if(this.entryCount > 0) {
+      for (var i = 0; i < this.entryCount; i++)
+        this.index==i ?
+          Element.addClassName(this.getEntry(i),"selected") :
+          Element.removeClassName(this.getEntry(i),"selected");
+      if(this.hasFocus) {
+        this.show();
+        this.active = true;
+      }
+    } else {
+      this.active = false;
+      this.hide();
+    }
+  },
+
+  markPrevious: function() {
+    if(this.index > 0) this.index--;
+    else {
+      this.index = this.entryCount-1;
+      this.update.scrollTop = this.update.scrollHeight;
+    }
+    selection = this.getEntry(this.index);
+    selection_top = selection.offsetTop;
+    if(selection_top < this.update.scrollTop){
+      this.update.scrollTop = this.update.scrollTop-selection.offsetHeight;
+    }
+  },
+
+  markNext: function() {
+    if(this.index < this.entryCount-1) this.index++;
+    else {
+      this.index = 0;
+      this.update.scrollTop = 0;
+    }
+    selection = this.getEntry(this.index);
+    selection_bottom = selection.offsetTop+selection.offsetHeight;
+    if(selection_bottom > this.update.scrollTop+this.update.offsetHeight){
+      this.update.scrollTop = this.update.scrollTop+selection.offsetHeight;
+    }
+  },
+
+  getEntry: function(index) {
+    return this.update.firstChild.childNodes[index];
+  },
+
+  getCurrentEntry: function() {
+    return this.getEntry(this.index);
+  },
+
+  selectEntry: function() {
+    this.active = false;
+    this.updateElement(this.getCurrentEntry());
+  },
+
+  updateElement: function(selectedElement) {
+    if (this.options.updateElement) {
+      this.options.updateElement(selectedElement);
+      return;
+    }
+    var value = '';
+    if (this.options.select) {
+      var nodes = $(selectedElement).select('.' + this.options.select) || [];
+      if(nodes.length>0) value = Element.collectTextNodes(nodes[0], this.options.select);
+    } else
+      value = Element.collectTextNodesIgnoreClass(selectedElement, 'informal');
+
+    var bounds = this.getTokenBounds();
+    if (bounds[0] != -1) {
+      var newValue = this.element.value.substr(0, bounds[0]);
+      var whitespace = this.element.value.substr(bounds[0]).match(/^\s+/);
+      if (whitespace)
+        newValue += whitespace[0];
+      this.element.value = newValue + value + this.element.value.substr(bounds[1]);
+    } else {
+      this.element.value = value;
+    }
+    this.oldElementValue = this.element.value;
+    this.element.focus();
+
+    if (this.options.afterUpdateElement)
+      this.options.afterUpdateElement(this.element, selectedElement);
+  },
+
+  updateChoices: function(choices) {
+    if(!this.changed && this.hasFocus) {
+      this.update.innerHTML = choices;
+      Element.cleanWhitespace(this.update);
+      Element.cleanWhitespace(this.update.down());
+
+      if(this.update.firstChild && this.update.down().childNodes) {
+        this.entryCount =
+          this.update.down().childNodes.length;
+        for (var i = 0; i < this.entryCount; i++) {
+          var entry = this.getEntry(i);
+          entry.autocompleteIndex = i;
+          this.addObservers(entry);
+        }
+      } else {
+        this.entryCount = 0;
+      }
+
+      this.stopIndicator();
+      this.update.scrollTop = 0;
+      this.index = 0;
+
+      if(this.entryCount==1 && this.options.autoSelect) {
+        this.selectEntry();
+        this.hide();
+      } else {
+        this.render();
+      }
+    }
+  },
+
+  addObservers: function(element) {
+    Event.observe(element, "mouseover", this.onHover.bindAsEventListener(this));
+    Event.observe(element, "click", this.onClick.bindAsEventListener(this));
+  },
+
+  onObserverEvent: function() {
+    this.changed = false;
+    this.tokenBounds = null;
+    if(this.getToken().length>=this.options.minChars) {
+      this.getUpdatedChoices();
+    } else {
+      this.active = false;
+      this.hide();
+    }
+    this.oldElementValue = this.element.value;
+  },
+
+  getToken: function() {
+    var bounds = this.getTokenBounds();
+    return this.element.value.substring(bounds[0], bounds[1]).strip();
+  },
+
+  getTokenBounds: function() {
+    if (null != this.tokenBounds) return this.tokenBounds;
+    var value = this.element.value;
+    if (value.strip().empty()) return [-1, 0];
+    var diff = arguments.callee.getFirstDifferencePos(value, this.oldElementValue);
+    var offset = (diff == this.oldElementValue.length ? 1 : 0);
+    var prevTokenPos = -1, nextTokenPos = value.length;
+    var tp;
+    for (var index = 0, l = this.options.tokens.length; index < l; ++index) {
+      tp = value.lastIndexOf(this.options.tokens[index], diff + offset - 1);
+      if (tp > prevTokenPos) prevTokenPos = tp;
+      tp = value.indexOf(this.options.tokens[index], diff + offset);
+      if (-1 != tp && tp < nextTokenPos) nextTokenPos = tp;
+    }
+    return (this.tokenBounds = [prevTokenPos + 1, nextTokenPos]);
+  }
+});
+
+Autocompleter.Base.prototype.getTokenBounds.getFirstDifferencePos = function(newS, oldS) {
+  var boundary = Math.min(newS.length, oldS.length);
+  for (var index = 0; index < boundary; ++index)
+    if (newS[index] != oldS[index])
+      return index;
+  return boundary;
+};
+
+Ajax.Autocompleter = Class.create(Autocompleter.Base, {
+  initialize: function(element, update, url, options) {
+    this.baseInitialize(element, update, options);
+    this.options.asynchronous  = true;
+    this.options.onComplete    = this.onComplete.bind(this);
+    this.options.defaultParams = this.options.parameters || null;
+    this.url                   = url;
+  },
+
+  getUpdatedChoices: function() {
+    this.startIndicator();
+
+    var entry = encodeURIComponent(this.options.paramName) + '=' +
+      encodeURIComponent(this.getToken());
+
+    this.options.parameters = this.options.callback ?
+      this.options.callback(this.element, entry) : entry;
+
+    if(this.options.defaultParams)
+      this.options.parameters += '&' + this.options.defaultParams;
+
+    new Ajax.Request(this.url, this.options);
+  },
+
+  onComplete: function(request) {
+    this.updateChoices(request.responseText);
+  }
+});
+
+// The local array autocompleter. Used when you'd prefer to
+// inject an array of autocompletion options into the page, rather
+// than sending out Ajax queries, which can be quite slow sometimes.
+//
+// The constructor takes four parameters. The first two are, as usual,
+// the id of the monitored textbox, and id of the autocompletion menu.
+// The third is the array you want to autocomplete from, and the fourth
+// is the options block.
+//
+// Extra local autocompletion options:
+// - choices - How many autocompletion choices to offer
+//
+// - partialSearch - If false, the autocompleter will match entered
+//                    text only at the beginning of strings in the
+//                    autocomplete array. Defaults to true, which will
+//                    match text at the beginning of any *word* in the
+//                    strings in the autocomplete array. If you want to
+//                    search anywhere in the string, additionally set
+//                    the option fullSearch to true (default: off).
+//
+// - fullSsearch - Search anywhere in autocomplete array strings.
+//
+// - partialChars - How many characters to enter before triggering
+//                   a partial match (unlike minChars, which defines
+//                   how many characters are required to do any match
+//                   at all). Defaults to 2.
+//
+// - ignoreCase - Whether to ignore case when autocompleting.
+//                 Defaults to true.
+//
+// It's possible to pass in a custom function as the 'selector'
+// option, if you prefer to write your own autocompletion logic.
+// In that case, the other options above will not apply unless
+// you support them.
+
+Autocompleter.Local = Class.create(Autocompleter.Base, {
+  initialize: function(element, update, array, options) {
+    this.baseInitialize(element, update, options);
+    this.options.array = array;
+  },
+
+  getUpdatedChoices: function() {
+    this.updateChoices(this.options.selector(this));
+  },
+
+  setOptions: function(options) {
+    this.options = Object.extend({
+      choices: 10,
+      partialSearch: true,
+      partialChars: 2,
+      ignoreCase: true,
+      fullSearch: false,
+      selector: function(instance) {
+        var ret       = []; // Beginning matches
+        var partial   = []; // Inside matches
+        var entry     = instance.getToken();
+        var count     = 0;
+
+        for (var i = 0; i < instance.options.array.length &&
+          ret.length < instance.options.choices ; i++) {
+
+          var elem = instance.options.array[i];
+          var foundPos = instance.options.ignoreCase ?
+            elem.toLowerCase().indexOf(entry.toLowerCase()) :
+            elem.indexOf(entry);
+
+          while (foundPos != -1) {
+            if (foundPos == 0 && elem.length != entry.length) {
+              ret.push("<li><strong>" + elem.substr(0, entry.length) + "</strong>" +
+                elem.substr(entry.length) + "</li>");
+              break;
+            } else if (entry.length >= instance.options.partialChars &&
+              instance.options.partialSearch && foundPos != -1) {
+              if (instance.options.fullSearch || /\s/.test(elem.substr(foundPos-1,1))) {
+                partial.push("<li>" + elem.substr(0, foundPos) + "<strong>" +
+                  elem.substr(foundPos, entry.length) + "</strong>" + elem.substr(
+                  foundPos + entry.length) + "</li>");
+                break;
+              }
+            }
+
+            foundPos = instance.options.ignoreCase ?
+              elem.toLowerCase().indexOf(entry.toLowerCase(), foundPos + 1) :
+              elem.indexOf(entry, foundPos + 1);
+
+          }
+        }
+        if (partial.length)
+          ret = ret.concat(partial.slice(0, instance.options.choices - ret.length));
+        return "<ul>" + ret.join('') + "</ul>";
+      }
+    }, options || { });
+  }
+});
+
+// AJAX in-place editor and collection editor
+// Full rewrite by Christophe Porteneuve <tdd@tddsworld.com> (April 2007).
+
+// Use this if you notice weird scrolling problems on some browsers,
+// the DOM might be a bit confused when this gets called so do this
+// waits 1 ms (with setTimeout) until it does the activation
+Field.scrollFreeActivate = function(field) {
+  setTimeout(function() {
+    Field.activate(field);
+  }, 1);
+};
+
+Ajax.InPlaceEditor = Class.create({
+  initialize: function(element, url, options) {
+    this.url = url;
+    this.element = element = $(element);
+    this.prepareOptions();
+    this._controls = { };
+    arguments.callee.dealWithDeprecatedOptions(options); // DEPRECATION LAYER!!!
+    Object.extend(this.options, options || { });
+    if (!this.options.formId && this.element.id) {
+      this.options.formId = this.element.id + '-inplaceeditor';
+      if ($(this.options.formId))
+        this.options.formId = '';
+    }
+    if (this.options.externalControl)
+      this.options.externalControl = $(this.options.externalControl);
+    if (!this.options.externalControl)
+      this.options.externalControlOnly = false;
+    this._originalBackground = this.element.getStyle('background-color') || 'transparent';
+    this.element.title = this.options.clickToEditText;
+    this._boundCancelHandler = this.handleFormCancellation.bind(this);
+    this._boundComplete = (this.options.onComplete || Prototype.emptyFunction).bind(this);
+    this._boundFailureHandler = this.handleAJAXFailure.bind(this);
+    this._boundSubmitHandler = this.handleFormSubmission.bind(this);
+    this._boundWrapperHandler = this.wrapUp.bind(this);
+    this.registerListeners();
+  },
+  checkForEscapeOrReturn: function(e) {
+    if (!this._editing || e.ctrlKey || e.altKey || e.shiftKey) return;
+    if (Event.KEY_ESC == e.keyCode)
+      this.handleFormCancellation(e);
+    else if (Event.KEY_RETURN == e.keyCode)
+      this.handleFormSubmission(e);
+  },
+  createControl: function(mode, handler, extraClasses) {
+    var control = this.options[mode + 'Control'];
+    var text = this.options[mode + 'Text'];
+    if ('button' == control) {
+      var btn = document.createElement('input');
+      btn.type = 'submit';
+      btn.value = text;
+      btn.className = 'editor_' + mode + '_button';
+      if ('cancel' == mode)
+        btn.onclick = this._boundCancelHandler;
+      this._form.appendChild(btn);
+      this._controls[mode] = btn;
+    } else if ('link' == control) {
+      var link = document.createElement('a');
+      link.href = '#';
+      link.appendChild(document.createTextNode(text));
+      link.onclick = 'cancel' == mode ? this._boundCancelHandler : this._boundSubmitHandler;
+      link.className = 'editor_' + mode + '_link';
+      if (extraClasses)
+        link.className += ' ' + extraClasses;
+      this._form.appendChild(link);
+      this._controls[mode] = link;
+    }
+  },
+  createEditField: function() {
+    var text = (this.options.loadTextURL ? this.options.loadingText : this.getText());
+    var fld;
+    if (1 >= this.options.rows && !/\r|\n/.test(this.getText())) {
+      fld = document.createElement('input');
+      fld.type = 'text';
+      var size = this.options.size || this.options.cols || 0;
+      if (0 < size) fld.size = size;
+    } else {
+      fld = document.createElement('textarea');
+      fld.rows = (1 >= this.options.rows ? this.options.autoRows : this.options.rows);
+      fld.cols = this.options.cols || 40;
+    }
+    fld.name = this.options.paramName;
+    fld.value = text; // No HTML breaks conversion anymore
+    fld.className = 'editor_field';
+    if (this.options.submitOnBlur)
+      fld.onblur = this._boundSubmitHandler;
+    this._controls.editor = fld;
+    if (this.options.loadTextURL)
+      this.loadExternalText();
+    this._form.appendChild(this._controls.editor);
+  },
+  createForm: function() {
+    var ipe = this;
+    function addText(mode, condition) {
+      var text = ipe.options['text' + mode + 'Controls'];
+      if (!text || condition === false) return;
+      ipe._form.appendChild(document.createTextNode(text));
+    };
+    this._form = $(document.createElement('form'));
+    this._form.id = this.options.formId;
+    this._form.addClassName(this.options.formClassName);
+    this._form.onsubmit = this._boundSubmitHandler;
+    this.createEditField();
+    if ('textarea' == this._controls.editor.tagName.toLowerCase())
+      this._form.appendChild(document.createElement('br'));
+    if (this.options.onFormCustomization)
+      this.options.onFormCustomization(this, this._form);
+    addText('Before', this.options.okControl || this.options.cancelControl);
+    this.createControl('ok', this._boundSubmitHandler);
+    addText('Between', this.options.okControl && this.options.cancelControl);
+    this.createControl('cancel', this._boundCancelHandler, 'editor_cancel');
+    addText('After', this.options.okControl || this.options.cancelControl);
+  },
+  destroy: function() {
+    if (this._oldInnerHTML)
+      this.element.innerHTML = this._oldInnerHTML;
+    this.leaveEditMode();
+    this.unregisterListeners();
+  },
+  enterEditMode: function(e) {
+    if (this._saving || this._editing) return;
+    this._editing = true;
+    this.triggerCallback('onEnterEditMode');
+    if (this.options.externalControl)
+      this.options.externalControl.hide();
+    this.element.hide();
+    this.createForm();
+    this.element.parentNode.insertBefore(this._form, this.element);
+    if (!this.options.loadTextURL)
+      this.postProcessEditField();
+    if (e) Event.stop(e);
+  },
+  enterHover: function(e) {
+    if (this.options.hoverClassName)
+      this.element.addClassName(this.options.hoverClassName);
+    if (this._saving) return;
+    this.triggerCallback('onEnterHover');
+  },
+  getText: function() {
+    return this.element.innerHTML.unescapeHTML();
+  },
+  handleAJAXFailure: function(transport) {
+    this.triggerCallback('onFailure', transport);
+    if (this._oldInnerHTML) {
+      this.element.innerHTML = this._oldInnerHTML;
+      this._oldInnerHTML = null;
+    }
+  },
+  handleFormCancellation: function(e) {
+    this.wrapUp();
+    if (e) Event.stop(e);
+  },
+  handleFormSubmission: function(e) {
+    var form = this._form;
+    var value = $F(this._controls.editor);
+    this.prepareSubmission();
+    var params = this.options.callback(form, value) || '';
+    if (Object.isString(params))
+      params = params.toQueryParams();
+    params.editorId = this.element.id;
+    if (this.options.htmlResponse) {
+      var options = Object.extend({ evalScripts: true }, this.options.ajaxOptions);
+      Object.extend(options, {
+        parameters: params,
+        onComplete: this._boundWrapperHandler,
+        onFailure: this._boundFailureHandler
+      });
+      new Ajax.Updater({ success: this.element }, this.url, options);
+    } else {
+      var options = Object.extend({ method: 'get' }, this.options.ajaxOptions);
+      Object.extend(options, {
+        parameters: params,
+        onComplete: this._boundWrapperHandler,
+        onFailure: this._boundFailureHandler
+      });
+      new Ajax.Request(this.url, options);
+    }
+    if (e) Event.stop(e);
+  },
+  leaveEditMode: function() {
+    this.element.removeClassName(this.options.savingClassName);
+    this.removeForm();
+    this.leaveHover();
+    this.element.style.backgroundColor = this._originalBackground;
+    this.element.show();
+    if (this.options.externalControl)
+      this.options.externalControl.show();
+    this._saving = false;
+    this._editing = false;
+    this._oldInnerHTML = null;
+    this.triggerCallback('onLeaveEditMode');
+  },
+  leaveHover: function(e) {
+    if (this.options.hoverClassName)
+      this.element.removeClassName(this.options.hoverClassName);
+    if (this._saving) return;
+    this.triggerCallback('onLeaveHover');
+  },
+  loadExternalText: function() {
+    this._form.addClassName(this.options.loadingClassName);
+    this._controls.editor.disabled = true;
+    var options = Object.extend({ method: 'get' }, this.options.ajaxOptions);
+    Object.extend(options, {
+      parameters: 'editorId=' + encodeURIComponent(this.element.id),
+      onComplete: Prototype.emptyFunction,
+      onSuccess: function(transport) {
+        this._form.removeClassName(this.options.loadingClassName);
+        var text = transport.responseText;
+        if (this.options.stripLoadedTextTags)
+          text = text.stripTags();
+        this._controls.editor.value = text;
+        this._controls.editor.disabled = false;
+        this.postProcessEditField();
+      }.bind(this),
+      onFailure: this._boundFailureHandler
+    });
+    new Ajax.Request(this.options.loadTextURL, options);
+  },
+  postProcessEditField: function() {
+    var fpc = this.options.fieldPostCreation;
+    if (fpc)
+      $(this._controls.editor)['focus' == fpc ? 'focus' : 'activate']();
+  },
+  prepareOptions: function() {
+    this.options = Object.clone(Ajax.InPlaceEditor.DefaultOptions);
+    Object.extend(this.options, Ajax.InPlaceEditor.DefaultCallbacks);
+    [this._extraDefaultOptions].flatten().compact().each(function(defs) {
+      Object.extend(this.options, defs);
+    }.bind(this));
+  },
+  prepareSubmission: function() {
+    this._saving = true;
+    this.removeForm();
+    this.leaveHover();
+    this.showSaving();
+  },
+  registerListeners: function() {
+    this._listeners = { };
+    var listener;
+    $H(Ajax.InPlaceEditor.Listeners).each(function(pair) {
+      listener = this[pair.value].bind(this);
+      this._listeners[pair.key] = listener;
+      if (!this.options.externalControlOnly)
+        this.element.observe(pair.key, listener);
+      if (this.options.externalControl)
+        this.options.externalControl.observe(pair.key, listener);
+    }.bind(this));
+  },
+  removeForm: function() {
+    if (!this._form) return;
+    this._form.remove();
+    this._form = null;
+    this._controls = { };
+  },
+  showSaving: function() {
+    this._oldInnerHTML = this.element.innerHTML;
+    this.element.innerHTML = this.options.savingText;
+    this.element.addClassName(this.options.savingClassName);
+    this.element.style.backgroundColor = this._originalBackground;
+    this.element.show();
+  },
+  triggerCallback: function(cbName, arg) {
+    if ('function' == typeof this.options[cbName]) {
+      this.options[cbName](this, arg);
+    }
+  },
+  unregisterListeners: function() {
+    $H(this._listeners).each(function(pair) {
+      if (!this.options.externalControlOnly)
+        this.element.stopObserving(pair.key, pair.value);
+      if (this.options.externalControl)
+        this.options.externalControl.stopObserving(pair.key, pair.value);
+    }.bind(this));
+  },
+  wrapUp: function(transport) {
+    this.leaveEditMode();
+    // Can't use triggerCallback due to backward compatibility: requires
+    // binding + direct element
+    this._boundComplete(transport, this.element);
+  }
+});
+
+Object.extend(Ajax.InPlaceEditor.prototype, {
+  dispose: Ajax.InPlaceEditor.prototype.destroy
+});
+
+Ajax.InPlaceCollectionEditor = Class.create(Ajax.InPlaceEditor, {
+  initialize: function($super, element, url, options) {
+    this._extraDefaultOptions = Ajax.InPlaceCollectionEditor.DefaultOptions;
+    $super(element, url, options);
+  },
+
+  createEditField: function() {
+    var list = document.createElement('select');
+    list.name = this.options.paramName;
+    list.size = 1;
+    this._controls.editor = list;
+    this._collection = this.options.collection || [];
+    if (this.options.loadCollectionURL)
+      this.loadCollection();
+    else
+      this.checkForExternalText();
+    this._form.appendChild(this._controls.editor);
+  },
+
+  loadCollection: function() {
+    this._form.addClassName(this.options.loadingClassName);
+    this.showLoadingText(this.options.loadingCollectionText);
+    var options = Object.extend({ method: 'get' }, this.options.ajaxOptions);
+    Object.extend(options, {
+      parameters: 'editorId=' + encodeURIComponent(this.element.id),
+      onComplete: Prototype.emptyFunction,
+      onSuccess: function(transport) {
+        var js = transport.responseText.strip();
+        if (!/^\[.*\]$/.test(js)) // TODO: improve sanity check
+          throw('Server returned an invalid collection representation.');
+        this._collection = eval(js);
+        this.checkForExternalText();
+      }.bind(this),
+      onFailure: this.onFailure
+    });
+    new Ajax.Request(this.options.loadCollectionURL, options);
+  },
+
+  showLoadingText: function(text) {
+    this._controls.editor.disabled = true;
+    var tempOption = this._controls.editor.firstChild;
+    if (!tempOption) {
+      tempOption = document.createElement('option');
+      tempOption.value = '';
+      this._controls.editor.appendChild(tempOption);
+      tempOption.selected = true;
+    }
+    tempOption.update((text || '').stripScripts().stripTags());
+  },
+
+  checkForExternalText: function() {
+    this._text = this.getText();
+    if (this.options.loadTextURL)
+      this.loadExternalText();
+    else
+      this.buildOptionList();
+  },
+
+  loadExternalText: function() {
+    this.showLoadingText(this.options.loadingText);
+    var options = Object.extend({ method: 'get' }, this.options.ajaxOptions);
+    Object.extend(options, {
+      parameters: 'editorId=' + encodeURIComponent(this.element.id),
+      onComplete: Prototype.emptyFunction,
+      onSuccess: function(transport) {
+        this._text = transport.responseText.strip();
+        this.buildOptionList();
+      }.bind(this),
+      onFailure: this.onFailure
+    });
+    new Ajax.Request(this.options.loadTextURL, options);
+  },
+
+  buildOptionList: function() {
+    this._form.removeClassName(this.options.loadingClassName);
+    this._collection = this._collection.map(function(entry) {
+      return 2 === entry.length ? entry : [entry, entry].flatten();
+    });
+    var marker = ('value' in this.options) ? this.options.value : this._text;
+    var textFound = this._collection.any(function(entry) {
+      return entry[0] == marker;
+    }.bind(this));
+    this._controls.editor.update('');
+    var option;
+    this._collection.each(function(entry, index) {
+      option = document.createElement('option');
+      option.value = entry[0];
+      option.selected = textFound ? entry[0] == marker : 0 == index;
+      option.appendChild(document.createTextNode(entry[1]));
+      this._controls.editor.appendChild(option);
+    }.bind(this));
+    this._controls.editor.disabled = false;
+    Field.scrollFreeActivate(this._controls.editor);
+  }
+});
+
+//**** DEPRECATION LAYER FOR InPlace[Collection]Editor! ****
+//**** This only  exists for a while,  in order to  let ****
+//**** users adapt to  the new API.  Read up on the new ****
+//**** API and convert your code to it ASAP!            ****
+
+Ajax.InPlaceEditor.prototype.initialize.dealWithDeprecatedOptions = function(options) {
+  if (!options) return;
+  function fallback(name, expr) {
+    if (name in options || expr === undefined) return;
+    options[name] = expr;
+  };
+  fallback('cancelControl', (options.cancelLink ? 'link' : (options.cancelButton ? 'button' :
+    options.cancelLink == options.cancelButton == false ? false : undefined)));
+  fallback('okControl', (options.okLink ? 'link' : (options.okButton ? 'button' :
+    options.okLink == options.okButton == false ? false : undefined)));
+  fallback('highlightColor', options.highlightcolor);
+  fallback('highlightEndColor', options.highlightendcolor);
+};
+
+Object.extend(Ajax.InPlaceEditor, {
+  DefaultOptions: {
+    ajaxOptions: { },
+    autoRows: 3,                                // Use when multi-line w/ rows == 1
+    cancelControl: 'link',                      // 'link'|'button'|false
+    cancelText: 'cancel',
+    clickToEditText: 'Click to edit',
+    externalControl: null,                      // id|elt
+    externalControlOnly: false,
+    fieldPostCreation: 'activate',              // 'activate'|'focus'|false
+    formClassName: 'inplaceeditor-form',
+    formId: null,                               // id|elt
+    highlightColor: '#ffff99',
+    highlightEndColor: '#ffffff',
+    hoverClassName: '',
+    htmlResponse: true,
+    loadingClassName: 'inplaceeditor-loading',
+    loadingText: 'Loading...',
+    okControl: 'button',                        // 'link'|'button'|false
+    okText: 'ok',
+    paramName: 'value',
+    rows: 1,                                    // If 1 and multi-line, uses autoRows
+    savingClassName: 'inplaceeditor-saving',
+    savingText: 'Saving...',
+    size: 0,
+    stripLoadedTextTags: false,
+    submitOnBlur: false,
+    textAfterControls: '',
+    textBeforeControls: '',
+    textBetweenControls: ''
+  },
+  DefaultCallbacks: {
+    callback: function(form) {
+      return Form.serialize(form);
+    },
+    onComplete: function(transport, element) {
+      // For backward compatibility, this one is bound to the IPE, and passes
+      // the element directly.  It was too often customized, so we don't break it.
+      new Effect.Highlight(element, {
+        startcolor: this.options.highlightColor, keepBackgroundImage: true });
+    },
+    onEnterEditMode: null,
+    onEnterHover: function(ipe) {
+      ipe.element.style.backgroundColor = ipe.options.highlightColor;
+      if (ipe._effect)
+        ipe._effect.cancel();
+    },
+    onFailure: function(transport, ipe) {
+      alert('Error communication with the server: ' + transport.responseText.stripTags());
+    },
+    onFormCustomization: null, // Takes the IPE and its generated form, after editor, before controls.
+    onLeaveEditMode: null,
+    onLeaveHover: function(ipe) {
+      ipe._effect = new Effect.Highlight(ipe.element, {
+        startcolor: ipe.options.highlightColor, endcolor: ipe.options.highlightEndColor,
+        restorecolor: ipe._originalBackground, keepBackgroundImage: true
+      });
+    }
+  },
+  Listeners: {
+    click: 'enterEditMode',
+    keydown: 'checkForEscapeOrReturn',
+    mouseover: 'enterHover',
+    mouseout: 'leaveHover'
+  }
+});
+
+Ajax.InPlaceCollectionEditor.DefaultOptions = {
+  loadingCollectionText: 'Loading options...'
+};
+
+// Delayed observer, like Form.Element.Observer,
+// but waits for delay after last key input
+// Ideal for live-search fields
+
+Form.Element.DelayedObserver = Class.create({
+  initialize: function(element, delay, callback) {
+    this.delay     = delay || 0.5;
+    this.element   = $(element);
+    this.callback  = callback;
+    this.timer     = null;
+    this.lastValue = $F(this.element);
+    Event.observe(this.element,'keyup',this.delayedListener.bindAsEventListener(this));
+  },
+  delayedListener: function(event) {
+    if(this.lastValue == $F(this.element)) return;
+    if(this.timer) clearTimeout(this.timer);
+    this.timer = setTimeout(this.onTimerEvent.bind(this), this.delay * 1000);
+    this.lastValue = $F(this.element);
+  },
+  onTimerEvent: function() {
+    this.timer = null;
+    this.callback(this.element, $F(this.element));
+  }
+});