Module ActionView::Helpers::PrototypeHelper::JavaScriptGenerator::GeneratorMethods
In: vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb

JavaScriptGenerator generates blocks of JavaScript code that allow you to change the content and presentation of multiple DOM elements. Use this in your Ajax response bodies, either in a <script> tag or as plain JavaScript sent with a Content-type of "text/javascript".

Create new instances with PrototypeHelper#update_page or with ActionController::Base#render, then call insert_html, replace_html, remove, show, hide, visual_effect, or any other of the built-in methods on the yielded generator in any order you like to modify the content and appearance of the current page.

Example:

  update_page do |page|
    page.insert_html :bottom, 'list', "<li>#{@item.name}</li>"
    page.visual_effect :highlight, 'list'
    page.hide 'status-indicator', 'cancel-link'
  end

generates the following JavaScript:

  new Insertion.Bottom("list", "<li>Some item</li>");
  new Effect.Highlight("list");
  ["status-indicator", "cancel-link"].each(Element.hide);

Helper methods can be used in conjunction with JavaScriptGenerator. When a helper method is called inside an update block on the page object, that method will also have access to a page object.

Example:

  module ApplicationHelper
    def update_time
      page.replace_html 'time', Time.now.to_s(:db)
      page.visual_effect :highlight, 'time'
    end
  end

  # Controller action
  def poll
    render(:update) { |page| page.update_time }
  end

You can also use PrototypeHelper#update_page_tag instead of PrototypeHelper#update_page to wrap the generated JavaScript in a <script> tag.

Methods

<<   []   alert   assign   call   delay   draggable   drop_receiving   hide   insert_html   redirect_to   remove   replace   replace_html   select   show   sortable   toggle   visual_effect  

Public Instance methods

Writes raw JavaScript to the page.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 593
593:           def <<(javascript)
594:             @lines << javascript
595:           end

Returns a element reference by finding it through id in the DOM. This element can then be used for further method calls. Examples:

  page['blank_slate']                  # => $('blank_slate');
  page['blank_slate'].show             # => $('blank_slate').show();
  page['blank_slate'].show('first').up # => $('blank_slate').show('first').up();

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 451
451:           def [](id)
452:             JavaScriptElementProxy.new(self, id)
453:           end

Displays an alert dialog with the given message.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 571
571:           def alert(message)
572:             call 'alert', message
573:           end

Assigns the JavaScript variable the given value.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 588
588:           def assign(variable, value)
589:             record "#{variable} = #{javascript_object_for(value)}"
590:           end

Calls the JavaScript function, optionally with the given arguments.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 583
583:           def call(function, *arguments)
584:             record "#{function}(#{arguments_for_call(arguments)})"
585:           end

Executes the content of the block after a delay of seconds. Example:

  page.delay(20) do
    page.visual_effect :fade, 'notice'
  end

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 602
602:           def delay(seconds = 1)
603:             record "setTimeout(function() {\n\n"
604:             yield
605:             record "}, #{(seconds * 1000).to_i})"
606:           end

Creates a script.aculo.us draggable element. See ActionView::Helpers::ScriptaculousHelper for more information.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 624
624:           def draggable(id, options = {})
625:             record @context.send(:draggable_element_js, id, options)
626:           end

Creates a script.aculo.us drop receiving element. See ActionView::Helpers::ScriptaculousHelper for more information.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 630
630:           def drop_receiving(id, options = {})
631:             record @context.send(:drop_receiving_element_js, id, options)
632:           end

Hides the visible DOM elements with the given ids.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 561
561:           def hide(*ids)
562:             call 'Element.hide', *ids
563:           end

Inserts HTML at the specified position relative to the DOM element identified by the given id.

position may be one of:

:top:HTML is inserted inside the element, before the element’s existing content.
:bottom:HTML is inserted inside the element, after the element’s existing content.
:before:HTML is inserted immediately preceeding the element.
:after:HTML is inserted immediately following the element.

