recordselect-custom 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG

@@ -0,0 +1,25 @@
+1.0
+* record_select_field always searches on the latest string
+* R.S. dialog closes on mousedown instead of click (because sometimes clicks are intercepted)
+* R.S. layers over <select> boxes in IE 6
+* record_select_field now opens R.S. even when the field loads with focus
+* new :onchange option for record_select_field, to observe selection events
+
+1.0rc1
+* helpers complain if the controller they're configured for doesn't use recordselect
+* when using keyboard navigation, hitting "enter" to select a record no longer submits the form
+* if text field is empty when dialog is closed, then recordselect will empty the hidden field as well (lets you deselect)
+* support for multiple selections (record_multi_select_helper)
+* param-based search conditions are smarter - can search numeric fields as well
+* using record_select_conditions_from_controller instead of conditions_for_collection. also added a new record_select_includes override method.
+* helpers now accept a :class option
+* fixed bug with url escaping when helpers were configured with multiple parameters
+* new :label configuration option. it's a proc - the default one calls record.to_label (for backwards compatibility).
+* cleaned up merge_conditions to use activerecord's sanitize_sql.
+* div.record-select-container now has a high z-index so it will by default be visible above other absolutely positioned elements.
+
+0.9
+stuff
+
+0.1
+stuff

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in recordselect-custom.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 lion
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Lance Ivy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,11 @@
+RecordSelect
+============
+
+(c) 2007 - Lance Ivy
+
+RecordSelect is a Rails widget to help you pick one record out of many. I designed it as a more usable and performant alternative to generating a massive dropdown list. It relies on AJAX for the cooler uses (all the provided view helpers rely on JavaScript?) but can also function in a pure-http fashion (although multi-select support is provided in a pure-JavaScript implementation).
+
+Please see the ActionView::Helpers::RecordSelectHelpers for the most common API. More documentation (and HOWTOs) can be found online at http://code.google.com/p/recordselect, and a demo application is available at http://recordselect.googlecode.com/svn/demo.
+
+= DEPENDENCIES
+This depends on the excellent Paginator gem by Bruce Williams. This simple gem is available at paginator.rubyforge.org.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the recordselect plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the recordselect plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Recordselect'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('assets/**/*.js')
+end

data/app/helpers/record_select_helper.rb

