2005-03-11 21:42:48 -05:00
|
|
|
require File.dirname(__FILE__) + '/tag_helper'
|
|
|
|
|
2005-03-11 21:59:12 -05:00
|
|
|
module ActionView
|
|
|
|
module Helpers
|
2005-06-29 04:09:00 -04:00
|
|
|
# Provides a set of helpers for calling JavaScript functions and, most importantly, to call remote methods using what has
|
2005-07-01 03:25:44 -04:00
|
|
|
# been labelled AJAX[http://www.adaptivepath.com/publications/essays/archives/000385.php]. This means that you can call
|
2005-03-22 07:33:47 -05:00
|
|
|
# actions in your controllers without reloading the page, but still update certain parts of it using injections into the
|
|
|
|
# DOM. The common use case is having a form that adds a new element to a list without reloading the page.
|
|
|
|
#
|
2005-06-29 04:09:00 -04:00
|
|
|
# To be able to use the JavaScript helpers, you must either call <tt><%= define_javascript_functions %></tt> (which returns all
|
|
|
|
# the JavaScript support functions in a <script> block) or reference the JavaScript library using
|
2005-03-22 08:09:44 -05:00
|
|
|
# <tt><%= javascript_include_tag "prototype" %></tt> (which looks for the library in /javascripts/prototype.js). The latter is
|
2005-03-22 07:33:47 -05:00
|
|
|
# recommended as the browser can then cache the library instead of fetching all the functions anew on every request.
|
2005-03-22 07:41:34 -05:00
|
|
|
#
|
2005-07-01 03:25:44 -04:00
|
|
|
# If you're the visual type, there's an AJAX movie[http://www.rubyonrails.com/media/video/rails-ajax.mov] demonstrating
|
2005-03-22 07:41:34 -05:00
|
|
|
# the use of form_remote_tag.
|
2005-06-29 04:09:00 -04:00
|
|
|
module JavaScriptHelper
|
2005-03-20 19:57:08 -05:00
|
|
|
unless const_defined? :CALLBACKS
|
2005-06-27 13:40:00 -04:00
|
|
|
CALLBACKS =
|
2005-07-14 07:38:55 -04:00
|
|
|
[:uninitialized, :loading, :loaded, :interactive, :complete, :failure, :success].push((100..599).to_a).flatten
|
2005-07-02 07:25:21 -04:00
|
|
|
AJAX_OPTIONS = [ :before, :after, :condition, :url, :asynchronous, :method,
|
|
|
|
:insertion, :position, :form, :with, :update, :script ].concat(CALLBACKS)
|
2005-03-20 19:57:08 -05:00
|
|
|
JAVASCRIPT_PATH = File.join(File.dirname(__FILE__), 'javascripts')
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns a link that'll trigger a javascript +function+ using the
|
|
|
|
# onclick handler and return false after the fact.
|
2005-03-12 12:00:03 -05:00
|
|
|
#
|
|
|
|
# Examples:
|
|
|
|
# link_to_function "Greeting", "alert('Hello world!')"
|
|
|
|
# link_to_function(image_tag("delete"), "if confirm('Really?'){ do_delete(); }")
|
2005-03-11 21:59:12 -05:00
|
|
|
def link_to_function(name, function, html_options = {})
|
|
|
|
content_tag(
|
|
|
|
"a", name,
|
2005-04-18 01:15:17 -04:00
|
|
|
{:href => "#", :onclick => "#{function}; return false;"}.merge(html_options.symbolize_keys)
|
2005-03-11 21:59:12 -05:00
|
|
|
)
|
|
|
|
end
|
2005-03-11 21:42:48 -05:00
|
|
|
|
2005-03-20 19:57:08 -05:00
|
|
|
# Returns a link to a remote action defined by <tt>options[:url]</tt>
|
|
|
|
# (using the url_for format) that's called in the background using
|
|
|
|
# XMLHttpRequest. The result of that request can then be inserted into a
|
|
|
|
# DOM object whose id can be specified with <tt>options[:update]</tt>.
|
|
|
|
# Usually, the result would be a partial prepared by the controller with
|
|
|
|
# either render_partial or render_partial_collection.
|
2005-03-12 12:00:03 -05:00
|
|
|
#
|
|
|
|
# Examples:
|
|
|
|
# link_to_remote "Delete this post", :update => "posts", :url => { :action => "destroy", :id => post.id }
|
|
|
|
# link_to_remote(image_tag("refresh"), :update => "emails", :url => { :action => "list_emails" })
|
2005-03-14 07:47:38 -05:00
|
|
|
#
|
2005-06-27 13:40:00 -04:00
|
|
|
# You can also specify a hash for <tt>options[:update]</tt> to allow for
|
|
|
|
# easy redirection of output to an other DOM element if a server-side error occurs:
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# link_to_remote "Delete this post",
|
|
|
|
# :url => { :action => "destroy", :id => post.id },
|
|
|
|
# :update => { :success => "posts", :failure => "error" }
|
|
|
|
#
|
|
|
|
# Optionally, you can use the <tt>options[:position]</tt> parameter to influence
|
|
|
|
# how the target DOM element is updated. It must be one of
|
|
|
|
# <tt>:before</tt>, <tt>:top</tt>, <tt>:bottom</tt>, or <tt>:after</tt>.
|
|
|
|
#
|
2005-03-20 19:57:08 -05:00
|
|
|
# By default, these remote requests are processed asynchronous during
|
2005-06-27 13:40:00 -04:00
|
|
|
# which various JavaScript callbacks can be triggered (for progress indicators and
|
|
|
|
# the likes). All callbacks get access to the <tt>request</tt> object,
|
|
|
|
# which holds the underlying XMLHttpRequest.
|
|
|
|
#
|
|
|
|
# To access the server response, use <tt>request.responseText</tt>, to
|
|
|
|
# find out the HTTP status, use <tt>request.status</tt>.
|
2005-03-14 07:47:38 -05:00
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# link_to_remote word,
|
|
|
|
# :url => { :action => "undo", :n => word_counter },
|
|
|
|
# :complete => "undoRequestCompleted(request)"
|
|
|
|
#
|
2005-07-11 02:44:10 -04:00
|
|
|
# The callbacks that may be specified are (in order):
|
2005-03-14 07:47:38 -05:00
|
|
|
#
|
2005-03-20 19:57:08 -05:00
|
|
|
# <tt>:loading</tt>:: Called when the remote document is being
|
|
|
|
# loaded with data by the browser.
|
|
|
|
# <tt>:loaded</tt>:: Called when the browser has finished loading
|
|
|
|
# the remote document.
|
|
|
|
# <tt>:interactive</tt>:: Called when the user can interact with the
|
|
|
|
# remote document, even though it has not
|
|
|
|
# finished loading.
|
2005-07-11 02:44:10 -04:00
|
|
|
# <tt>:success</tt>:: Called when the XMLHttpRequest is completed,
|
|
|
|
# and the HTTP status code is in the 2XX range.
|
|
|
|
# <tt>:failure</tt>:: Called when the XMLHttpRequest is completed,
|
|
|
|
# and the HTTP status code is not in the 2XX
|
|
|
|
# range.
|
|
|
|
# <tt>:complete</tt>:: Called when the XMLHttpRequest is complete
|
|
|
|
# (fires after success/failure if they are present).,
|
|
|
|
#
|
|
|
|
# You can further refine <tt>:success</tt> and <tt>:failure</tt> by adding additional
|
2005-06-27 13:40:00 -04:00
|
|
|
# callbacks for specific status codes:
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# link_to_remote word,
|
|
|
|
# :url => { :action => "action" },
|
|
|
|
# 404 => "alert('Not found...? Wrong URL...?')",
|
|
|
|
# :failure => "alert('HTTP Error ' + request.status + '!')"
|
|
|
|
#
|
2005-07-11 02:44:10 -04:00
|
|
|
# A status code callback overrides the success/failure handlers if present.
|
2005-03-14 10:12:31 -05:00
|
|
|
#
|
2005-03-20 19:57:08 -05:00
|
|
|
# If you for some reason or another need synchronous processing (that'll
|
|
|
|
# block the browser while the request is happening), you can specify
|
|
|
|
# <tt>options[:type] = :synchronous</tt>.
|
2005-05-19 13:29:20 -04:00
|
|
|
#
|
|
|
|
# You can customize further browser side call logic by passing
|
2005-06-29 04:09:00 -04:00
|
|
|
# in JavaScript code snippets via some optional parameters. In
|
2005-05-19 13:29:20 -04:00
|
|
|
# their order of use these are:
|
|
|
|
#
|
|
|
|
# <tt>:confirm</tt>:: Adds confirmation dialog.
|
|
|
|
# <tt>:condition</tt>:: Perform remote request conditionally
|
|
|
|
# by this expression. Use this to
|
|
|
|
# describe browser-side conditions when
|
|
|
|
# request should not be initiated.
|
|
|
|
# <tt>:before</tt>:: Called before request is initiated.
|
|
|
|
# <tt>:after</tt>:: Called immediately after request was
|
|
|
|
# initiated and before <tt>:loading</tt>.
|
2005-03-13 13:06:58 -05:00
|
|
|
def link_to_remote(name, options = {}, html_options = {})
|
|
|
|
link_to_function(name, remote_function(options), html_options)
|
2005-03-11 21:59:12 -05:00
|
|
|
end
|
2005-03-11 21:42:48 -05:00
|
|
|
|
2005-04-07 02:43:21 -04:00
|
|
|
# Periodically calls the specified url (<tt>options[:url]</tt>) every <tt>options[:frequency]</tt> seconds (default is 10).
|
|
|
|
# Usually used to update a specified div (<tt>options[:update]</tt>) with the results of the remote call.
|
|
|
|
# The options for specifying the target with :url and defining callbacks is the same as link_to_remote.
|
|
|
|
def periodically_call_remote(options = {})
|
|
|
|
frequency = options[:frequency] || 10 # every ten seconds by default
|
|
|
|
code = "new PeriodicalExecuter(function() {#{remote_function(options)}}, #{frequency})"
|
|
|
|
content_tag("script", code, options[:html_options] || {})
|
|
|
|
end
|
2005-06-28 13:42:51 -04:00
|
|
|
|
2005-03-22 07:33:47 -05:00
|
|
|
# Returns a form tag that will submit using XMLHttpRequest in the background instead of the regular
|
2005-06-29 04:09:00 -04:00
|
|
|
# reloading POST arrangement. Even though it's using JavaScript to serialize the form elements, the form submission
|
2005-03-22 07:33:47 -05:00
|
|
|
# will work just like a regular submission as viewed by the receiving side (all elements available in @params).
|
|
|
|
# The options for specifying the target with :url and defining callbacks is the same as link_to_remote.
|
2005-06-21 03:08:13 -04:00
|
|
|
#
|
2005-06-29 04:09:00 -04:00
|
|
|
# A "fall-through" target for browsers that doesn't do JavaScript can be specified with the :action/:method options on :html
|
2005-06-21 03:08:13 -04:00
|
|
|
#
|
|
|
|
# form_remote_tag :html => { :action => url_for(:controller => "some", :action => "place") }
|
|
|
|
#
|
|
|
|
# By default the fall-through action is the same as the one specified in the :url (and the default method is :post).
|
2005-03-11 21:59:12 -05:00
|
|
|
def form_remote_tag(options = {})
|
|
|
|
options[:form] = true
|
2005-03-11 21:42:48 -05:00
|
|
|
|
2005-04-18 01:15:17 -04:00
|
|
|
options[:html] ||= {}
|
2005-03-11 21:59:12 -05:00
|
|
|
options[:html][:onsubmit] = "#{remote_function(options)}; return false;"
|
2005-06-21 03:08:13 -04:00
|
|
|
options[:html][:action] = options[:html][:action] || url_for(options[:url])
|
|
|
|
options[:html][:method] = options[:html][:method] || "post"
|
2005-03-11 21:42:48 -05:00
|
|
|
|
2005-03-11 21:59:12 -05:00
|
|
|
tag("form", options[:html], true)
|
|
|
|
end
|
2005-04-13 01:44:43 -04:00
|
|
|
|
2005-04-18 01:15:17 -04:00
|
|
|
# Returns a button input tag that will submit form using XMLHttpRequest in the background instead of regular
|
2005-04-13 01:44:43 -04:00
|
|
|
# reloading POST arrangement. <tt>options</tt> argument is the same as in <tt>form_remote_tag</tt>
|
2005-04-17 03:52:50 -04:00
|
|
|
def submit_to_remote(name, value, options = {})
|
2005-09-02 09:56:38 -04:00
|
|
|
options[:with] ||= 'Form.serialize(this.form)'
|
2005-04-13 01:44:43 -04:00
|
|
|
|
2005-04-17 03:52:50 -04:00
|
|
|
options[:html] ||= {}
|
|
|
|
options[:html][:type] = 'button'
|
|
|
|
options[:html][:onclick] = "#{remote_function(options)}; return false;"
|
|
|
|
options[:html][:name] = name
|
|
|
|
options[:html][:value] = value
|
|
|
|
|
|
|
|
tag("input", options[:html], false)
|
2005-04-13 01:44:43 -04:00
|
|
|
end
|
2005-07-03 07:01:43 -04:00
|
|
|
|
|
|
|
# Returns a Javascript function (or expression) that'll update a DOM element according to the options passed.
|
|
|
|
#
|
|
|
|
# * <tt>:content</tt>: The content to use for updating. Can be left out if using block, see example.
|
2005-07-04 00:57:15 -04:00
|
|
|
# * <tt>:action</tt>: Valid options are :update (assumed by default), :empty, :remove
|
|
|
|
# * <tt>:position</tt> If the :action is :update, you can optionally specify one of the following positions: :before, :top, :bottom, :after.
|
2005-07-03 07:01:43 -04:00
|
|
|
#
|
|
|
|
# Examples:
|
|
|
|
# <%= javascript_tag(update_element_function(
|
2005-07-04 00:57:15 -04:00
|
|
|
# "products", :position => :bottom, :content => "<p>New product!</p>")) %>
|
2005-07-03 07:01:43 -04:00
|
|
|
#
|
2005-07-04 00:57:15 -04:00
|
|
|
# <% replacement_function = update_element_function("products") do %>
|
2005-07-03 07:01:43 -04:00
|
|
|
# <p>Product 1</p>
|
|
|
|
# <p>Product 2</p>
|
|
|
|
# <% end %>
|
|
|
|
# <%= javascript_tag(replacement_function) %>
|
|
|
|
#
|
|
|
|
# This method can also be used in combination with remote method call where the result is evaluated afterwards to cause
|
|
|
|
# multiple updates on a page. Example:
|
|
|
|
#
|
|
|
|
# # Calling view
|
|
|
|
# <%= form_remote_tag :url => { :action => "buy" }, :complete => evaluate_remote_response %>
|
|
|
|
# all the inputs here...
|
|
|
|
#
|
|
|
|
# # Controller action
|
|
|
|
# def buy
|
|
|
|
# @product = Product.find(1)
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# # Returning view
|
|
|
|
# <%= update_element_function(
|
2005-07-04 00:57:15 -04:00
|
|
|
# "cart", :action => :update, :position => :bottom,
|
2005-07-03 07:01:43 -04:00
|
|
|
# :content => "<p>New Product: #{@product.name}</p>")) %>
|
2005-07-04 00:57:15 -04:00
|
|
|
# <% update_element_function("status", :binding => binding) do %>
|
2005-07-03 07:01:43 -04:00
|
|
|
# You've bought a new product!
|
|
|
|
# <% end %>
|
|
|
|
#
|
|
|
|
# Notice how the second call doesn't need to be in an ERb output block since it uses a block and passes in the binding
|
|
|
|
# to render directly. This trick will however only work in ERb (not Builder or other template forms).
|
2005-07-04 00:57:15 -04:00
|
|
|
def update_element_function(element_id, options = {}, &block)
|
|
|
|
|
|
|
|
content = escape_javascript(options[:content] || '')
|
|
|
|
content = escape_javascript(capture(&block)) if block
|
|
|
|
|
|
|
|
javascript_function = case (options[:action] || :update)
|
|
|
|
when :update
|
|
|
|
if options[:position]
|
|
|
|
"new Insertion.#{options[:position].to_s.camelize}('#{element_id}','#{content}')"
|
|
|
|
else
|
|
|
|
"$('#{element_id}').innerHTML = '#{content}'"
|
2005-07-03 07:01:43 -04:00
|
|
|
end
|
2005-07-04 00:57:15 -04:00
|
|
|
|
2005-07-03 07:01:43 -04:00
|
|
|
when :empty
|
|
|
|
"$('#{element_id}').innerHTML = ''"
|
2005-07-04 00:57:15 -04:00
|
|
|
|
|
|
|
when :remove
|
|
|
|
"Element.remove('#{element_id}')"
|
|
|
|
|
2005-07-03 07:01:43 -04:00
|
|
|
else
|
2005-07-04 00:57:15 -04:00
|
|
|
raise ArgumentError, "Invalid action, choose one of :update, :remove, :empty"
|
2005-07-03 07:01:43 -04:00
|
|
|
end
|
|
|
|
|
2005-07-04 00:57:15 -04:00
|
|
|
javascript_function << ";\n"
|
2005-07-03 07:01:43 -04:00
|
|
|
options[:binding] ? concat(javascript_function, options[:binding]) : javascript_function
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns 'eval(request.responseText)' which is the Javascript function that form_remote_tag can call in :complete to
|
|
|
|
# evaluate a multiple update return document using update_element_function calls.
|
|
|
|
def evaluate_remote_response
|
2005-07-04 00:57:15 -04:00
|
|
|
"eval(request.responseText)"
|
2005-07-03 07:01:43 -04:00
|
|
|
end
|
2005-03-11 21:59:12 -05:00
|
|
|
|
2005-07-17 05:23:56 -04:00
|
|
|
# Returns the javascript needed for a remote function.
|
|
|
|
# Takes the same arguments as link_to_remote
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# <select id="options" onchange="<%= remote_function(:update => "options", :url => { :action => :update_options }) %>">
|
|
|
|
# <option value="0">Hello</option>
|
|
|
|
# <option value="1">World</option>
|
|
|
|
# </select>
|
|
|
|
def remote_function(options)
|
2005-03-20 19:57:08 -05:00
|
|
|
javascript_options = options_for_ajax(options)
|
2005-03-14 11:28:44 -05:00
|
|
|
|
2005-07-03 04:00:38 -04:00
|
|
|
update = ''
|
2005-06-27 13:40:00 -04:00
|
|
|
if options[:update] and options[:update].is_a?Hash
|
2005-07-03 04:00:38 -04:00
|
|
|
update = []
|
2005-06-27 13:40:00 -04:00
|
|
|
update << "success:'#{options[:update][:success]}'" if options[:update][:success]
|
|
|
|
update << "failure:'#{options[:update][:failure]}'" if options[:update][:failure]
|
2005-07-03 04:00:38 -04:00
|
|
|
update = '{' + update.join(',') + '}'
|
2005-06-27 13:40:00 -04:00
|
|
|
elsif options[:update]
|
2005-07-03 04:00:38 -04:00
|
|
|
update << "'#{options[:update]}'"
|
2005-06-27 13:40:00 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
function = update.empty? ?
|
|
|
|
"new Ajax.Request(" :
|
2005-07-03 04:00:38 -04:00
|
|
|
"new Ajax.Updater(#{update}, "
|
2005-03-14 11:28:44 -05:00
|
|
|
|
|
|
|
function << "'#{url_for(options[:url])}'"
|
2005-03-20 19:57:08 -05:00
|
|
|
function << ", #{javascript_options})"
|
2005-06-27 13:40:00 -04:00
|
|
|
|
2005-03-14 10:12:31 -05:00
|
|
|
function = "#{options[:before]}; #{function}" if options[:before]
|
|
|
|
function = "#{function}; #{options[:after]}" if options[:after]
|
|
|
|
function = "if (#{options[:condition]}) { #{function}; }" if options[:condition]
|
2005-04-13 01:21:37 -04:00
|
|
|
function = "if (confirm('#{escape_javascript(options[:confirm])}')) { #{function}; }" if options[:confirm]
|
2005-06-27 13:40:00 -04:00
|
|
|
|
2005-03-14 10:12:31 -05:00
|
|
|
return function
|
|
|
|
end
|
|
|
|
|
2005-06-29 04:09:00 -04:00
|
|
|
# Includes the Action Pack JavaScript libraries inside a single <script>
|
2005-06-26 08:03:43 -04:00
|
|
|
# tag. The function first includes prototype.js and then its core extensions,
|
|
|
|
# (determined by filenames starting with "prototype").
|
|
|
|
# Afterwards, any additional scripts will be included in random order.
|
2005-03-20 19:57:08 -05:00
|
|
|
#
|
|
|
|
# Note: The recommended approach is to copy the contents of
|
|
|
|
# lib/action_view/helpers/javascripts/ into your application's
|
|
|
|
# public/javascripts/ directory, and use +javascript_include_tag+ to
|
|
|
|
# create remote <script> links.
|
2005-03-11 21:59:12 -05:00
|
|
|
def define_javascript_functions
|
2005-03-20 19:57:08 -05:00
|
|
|
javascript = '<script type="text/javascript">'
|
2005-06-26 08:03:43 -04:00
|
|
|
|
|
|
|
# load prototype.js and its extensions first
|
|
|
|
prototype_libs = Dir.glob(File.join(JAVASCRIPT_PATH, 'prototype*')).sort.reverse
|
|
|
|
prototype_libs.each do |filename|
|
|
|
|
javascript << "\n" << IO.read(filename)
|
|
|
|
end
|
|
|
|
|
|
|
|
# load other librairies
|
|
|
|
(Dir.glob(File.join(JAVASCRIPT_PATH, '*')) - prototype_libs).each do |filename|
|
|
|
|
javascript << "\n" << IO.read(filename)
|
|
|
|
end
|
2005-03-20 19:57:08 -05:00
|
|
|
javascript << '</script>'
|
|
|
|
end
|
2005-03-11 21:42:48 -05:00
|
|
|
|
2005-03-20 19:57:08 -05:00
|
|
|
# Observes the field with the DOM ID specified by +field_id+ and makes
|
2005-07-01 03:25:44 -04:00
|
|
|
# an AJAX call when its contents have changed.
|
2005-03-20 19:57:08 -05:00
|
|
|
#
|
|
|
|
# Required +options+ are:
|
|
|
|
# <tt>:url</tt>:: +url_for+-style options for the action to call
|
|
|
|
# when the field has changed.
|
|
|
|
#
|
|
|
|
# Additional options are:
|
2005-06-27 01:29:47 -04:00
|
|
|
# <tt>:frequency</tt>:: The frequency (in seconds) at which changes to
|
2005-09-02 10:06:17 -04:00
|
|
|
# this field will be detected. Not setting this
|
|
|
|
# option at all or to a value equal to or less than
|
|
|
|
# zero will use event based observation instead of
|
|
|
|
# time based observation.
|
2005-03-20 19:57:08 -05:00
|
|
|
# <tt>:update</tt>:: Specifies the DOM ID of the element whose
|
|
|
|
# innerHTML should be updated with the
|
|
|
|
# XMLHttpRequest response text.
|
2005-06-29 04:09:00 -04:00
|
|
|
# <tt>:with</tt>:: A JavaScript expression specifying the
|
2005-03-20 19:57:08 -05:00
|
|
|
# parameters for the XMLHttpRequest. This defaults
|
|
|
|
# to 'value', which in the evaluated context
|
|
|
|
# refers to the new field value.
|
|
|
|
#
|
|
|
|
# Additionally, you may specify any of the options documented in
|
|
|
|
# +link_to_remote.
|
|
|
|
def observe_field(field_id, options = {})
|
2005-09-02 10:06:17 -04:00
|
|
|
if options[:frequency] and options[:frequency] > 0
|
2005-06-27 01:29:47 -04:00
|
|
|
build_observer('Form.Element.Observer', field_id, options)
|
|
|
|
else
|
2005-06-30 01:58:40 -04:00
|
|
|
build_observer('Form.Element.EventObserver', field_id, options)
|
2005-06-27 01:29:47 -04:00
|
|
|
end
|
2005-03-20 19:57:08 -05:00
|
|
|
end
|
2005-03-13 10:47:06 -05:00
|
|
|
|
2005-03-20 19:57:08 -05:00
|
|
|
# Like +observe_field+, but operates on an entire form identified by the
|
|
|
|
# DOM ID +form_id+. +options+ are the same as +observe_field+, except
|
|
|
|
# the default value of the <tt>:with</tt> option evaluates to the
|
|
|
|
# serialized (request string) value of the form.
|
|
|
|
def observe_form(form_id, options = {})
|
2005-06-27 01:29:47 -04:00
|
|
|
if options[:frequency]
|
|
|
|
build_observer('Form.Observer', form_id, options)
|
|
|
|
else
|
|
|
|
build_observer('Form.EventObserver', form_id, options)
|
|
|
|
end
|
2005-03-20 19:57:08 -05:00
|
|
|
end
|
2005-06-26 08:03:43 -04:00
|
|
|
|
|
|
|
|
2005-07-01 03:25:44 -04:00
|
|
|
# Adds AJAX autocomplete functionality to the text input field with the
|
2005-06-26 08:03:43 -04:00
|
|
|
# DOM ID specified by +field_id+.
|
|
|
|
#
|
|
|
|
# This function expects that the called action returns a HTML <ul> list,
|
|
|
|
# or nothing if no entries should be displayed for autocompletion.
|
2005-06-29 13:08:14 -04:00
|
|
|
#
|
|
|
|
# You'll probably want to turn the browser's built-in autocompletion off,
|
|
|
|
# su be sure to include a autocomplete="off" attribute with your text
|
|
|
|
# input field.
|
2005-06-26 08:03:43 -04:00
|
|
|
#
|
|
|
|
# Required +options+ are:
|
|
|
|
# <tt>:url</tt>:: Specifies the DOM ID of the element whose
|
|
|
|
# innerHTML should be updated with the autocomplete
|
|
|
|
# entries returned by XMLHttpRequest.
|
|
|
|
#
|
|
|
|
# Addtional +options+ are:
|
|
|
|
# <tt>:update</tt>:: Specifies the DOM ID of the element whose
|
|
|
|
# innerHTML should be updated with the autocomplete
|
2005-07-01 03:25:44 -04:00
|
|
|
# entries returned by the AJAX request.
|
2005-06-26 10:23:36 -04:00
|
|
|
# Defaults to field_id + '_auto_complete'
|
2005-06-29 04:09:00 -04:00
|
|
|
# <tt>:with</tt>:: A JavaScript expression specifying the
|
2005-06-26 08:03:43 -04:00
|
|
|
# parameters for the XMLHttpRequest. This defaults
|
2005-07-02 07:25:21 -04:00
|
|
|
# to 'fieldname=value'.
|
2005-06-26 08:03:43 -04:00
|
|
|
# <tt>:indicator</tt>:: Specifies the DOM ID of an elment which will be
|
|
|
|
# displayed while autocomplete is running.
|
2005-06-26 10:23:36 -04:00
|
|
|
def auto_complete_field(field_id, options = {})
|
2005-06-26 08:03:43 -04:00
|
|
|
function = "new Ajax.Autocompleter("
|
|
|
|
function << "'#{field_id}', "
|
2005-06-26 10:23:36 -04:00
|
|
|
function << "'" + (options[:update] || "#{field_id}_auto_complete") + "', "
|
2005-06-26 08:03:43 -04:00
|
|
|
function << "'#{url_for(options[:url])}'"
|
2005-07-11 01:17:22 -04:00
|
|
|
|
2005-06-26 08:03:43 -04:00
|
|
|
js_options = {}
|
2005-07-17 05:15:41 -04:00
|
|
|
js_options[:tokens] = array_or_string_for_javascript(options[:tokens]) if options[:tokens]
|
2005-07-02 07:25:21 -04:00
|
|
|
js_options[:callback] = "function(element, value) { return #{options[:with]} }" if options[:with]
|
|
|
|
js_options[:indicator] = "'#{options[:indicator]}'" if options[:indicator]
|
2005-06-26 08:03:43 -04:00
|
|
|
function << (', ' + options_for_javascript(js_options) + ')')
|
2005-06-26 10:23:36 -04:00
|
|
|
|
2005-06-26 08:03:43 -04:00
|
|
|
javascript_tag(function)
|
|
|
|
end
|
|
|
|
|
2005-07-01 03:25:44 -04:00
|
|
|
# Use this method in your view to generate a return for the AJAX automplete requests.
|
2005-06-26 08:03:43 -04:00
|
|
|
#
|
2005-06-26 10:23:36 -04:00
|
|
|
# Example action:
|
|
|
|
#
|
|
|
|
# def auto_complete_for_item_title
|
2005-07-01 03:25:44 -04:00
|
|
|
# @items = Item.find(:all,
|
|
|
|
# :conditions => [ 'LOWER(description) LIKE ?',
|
|
|
|
# '%' + request.raw_post.downcase + '%' ])
|
2005-06-26 10:23:36 -04:00
|
|
|
# render :inline => '<%= auto_complete_result(@items, 'description') %>'
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# The auto_complete_result can of course also be called from a view belonging to the
|
|
|
|
# auto_complete action if you need to decorate it further.
|
|
|
|
def auto_complete_result(entries, field, phrase = nil)
|
|
|
|
return unless entries
|
|
|
|
items = entries.map { |entry| content_tag("li", phrase ? highlight(entry[field], phrase) : h(entry[field])) }
|
|
|
|
content_tag("ul", items)
|
|
|
|
end
|
|
|
|
|
2005-07-01 03:25:44 -04:00
|
|
|
# Wrapper for text_field with added AJAX autocompletion functionality.
|
|
|
|
#
|
|
|
|
# In your controller, you'll need to define an action called
|
|
|
|
# auto_complete_for_object_method to respond the AJAX calls,
|
|
|
|
#
|
|
|
|
# See the RDoc on ActionController::AutoComplete to learn more about this.
|
2005-06-26 10:23:36 -04:00
|
|
|
def text_field_with_auto_complete(object, method, tag_options = {}, completion_options = {})
|
|
|
|
(completion_options[:skip_style] ? "" : auto_complete_stylesheet) +
|
2005-06-29 13:08:14 -04:00
|
|
|
text_field(object, method, { :autocomplete => "off" }.merge!(tag_options)) +
|
2005-06-26 10:23:36 -04:00
|
|
|
content_tag("div", "", :id => "#{object}_#{method}_auto_complete", :class => "auto_complete") +
|
|
|
|
auto_complete_field("#{object}_#{method}", { :url => { :action => "auto_complete_for_#{object}_#{method}" } }.update(completion_options))
|
2005-06-26 08:03:43 -04:00
|
|
|
end
|
|
|
|
|
2005-07-01 03:25:44 -04:00
|
|
|
# Returns a JavaScript snippet to be used on the AJAX callbacks for starting
|
2005-06-26 08:03:43 -04:00
|
|
|
# visual effects.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# <%= link_to_remote "Reload", :update => "posts",
|
|
|
|
# :url => { :action => "reload" },
|
|
|
|
# :complete => visual_effect(:highlight, "posts", :duration => 0.5 )
|
|
|
|
#
|
2005-07-02 07:25:21 -04:00
|
|
|
# If no element_id is given, it assumes "element" which should be a local
|
|
|
|
# variable in the generated JavaScript execution context. This can be used
|
|
|
|
# for example with drop_receiving_element:
|
|
|
|
#
|
|
|
|
# <%= drop_receving_element (...), :loading => visual_effect(:fade) %>
|
|
|
|
#
|
|
|
|
# This would fade the element that was dropped on the drop receiving element.
|
|
|
|
#
|
2005-06-26 08:03:43 -04:00
|
|
|
# You can change the behaviour with various options, see
|
|
|
|
# http://script.aculo.us for more documentation.
|
2005-07-02 07:25:21 -04:00
|
|
|
def visual_effect(name, element_id = false, js_options = {})
|
|
|
|
element = element_id ? "'#{element_id}'" : "element"
|
2005-07-07 04:46:31 -04:00
|
|
|
"new Effect.#{name.to_s.camelize}(#{element},#{options_for_javascript(js_options)});"
|
2005-06-26 08:03:43 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
# Makes the element with the DOM ID specified by +element_id+ sortable
|
2005-07-01 03:25:44 -04:00
|
|
|
# by drag-and-drop and make an AJAX call whenever the sort order has
|
2005-06-26 08:03:43 -04:00
|
|
|
# changed. By default, the action called gets the serialized sortable
|
|
|
|
# element as parameters.
|
|
|
|
#
|
|
|
|
# Example:
|
2005-07-01 03:25:44 -04:00
|
|
|
# <%= sortable_element("my_list", :url => { :action => "order" }) %>
|
2005-06-26 08:03:43 -04:00
|
|
|
#
|
|
|
|
# In the example, the action gets a "my_list" array parameter
|
|
|
|
# containing the values of the ids of elements the sortable consists
|
|
|
|
# of, in the current order.
|
|
|
|
#
|
|
|
|
# You can change the behaviour with various options, see
|
|
|
|
# http://script.aculo.us for more documentation.
|
2005-06-26 10:34:13 -04:00
|
|
|
def sortable_element(element_id, options = {})
|
2005-06-26 08:03:43 -04:00
|
|
|
options[:with] ||= "Sortable.serialize('#{element_id}')"
|
|
|
|
options[:onUpdate] ||= "function(){" + remote_function(options) + "}"
|
|
|
|
options.delete_if { |key, value| AJAX_OPTIONS.include?(key) }
|
|
|
|
|
2005-07-07 10:34:26 -04:00
|
|
|
[:tag, :overlap, :constraint, :handle].each do |option|
|
2005-07-06 04:32:04 -04:00
|
|
|
options[option] = "'#{options[option]}'" if options[option]
|
|
|
|
end
|
|
|
|
|
2005-07-17 05:15:41 -04:00
|
|
|
options[:containment] = array_or_string_for_javascript(options[:containment]) if options[:containment]
|
|
|
|
options[:only] = array_or_string_for_javascript(options[:only]) if options[:only]
|
2005-07-06 04:32:04 -04:00
|
|
|
|
2005-06-26 08:03:43 -04:00
|
|
|
javascript_tag("Sortable.create('#{element_id}', #{options_for_javascript(options)})")
|
|
|
|
end
|
2005-07-02 07:25:21 -04:00
|
|
|
|
|
|
|
# Makes the element with the DOM ID specified by +element_id+ draggable.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# <%= draggable_element("my_image", :revert => true)
|
|
|
|
#
|
|
|
|
# You can change the behaviour with various options, see
|
|
|
|
# http://script.aculo.us for more documentation.
|
|
|
|
def draggable_element(element_id, options = {})
|
|
|
|
javascript_tag("new Draggable('#{element_id}', #{options_for_javascript(options)})")
|
|
|
|
end
|
|
|
|
|
|
|
|
# Makes the element with the DOM ID specified by +element_id+ receive
|
|
|
|
# dropped draggable elements (created by draggable_element).
|
|
|
|
# and make an AJAX call By default, the action called gets the DOM ID of the
|
|
|
|
# element as parameter.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# <%= drop_receiving_element("my_cart", :url => { :controller => "cart", :action => "add" }) %>
|
|
|
|
#
|
|
|
|
# You can change the behaviour with various options, see
|
|
|
|
# http://script.aculo.us for more documentation.
|
|
|
|
def drop_receiving_element(element_id, options = {})
|
|
|
|
options[:with] ||= "'id=' + encodeURIComponent(element.id)"
|
|
|
|
options[:onDrop] ||= "function(element){" + remote_function(options) + "}"
|
|
|
|
options.delete_if { |key, value| AJAX_OPTIONS.include?(key) }
|
|
|
|
|
2005-07-17 05:15:41 -04:00
|
|
|
options[:accept] = array_or_string_for_javascript(options[:accept]) if options[:accept]
|
2005-07-02 07:25:21 -04:00
|
|
|
options[:hoverclass] = "'#{options[:hoverclass]}'" if options[:hoverclass]
|
|
|
|
|
|
|
|
javascript_tag("Droppables.add('#{element_id}', #{options_for_javascript(options)})")
|
|
|
|
end
|
2005-03-14 07:47:38 -05:00
|
|
|
|
2005-06-29 04:09:00 -04:00
|
|
|
# Escape carrier returns and single and double quotes for JavaScript segments.
|
2005-03-20 19:57:08 -05:00
|
|
|
def escape_javascript(javascript)
|
2005-03-26 09:03:55 -05:00
|
|
|
(javascript || '').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
|
2005-03-20 19:57:08 -05:00
|
|
|
end
|
2005-03-26 09:03:55 -05:00
|
|
|
|
2005-06-29 04:09:00 -04:00
|
|
|
# Returns a JavaScript tag with the +content+ inside. Example:
|
2005-06-26 08:03:43 -04:00
|
|
|
# javascript_tag "alert('All is good')" # => <script type="text/javascript">alert('All is good')</script>
|
|
|
|
def javascript_tag(content)
|
|
|
|
content_tag("script", content, :type => "text/javascript")
|
|
|
|
end
|
|
|
|
|
2005-03-26 15:27:04 -05:00
|
|
|
private
|
2005-06-26 08:03:43 -04:00
|
|
|
def options_for_javascript(options)
|
2005-07-10 01:11:23 -04:00
|
|
|
'{' + options.map {|k, v| "#{k}:#{v}"}.sort.join(', ') + '}'
|
2005-06-26 08:03:43 -04:00
|
|
|
end
|
|
|
|
|
2005-07-17 05:15:41 -04:00
|
|
|
def array_or_string_for_javascript(option)
|
|
|
|
js_option = if option.kind_of?(Array)
|
|
|
|
"['#{option.join('\',\'')}']"
|
|
|
|
elsif !option.nil?
|
|
|
|
"'#{option}'"
|
|
|
|
end
|
|
|
|
js_option
|
|
|
|
end
|
|
|
|
|
2005-03-20 19:57:08 -05:00
|
|
|
def options_for_ajax(options)
|
|
|
|
js_options = build_callbacks(options)
|
|
|
|
|
|
|
|
js_options['asynchronous'] = options[:type] != :synchronous
|
2005-05-19 15:08:16 -04:00
|
|
|
js_options['method'] = method_option_to_s(options[:method]) if options[:method]
|
2005-03-26 18:16:55 -05:00
|
|
|
js_options['insertion'] = "Insertion.#{options[:position].to_s.camelize}" if options[:position]
|
2005-07-02 07:25:21 -04:00
|
|
|
js_options['evalScripts'] = options[:script].nil? || options[:script]
|
2005-07-01 03:25:44 -04:00
|
|
|
|
2005-03-20 19:57:08 -05:00
|
|
|
if options[:form]
|
|
|
|
js_options['parameters'] = 'Form.serialize(this)'
|
|
|
|
elsif options[:with]
|
|
|
|
js_options['parameters'] = options[:with]
|
|
|
|
end
|
|
|
|
|
2005-06-26 08:03:43 -04:00
|
|
|
options_for_javascript(js_options)
|
2005-03-20 19:57:08 -05:00
|
|
|
end
|
2005-06-28 13:42:51 -04:00
|
|
|
|
2005-05-19 15:08:16 -04:00
|
|
|
def method_option_to_s(method)
|
|
|
|
(method.is_a?(String) and !method.index("'").nil?) ? method : "'#{method}'"
|
|
|
|
end
|
|
|
|
|
2005-03-20 19:57:08 -05:00
|
|
|
def build_observer(klass, name, options = {})
|
|
|
|
options[:with] ||= 'value' if options[:update]
|
|
|
|
callback = remote_function(options)
|
|
|
|
javascript = '<script type="text/javascript">'
|
|
|
|
javascript << "new #{klass}('#{name}', "
|
2005-06-27 01:29:47 -04:00
|
|
|
javascript << "#{options[:frequency]}, " if options[:frequency]
|
|
|
|
javascript << "function(element, value) {"
|
2005-03-20 19:57:08 -05:00
|
|
|
javascript << "#{callback}})</script>"
|
2005-03-11 21:59:12 -05:00
|
|
|
end
|
2005-03-20 19:57:08 -05:00
|
|
|
|
|
|
|
def build_callbacks(options)
|
2005-06-27 13:40:00 -04:00
|
|
|
callbacks = {}
|
|
|
|
options.each do |callback, code|
|
|
|
|
if CALLBACKS.include?(callback)
|
2005-03-21 18:41:25 -05:00
|
|
|
name = 'on' + callback.to_s.capitalize
|
|
|
|
callbacks[name] = "function(request){#{code}}"
|
|
|
|
end
|
2005-03-14 07:47:38 -05:00
|
|
|
end
|
2005-06-27 13:40:00 -04:00
|
|
|
callbacks
|
2005-03-20 19:57:08 -05:00
|
|
|
end
|
2005-06-26 10:23:36 -04:00
|
|
|
|
|
|
|
def auto_complete_stylesheet
|
|
|
|
content_tag("style", <<-EOT
|
|
|
|
div.auto_complete {
|
|
|
|
width: 350px;
|
2005-07-05 06:31:28 -04:00
|
|
|
background: #fff;
|
2005-06-26 10:23:36 -04:00
|
|
|
}
|
|
|
|
div.auto_complete ul {
|
|
|
|
border:1px solid #888;
|
|
|
|
margin:0;
|
|
|
|
padding:0;
|
|
|
|
width:100%;
|
|
|
|
list-style-type:none;
|
|
|
|
}
|
|
|
|
div.auto_complete ul li {
|
|
|
|
margin:0;
|
|
|
|
padding:3px;
|
|
|
|
}
|
|
|
|
div.auto_complete ul li.selected {
|
|
|
|
background-color: #ffb;
|
|
|
|
}
|
|
|
|
div.auto_complete ul strong.highlight {
|
|
|
|
color: #800;
|
|
|
|
margin:0;
|
|
|
|
padding:0;
|
|
|
|
}
|
|
|
|
EOT
|
|
|
|
)
|
|
|
|
end
|
2005-03-11 21:42:48 -05:00
|
|
|
end
|
2005-06-29 04:09:00 -04:00
|
|
|
|
|
|
|
JavascriptHelper = JavaScriptHelper unless const_defined? :JavascriptHelper
|
2005-03-11 21:59:12 -05:00
|
|
|
end
|
2005-03-14 07:47:38 -05:00
|
|
|
end
|