options_for_render may be either a string of HTML to insert, or a hash of options to be passed to ActionView::Base#render. For example:

  # Insert the rendered 'navigation' partial just before the DOM
  # element with ID 'content'.
  insert_html :before, 'content', :partial => 'navigation'

  # Add a list item to the bottom of the <ul> with ID 'list'.
  insert_html :bottom, 'list', '<li>Last item</li>'

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 502
502:           def insert_html(position, id, *options_for_render)
503:             insertion = position.to_s.camelize
504:             call "new Insertion.#{insertion}", id, render(*options_for_render)
505:           end

Redirects the browser to the given location, in the same form as url_for.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 577
577:           def redirect_to(location)
578:             assign 'window.location.href', @context.url_for(location)
579:           end

Removes the DOM elements with the given ids from the page.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 551
551:           def remove(*ids)
552:             record "#{javascript_object_for(ids)}.each(Element.remove)"
553:           end

Replaces the "outer HTML" (i.e., the entire element, not just its contents) of the DOM element with the given id.

options_for_render may be either a string of HTML to insert, or a hash of options to be passed to ActionView::Base#render. For example:

  # Replace the DOM element having ID 'person-45' with the
  # 'person' partial for the appropriate object.
  replace_html 'person-45', :partial => 'person', :object => @person

This allows the same partial that is used for the insert_html to be also used for the input to replace without resorting to the use of wrapper elements.

Examples:

  <div id="people">
    <%= render :partial => 'person', :collection => @people %>
  </div>

  # Insert a new person
  page.insert_html :bottom, :partial => 'person', :object => @person

  # Replace an existing person
  page.replace 'person_45', :partial => 'person', :object => @person

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 546
546:           def replace(id, *options_for_render)
547:             call 'Element.replace', id, render(*options_for_render)
548:           end

Replaces the inner HTML of the DOM element with the given id.

options_for_render may be either a string of HTML to insert, or a hash of options to be passed to ActionView::Base#render. For example:

  # Replace the HTML of the DOM element having ID 'person-45' with the
  # 'person' partial for the appropriate object.
  replace_html 'person-45', :partial => 'person', :object => @person

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 516
516:           def replace_html(id, *options_for_render)
517:             call 'Element.update', id, render(*options_for_render)
518:           end

Returns a collection reference by finding it through a CSS pattern in the DOM. This collection can then be used for further method calls. Examples:

  page.select('p')                      # => $$('p');
  page.select('p.welcome b').first      # => $$('p.welcome b').first();
  page.select('p.welcome b').first.hide # => $$('p.welcome b').first().hide();

You can also use prototype enumerations with the collection. Observe:

  page.select('#items li').each do |value|
    value.hide
  end
  # => $$('#items li').each(function(value) { value.hide(); });

Though you can call the block param anything you want, they are always rendered in the javascript as ‘value, index.’ Other enumerations, like collect() return the last statement:

  page.select('#items li').collect('hidden') do |item|
    item.hide
  end
  # => var hidden = $$('#items li').collect(function(value, index) { return value.hide(); });

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 476
476:           def select(pattern)
477:             JavaScriptElementCollectionProxy.new(self, pattern)
478:           end

Shows hidden DOM elements with the given ids.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 556
556:           def show(*ids)
557:             call 'Element.show', *ids
558:           end

Creates a script.aculo.us sortable element. Useful to recreate sortable elements after items get added or deleted. See ActionView::Helpers::ScriptaculousHelper for more information.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 618
618:           def sortable(id, options = {})
619:             record @context.send(:sortable_element_js, id, options)
620:           end

Toggles the visibility of the DOM elements with the given ids.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 566
566:           def toggle(*ids)
567:             call 'Element.toggle', *ids
568:           end

Starts a script.aculo.us visual effect. See ActionView::Helpers::ScriptaculousHelper for more information.

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb, line 610
610:           def visual_effect(name, id = nil, options = {})
611:             record @context.send(:visual_effect, name, id, options)
612:           end

[Validate]