@@ -0,0 +1,187 @@
+module RecordSelectHelper
+  # Print this from your layout to include everything necessary for RecordSelect to work.
+  # Well, not everything. You need Prototype too.
+  def record_select_includes
+    includes = ''
+    includes << stylesheet_link_tag('record_select/record_select')
+    includes << javascript_include_tag('record_select/record_select')
+    includes
+  end
+
+  # Adds a link on the page that toggles a RecordSelect widget from the given controller.
+  #
+  # *Options*
+  # +onselect+::  JavaScript code to handle selections client-side. This code has access to two variables: id, label. If the code returns false, the dialog will *not* close automatically.
+  # +params+::    Extra URL parameters. If any parameter is a column name, the parameter will be used as a search term to filter the result set.
+  def link_to_record_select(name, controller, options = {})
+    options[:params] ||= {}
+    options[:params].merge!(:controller => controller, :action => :browse)
+    options[:onselect] = "function(id, label) {#{options[:onselect]}}" if options[:onselect]
+    options[:html] ||= {}
+    options[:html][:id] ||= "rs_#{rand(9999)}"
+
+    assert_controller_responds(options[:params][:controller])
+
+    html = link_to_function(name, '', options[:html])
+    html << javascript_tag("new RecordSelect.Dialog(#{options[:html][:id].to_json}, #{url_for(options[:params].merge(:escape => false)).to_json}, {onselect: #{options[:onselect] || ''}})")
+
+    return html
+  end
+
+  # Adds a RecordSelect-based form field. The field submits the record's id using a hidden input.
+  #
+  # *Arguments*
+  # +name+:: the input name that will be used to submit the selected record's id.
+  # +current+:: the currently selected object. provide a new record if there're none currently selected and you have not passed the optional :controller argument.
+  #
+  # *Options*
+  # +controller+::  The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of +current+ (the second argument)
+  # +params+::      A hash of extra URL parameters
+  # +id+::          The id to use for the input. Defaults based on the input's name.
+  # +onchange+::    A JavaScript function that will be called whenever something new is selected. It should accept the new id as the first argument, and the new label as the second argument. For example, you could set onchange to be "function(id, label) {alert(id);}", or you could create a JavaScript function somewhere else and set onchange to be "my_function" (without the parantheses!).
+  def record_select_field(name, current, options = {})
+    options[:controller] ||= current.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+
+    controller = assert_controller_responds(options[:controller])
+
+    id = label = ''
+    if current and not current.new_record?
+      id = current.id
+      label = label_for_field(current, controller)
+    end
+
+    url = url_for({:action => :browse, :controller => options[:controller], :escape => false}.merge(options[:params]))
+
+    html = text_field_tag(name, nil, :autocomplete => 'off', :id => options[:id], :class => options[:class], :onfocus => "this.focused=true", :onblur => "this.focused=false")
+    html << javascript_tag("$(#{options[:id].to_json}).singleRecordSelect(#{url.to_json}, {id: #{id.to_json}, label: #{label.to_json}, onchange: #{options[:onchange] || ''.to_json}});")
+
+    return html
+  end
+
+  # Assists with the creation of an observer for the :onchange option of the record_select_field method.
+  # Currently only supports building an Ajax.Request based on the id of the selected record.
+  #
+  # options[:url] should be a hash with all the necessary options *except* :id. that parameter
+  # will be provided based on the selected record.
+  #
+  # Question: if selecting users, what's more likely?
+  #   /users/5/categories
+  #   /categories?user_id=5
+  def record_select_observer(options = {})
+    fn = ""
+    fn << "function(id, value) {"
+    fn <<   "var url = #{url_for(options[:url].merge(:id => ":id:")).to_json}.replace(/:id:/, id);"
+    fn <<   "jQuery.get(url);"
+    fn << "}"
+  end
+
+  # Adds a RecordSelect-based form field for multiple selections. The values submit using a list of hidden inputs.
+  #
+  # *Arguments*
+  # +name+:: the input name that will be used to submit the selected records' ids. empty brackets will be appended to the name.
+  # +current+:: pass a collection of existing associated records
+  #
+  # *Options*
+  # +controller+::  The controller configured to provide the result set.
+  # +params+::      A hash of extra URL parameters
+  # +id+::          The id to use for the input. Defaults based on the input's name.
+  def record_multi_select_field(name, current, options = {})
+    options[:controller] ||= current.first.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+
+    controller = assert_controller_responds(options[:controller])
+
+    current = current.inject([]) { |memo, record| memo.push({:id => record.id, :label => label_for_field(record, controller)}) }
+
+    url = url_for({:action => :browse, :controller => options[:controller], :escape => false}.merge(options[:params]))
+
+    html = text_field_tag("#{name}[]", nil, :autocomplete => 'off', :id => options[:id], :class => options[:class], :onfocus => "this.focused=true", :onblur => "this.focused=false")
+    html << content_tag('ul', '', :class => 'record-select-list');
+    html << javascript_tag("new RecordSelect.Multiple(#{options[:id].to_json}, #{url.to_json}, {current: #{current.to_json}});")
+
+    return html
+  end
+
+  # A helper to render RecordSelect partials
+  def render_record_select(options = {}) #:nodoc:
+    controller.send(:render_record_select, options) do |options|
+      render options
+    end
+  end
+
+  # Provides view access to the RecordSelect configuration
+  def record_select_config #:nodoc:
+    controller.send :record_select_config
+  end
+
+  # The id of the RecordSelect widget for the given controller.
+  def record_select_id(controller = nil) #:nodoc:
+    controller ||= params[:controller]
+    "record-select-#{controller.gsub('/', '_')}"
+  end
+
+  def record_select_search_id(controller = nil) #:nodoc:
+    "#{record_select_id(controller)}-search"
+  end
+
+  private
+  # render the record using the renderer and add a link to select the record
+  def render_record_in_list(record, controller_path)
+    text = render_record_from_config(record)
+    if record_select_config.link?
+      url_params = {:controller => controller_path, :action => :select, :id => record.id, :escape => false}
+      link_to_remote text, {
+          :url => url_params,
+          :method => :post,
+          :before => 'jQuery(this).toggleClass("selected")',
+          :condition => "jQuery(this).recordSelect_notify()"
+        }, :href => url_params
+    else
+      text
+    end
+  end
+
+
+  # uses renderer (defaults to record_select_config.label) to determine how the given record renders.
+  def render_record_from_config(record, renderer = record_select_config.label)
+    case renderer
+    when Symbol, String
+      # return full-html from the named partial
+      render :partial => renderer.to_s, :locals => {:record => record}
+
+    when Proc
+      # return an html-cleaned descriptive string
+      h renderer.call(record)
+    end
+  end
+
+  # uses the result of render_record_from_config to snag an appropriate record label
+  # to display in a field.
+  #
+  # if given a controller, searches for a partial in its views path
+  def label_for_field(record, controller = self.controller)
+    renderer = controller.record_select_config.label
+    case renderer
+    when Symbol, String
+      # find the <label> element and grab its innerHTML
+      description = render_record_from_config(record, File.join(controller.controller_path, renderer.to_s))
+      description.match(/<label[^>]*>(.*)<\/label>/)[1]
+
+    when Proc
+      # just return the string
+      render_record_from_config(record, renderer)
+    end
+  end
+
+  def assert_controller_responds(controller_name)
+    controller_name = "#{controller_name.camelize}Controller"
+    controller = controller_name.constantize
+    unless controller.uses_record_select?
+      raise "#{controller_name} has not been configured to use RecordSelect."
+    end
+    controller
+  end
+end

data/app/views/record_select/_browse.html.erb

@@ -0,0 +1,8 @@
+<%
+controller ||= params[:controller]
+record_select_id = record_select_id(controller)
+-%>
+<div class="record-select" id="<%= record_select_id -%>">
+  <%= render_record_select :partial => 'search', :locals => {:controller => controller, :record_select_id => record_select_id} %>
+  <%= render_record_select :partial => 'list', :locals => {:controller => controller, :page => @page, :record_select_id => record_select_id} %>
+</div>

data/app/views/record_select/_list.html.erb

@@ -0,0 +1,29 @@
+<%- controller ||= params[:controller] -%>
+<%- pagination_url_params = params.merge(:controller => controller, :action => :browse, :search => params[:search], :update => 1) if page.prev? || page.next? -%>
+
+<ol>
+  <li class="found">
+    <%= rs_("%d %s found", page.pager.count, record_select_config.model.to_s.pluralize.titleize.downcase) %>
+  </li>
+  <% if page.prev? -%>
+  <%- prev_url = url_for(pagination_url_params.merge(:page => page.prev.number, :escape => false)) %>
+  <li class="pagination previous">
+    <%- previous_text = image_tag('record_select/previous.gif', :alt => rs_('Previous')) + " " + rs_("Previous %d", page.pager.per_page) %>
+    <%- previous_text = "<div>#{previous_text}</div>" %>
+    <%= link_to_remote previous_text, {:url => prev_url, :method => :get}, {:href => prev_url} %>
+  </li>
+  <% end -%>
+  <% page.items.each do |record| -%>
+  <li class="record <%= cycle 'odd', 'even' %>" id="rs<%= record.id -%>">
+    <%= render_record_in_list(record, controller) %>
+  </li>
+  <% end -%>
+  <% if page.next? -%>
+  <%- next_url = url_for(pagination_url_params.merge(:page => page.next.number, :escape => false)) %>
+  <li class="pagination next">
+    <%- next_text = rs_("Next %d", page.pager.per_page) + " " + image_tag('record_select/next.gif', :alt => rs_('Next')) %>
+    <%- next_text = "<div>#{next_text}</div>" %>
+    <%= link_to_remote next_text, {:url => next_url, :method => :get}, {:href => next_url} %>
+  </li>
+  <% end -%>
+</ol>

data/app/views/record_select/_search.html.erb

@@ -0,0 +1,14 @@
+<% search_url = url_for(params.merge(:controller => controller, :action => :browse, :page => 1, :update => 1, :escape => false)) -%>
+<% form_remote_tag :url => search_url, :method => :get,
+                   :html => { :action => search_url, :id => record_select_search_id } do %>
+  <%= text_field_tag 'search', params[:search], :autocomplete => 'off', :class => 'text-input' %>
+<% end %>
+
+<script type="text/javascript">
+//<![CDATA[
+var i = $(<%= record_select_search_id.to_json %>).down('input.text-input');
+Form.Element.AfterActivity(i, function() {
+  $(<%= record_select_search_id.to_json %>).onsubmit();
+}, 0.35);
+//]]>
+</script>

data/app/views/record_select/browse.js.rjs

@@ -0,0 +1,4 @@
+page.assign "data", render_record_select(:partial => 'list', :locals => {:page => @page})
+page.assign "elem", page.literal("$$('##{record_select_id} ol')[0]")
+
+page << %|if (elem) {Element.replace(elem, data)}|

data/assets/javascripts/record_select.js

@@ -0,0 +1,327 @@
+jQuery(window).bind("load", function() { RecordSelect.document_loaded = true });
+
+jQuery.fn.afterActivity = function(callback, delay, _this) {
+  var element = jQuery(this);
+  if (!delay) delay = 0.35;
+
+    var elem;
+    jQuery(this).bind(("keyup"), function(event) {
+
+    // TODO 用中文输入法输英文时（输入asdf，回车），有问题
+    var keyCode = event.keyCode;
+
+    switch( event.keyCode ) {
+    case 0://Event.KEY_SPACE:
+    case 13://keyCode.ENTER
+      _this.clearActivityTimer();
+      _this.abortRequestXhr("ajaxGetSearh");
+      _this.abortRequestXhr("ajaxGetOpen");
+    case 16://keyCode.SHIFT:
+    case 17://keyCode.CTRL:
+    case 18://keyCode.ALT:
+    case 20://keyCode.CAPSLOCK:
+    case 27://Event.KEY_ESC:
+    case 33://keyCode.PAGEUP:
+    case 34://keyCode.PAGEDOWN:
+    case 35://keyCode.END:
+    case 36://keyCode.HOME:
+    case 37://Event.KEY_LEFT:
+    case 38://keyCode.UP:
+    case 39://Event.KEY_RIGHT:
+    case 40://keyCode.DOWN:
+      return;
+    }
+
+    if(event.isDefaultPrevented()) return;
+
+    _this.clearActivityTimer();
+    _this.abortRequestXhr("ajaxGetSearh");
+    _this.abortRequestXhr("ajaxGetOpen");
+    _this.activity_timer = setTimeout(function() {
+      if(!_this.is_open()) _this.open();
+      form = element.nextAll('div.record-select-container').find('form');
+      callback = function(){form[0] && form[0].onsubmit(_this)};
+      // TODO is close auto open
+      callback(element.value);
+    }, delay * 1000 + 50);
+  });
+  jQuery(this).bind(("keydown"), function(event) {
+
+    var keyCode = event.keyCode;
+
+    // hot keys
+    if(event.shiftKey && event.altKey && keyCode == 78){
+      _this.clearActivityTimer();
+      _this.abortRequestXhr("ajaxGetSearh");
+      _this.abortRequestXhr("ajaxGetOpen");
+      _this.close();
+      return;
+    }
+    switch( event.keyCode ) {
+    case 38://keyCode.UP:
+      elem = _this.has_current() && _this.current.parent('.record-select') && _this.current.prev(":not(.found)");
+      if (elem && elem.length == 0) elem = _this.container.find("ol li:not(.found):last");
+      _this.highlight(elem);
+      event.preventDefault();
+      return;
+    case 40://keyCode.DOWN:
+      if(!_this.is_open()) _this.open();
+      if (_this.has_current() && _this.current.parent('.record-select')) elem = _this.current.next(":not(.found)");
+      if (elem && elem.length == 0) elem = _this.container.find("ol li:not(.found):first");
+      // prevent moving cursor to end of text field in some browsers
+      _this.highlight(elem);
+      event.preventDefault();
+      return;
+    case 0://Event.KEY_SPACE:
+    case 13://keyCode.ENTER:
+      if (_this.has_current()){
+        elem = _this.current.find('a')[0];
+        switch(elem){
+          case _this.getPrevPageBtn()[0]: _this.doPrevPage(); break;
+          case _this.getNextPageBtn()[0]: _this.doNextPage(); break;
+          default : elem.onclick();
+        }
+      }
+      event.preventDefault();
+      return;
+    case 39://Event.KEY_RIGHT:
+      if(_this.is_open()){
+        _this.doNextPage();
+        event.preventDefault();
+      }
+      return;
+    case 37://Event.KEY_LEFT:
+      if(_this.is_open()){
+        _this.doPrevPage();
+        event.preventDefault();
+      }
+      return;
+    case 9://keyCode.TAB:
+    case 27://Event.KEY_ESC:
+      _this.close();
+      return;
+    case 16://keyCode.SHIFT:
+    case 17://keyCode.CTRL:
+    case 18://keyCode.ALT:
+    case 20://keyCode.CAPSLOCK:
+    case 33://keyCode.PAGEUP:
+    case 34://keyCode.PAGEDOWN:
+    case 35://keyCode.END:
+    case 36://keyCode.HOME:
+      return;
+    }
+  });
+}
+
+var RecordSelect = new Object();
+RecordSelect.document_loaded = false;
+
+$.fn.recordSelect_notify = function() {
+  var item = $(this);
+  var e = item.parents(".record-select-handler");
+  var my_onselect = e.my_onselect || e.attr('my_onselect') || e.prop('my_onselect');
+  if (typeof my_onselect != 'function') my_onselect = eval(my_onselect);
+  if (my_onselect) {
+    try {
+      par = item.parent();
+      my_onselect(par.attr("id").substring(2), item.find('label').text() || item.text(), e);
+    } catch(e) {
+      alert(e);
+    }
+    return false;
+  }
+  else return true;
+  return false;
+}
+
+jQuery.fn.recordSelectSingle = function(url, options) {
+  var obj = $(this);
+  var _this = {};
+  if(!options.openEvents) options.openEvents = "focus click";
+
+  var initialize = function(obj, url, options) {
+    _this.obj = obj;
+    _this.url = url;
+    _this.options = options;
+    _this.js_params = _this.options && _this.options.js_params;
+    _this.container;
+
+    if (RecordSelect.document_loaded) {
+     _this.my_onload();
+    } else {
+      jQuery(window).bind('load', _this.my_onload);
+    }
+
+    jQuery(document.body).bind('mousedown', _this.onbodyclick);
+  };
+
+  _this.my_onload = function() {
+    // initialize the container
+    _this.container = _this.create_container();
+    _this.container.addClass('record-select-autocomplete');
+
+    // create the hidden input
+    _this.obj.after('<input type="hidden" name="" value="" class="value"/>');
+    _this.hidden_input = _this.obj.next("input.value:last");
+
+    // transfer the input name from the text input to the hidden input
+    _this.hidden_input.attr("name", _this.obj.attr("name"));
+    _this.obj.attr("name", '');
+
+    // initialize the values
+    _this.set(_this.options.id, _this.options.label);
+    _this._respond_to_text_field(_this.obj);
+    if (_this.obj.focused) _this.open(); // if it was focused before we could attach observers
+  };
+
+  _this.close = function() {
+    _this.clearActivityTimer();
+    _this.abortRequestXhr("ajaxGetSearh");
+    _this.abortRequestXhr("ajaxGetOpen");
+    // if they close the dialog with the text field empty, then delete the id value
+    if (_this.obj.attr("value") == '') _this.set('', '');
+
+    if (_this._use_iframe_mask()) { _this.container.next('iframe').remove(); }
+
+    _this.container.hide();
+    // hopefully by using remove() instead of innerHTML we won't leak memory
+    _this.container.children().remove();
+  };
+
+  _this.my_onselect = function(id, value, e) {
+    if (_this.options.onchange) _this.options.onchange(_this.obj, id, value);
+    _this.set(id, value);
+    _this.obj.focus();
+    _this.close();
+  };
+
+  _this.open = function(ev) {
+    var elem;
+    if (_this.is_open()) return;
+    if (_this.ajaxGetOpen) return;
+    var _params = {search: _this.obj.val()};
+    if (_this.js_params) _params = $.extend(_params, _this.js_params());
+
+    _this.ajaxGetOpen = jQuery.get(_this.url, _params, function(data, b) {
+      _this.ajaxGetOpen = null;
+      _this.container.html(data);
+      _this.show();
+      _this.highlightFirst();
+      // needs to be mousedown so the event doesn't get canceled by other code (see issue #26)
+    });
+  };
+
+  _this.highlightFirst = function() {
+    var elem = _this.container.find('ol li.record:first');
+    // prevent moving cursor to end of text field in some browsers
+    _this.highlight(elem);
+  };
+
+  _this.abortRequestXhr = function(reqXhrName) {
+    if (_this[reqXhrName]) {
+      _this[reqXhrName].abort();
+      _this[reqXhrName] = null;
+    }
+  };
+
+  _this.clearActivityTimer = function() {
+    if (_this.activity_timer) clearTimeout(_this.activity_timer);
+  };
+
+  _this.show = function() {
+    var offset = _this.obj.position();
+    _this.container.css("left", offset.left + 'px');
+    _this.container.css("top", (_this.obj.outerHeight() + offset.top) + 'px');
+
+    if (_this._use_iframe_mask()) {
+      _this.container.append('<iframe src="javascript:false;" class="record-select-mask" />');
+      var mask = _this.container.next('iframe');
+      mask.css("left", _this.container.position().left);
+      mask.css("top", _this.container.position().top);
+    }
+
+    _this.container.show();
+    if (_this._use_iframe_mask()) {
+      var dimensions = _this.container.children();
+      mask.css("width", dimensions.outerWidth() + 'px');
+      mask.css("height", dimensions.outerHeight() + 'px');
+    }
+  };
+
+  _this.is_open = function() { return (!!_this.container.html()); };
+
+  _this.set = function(id, label) {
+    var text = jQuery("<div>" + label + "</div>").text();
+    _this.obj.val(text);
+    _this.hidden_input.val(_this.options.ass_value ? id : text);
+  };
+
+  _this.create_container = function() {
+    box = obj.parent();
+    box.append('<div class="record-select-container record-select-handler"></div>');
+    e = box.children()[box.children().length - 1];
+    e.my_onselect = _this.my_onselect;
+    e = jQuery(e);
+    e.hide();
+
+    return jQuery(e);
+  };
+
+  _this.onbodyclick = function(ev) {
+    var elem = jQuery(ev.target);
+    if (elem.parents("li.pagination.previous").children("a")[0] == _this.getPrevPageBtn()[0]) _this.doPrevPage();
+    if (elem.parents("li.pagination.next").children("a")[0] == _this.getNextPageBtn()[0]) _this.doNextPage();
+    if (elem.parents("div.record-select-container").length > 0 || elem[0] == _this.obj[0]) return;
+    _this.clearActivityTimer();
+    _this.abortRequestXhr("ajaxGetSearh");
+    _this.abortRequestXhr("ajaxGetOpen");
+    _this.close();
+  };
+
+  _this._respond_to_text_field = function(text_field) {
+    // attach the events to start _this party
+    text_field.bind(options.openEvents, _this.open);
+
+    // the autosearch event - needs to happen slightly late (keyup is later than keypress)
+    text_field.bind('keyup', function() {
+      if (!_this.is_open()) return;
+      _this.container.find('.text-input').attr("value", text_field.attr("value"));
+    });
+
+    // keyboard navigation, if available
+    if (_this.onkeypress) { text_field.bind((jQuery.browser.opera? "keypress" : "keydown"), _this.onkeypress); }
+  };
+  _this.current = null;
+
+  _this.onkeypress = function(event) { };
+
+  _this.highlight = function(obj) {
+    if (_this.has_current()) _this.current.removeClass('current');
+    if (!obj) return;
+    _this.current = jQuery(obj);
+    obj.addClass('current');
+  };
+
+  _this.getPrevPageBtn = function() { return _this.container.find("li.pagination.previous a"); };
+  _this.getNextPageBtn = function() { return _this.container.find("li.pagination.next a"); };
+
+  _this.doPrevPage = function(){ if(_this.getPrevPageBtn().length > 0) _this.doPage(_this.getPrevPageBtn().attr("href")); }
+  _this.doNextPage = function(){ if(_this.getNextPageBtn().length > 0) _this.doPage(_this.getNextPageBtn().attr("href")); }
+
+  _this.doPage = function(url) {
+    jQuery.ajax({
+      url: url,
+      data: _this.js_params && _this.js_params(),
+      success: function(data) {
+        eval(data);
+        _this.highlightFirst();
+      }
+    });
+  };
+
+  _this._use_iframe_mask = function() { return false; };
+  _this.has_current = function() { return _this.current && _this.current.length > 0; };
+
+  obj.afterActivity(null, 0.35, _this);
+  initialize(obj, url, options);
+};