doc/rdoc/classes/BivouacHelpers/FormView.html in bivouac-0.1.5 vs doc/rdoc/classes/BivouacHelpers/FormView.html in bivouac-0.1.6

- old
+ new

@@ -64,17 +64,17 @@ "<a href="../../files/AUTHORS.html" value="File: AUTHORS">AUTHORS</a>", "<a href="../../files/COPYING.html" value="File: COPYING">COPYING</a>", "<a href="../../files/lib/bivouac/helpers/view/goh/base_rb.html" value="File: base.rb">lib/bivouac/helpers/view/goh/base.rb</a>", "<a href="../../files/lib/bivouac/helpers/view/goh/form_rb.html" value="File: form.rb">lib/bivouac/helpers/view/goh/form.rb</a>", "<a href="../../files/lib/bivouac/helpers/view/goh/html_rb.html" value="File: html.rb">lib/bivouac/helpers/view/goh/html.rb</a>", -"<a href="../../files/lib/bivouac/helpers/view/goh/tooltip_rb.html" value="File: tooltip.rb">lib/bivouac/helpers/view/goh/tooltip.rb</a>", +"<a href="../../files/lib/bivouac/helpers/view/goh/sound_rb.html" value="File: sound.rb">lib/bivouac/helpers/view/goh/sound.rb</a>", "<a href="../../files/lib/bivouac/helpers/view/goh/scriptaculous_rb.html" value="File: scriptaculous.rb">lib/bivouac/helpers/view/goh/scriptaculous.rb</a>", "<a href="../../files/lib/bivouac/helpers/view/goh/javascript_rb.html" value="File: javascript.rb">lib/bivouac/helpers/view/goh/javascript.rb</a>", <a href="http://greg.rubyfr.net">nil</a>].each do<br /> <a href="../../classes/JavaScriptGenerator.html" title="Class: JavaScriptGenerator">JavaScriptGenerator</a>.view_html<br /> <a href="../../classes/BivouacHelpers.html" title="Module: BivouacHelpers">BivouacHelpers</a>.view_html<br /> -<a href="../../classes/BivouacHelpers/TooltipView.html" title="Module: BivouacHelpers::TooltipView">BivouacHelpers::TooltipView</a>.view_html<br /> +<a href="../../classes/BivouacHelpers/SoundView.html" title="Module: BivouacHelpers::SoundView">BivouacHelpers::SoundView</a>.view_html<br /> <a href="../../classes/BivouacHelpers/ScriptAculoUsView.html" title="Module: BivouacHelpers::ScriptAculoUsView">BivouacHelpers::ScriptAculoUsView</a>.view_html<br /> <a href="../../classes/BivouacHelpers/BaseView.html" title="Module: BivouacHelpers::BaseView">BivouacHelpers::BaseView</a>.view_html<br /> <a href="../../classes/BivouacHelpers/JavaScriptView.html" title="Module: BivouacHelpers::JavaScriptView">BivouacHelpers::JavaScriptView</a>.view_html<br /> <a href="../../classes/BivouacHelpers/HtmlView.html" title="Module: BivouacHelpers::HtmlView">BivouacHelpers::HtmlView</a>.view_html<br /> <a href="../../classes/BivouacHelpers/FormView.html" title="Module: BivouacHelpers::FormView">BivouacHelpers::FormView</a>.view_html<br /> @@ -101,20 +101,20 @@ <h2 class="ruled">Methods</h2> <h4 class="ruled">Public Instance method: -<strong><a name="M000043">auto_complete_field( field_id, options = nil )</a></strong> <a href="#M000043"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: auto_complete_field" /></a></h4> +<strong><a name="M000045">auto_complete_field( field_id, options = nil )</a></strong> <a href="#M000045"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: auto_complete_field" /></a></h4> <p> Adds AJAX autocomplete functionality to the text input field with the DOM ID specified by <tt>field_id</tt>. </p> <div class="sourcecode"> - <p class="source-link">[ <a href="javascript:toggleSource('M000043_source')" id="l_M000043_source">show source</a> ]</p> - <div id="M000043_source" class="dyn-source"> + <p class="source-link">[ <a href="javascript:toggleSource('M000045_source')" id="l_M000045_source">show source</a> ]</p> + <div id="M000045_source" class="dyn-source"> <pre> <span class="ruby-comment cmt"># File lib/bivouac/helpers/view/goh/form.rb, line 6</span> 6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">auto_complete_field</span>( <span class="ruby-identifier">field_id</span>, <span class="ruby-identifier">options</span> = <span class="ruby-keyword kw">nil</span> ) 7: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">has_key?</span>( <span class="ruby-identifier">:indicator</span> ) 8: <span class="ruby-identifier">data</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:indicator</span>] @@ -129,11 +129,11 @@ 17: <span class="ruby-keyword kw">end</span> </pre> </div> </div> <h4 class="ruled">Public Instance method: -<strong><a name="M000045">button_to_function(name, *args, &amp;block)</a></strong> <a href="#M000045"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: button_to_function" /></a></h4> +<strong><a name="M000047">button_to_function(name, *args, &amp;block)</a></strong> <a href="#M000047"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: button_to_function" /></a></h4> <p> Returns a button that&#8216;ll trigger a JavaScript function using the onclick handler. </p> @@ -142,12 +142,12 @@ which evaluates to a string when the template is rendered (instead of making an Ajax request first). </p> <div class="sourcecode"> - <p class="source-link">[ <a href="javascript:toggleSource('M000045_source')" id="l_M000045_source">show source</a> ]</p> - <div id="M000045_source" class="dyn-source"> + <p class="source-link">[ <a href="javascript:toggleSource('M000047_source')" id="l_M000047_source">show source</a> ]</p> + <div id="M000047_source" class="dyn-source"> <pre> <span class="ruby-comment cmt"># File lib/bivouac/helpers/view/goh/form.rb, line 63</span> 63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">button_to_function</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 64: <span class="ruby-identifier">html_options</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span> <span class="ruby-operator">:</span> {} 65: <span class="ruby-identifier">function</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">''</span> @@ -161,11 +161,11 @@ 73: <span class="ruby-keyword kw">end</span> </pre> </div> </div> <h4 class="ruled">Public Instance method: -<strong><a name="M000048">form_remote_tag(options = {}, &amp;block)</a></strong> <a href="#M000048"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: form_remote_tag" /></a></h4> +<strong><a name="M000050">form_remote_tag(options = {}, &amp;block)</a></strong> <a href="#M000050"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: form_remote_tag" /></a></h4> <p> Returns a form tag that will submit using XMLHttpRequest in the background instead of the regular reloading POST arrangement. Even though it&#8216;s using JavaScript to serialize the form elements, the form submission will @@ -183,29 +183,29 @@ <pre> form_remote_tag :html =&gt; { :url =&gt; R(SomePlace) } </pre> <p> The Hash passed to the :html key is equivalent to the options (2nd) -argument in the <a href="FormView.html#M000047">form_tag</a> method. +argument in the <a href="FormView.html#M000049">form_tag</a> method. </p> <p> By default the fall-through action is the same as the one specified in the :url (and the default method is :post). </p> <p> -<a href="FormView.html#M000048">form_remote_tag</a> takes a block, like <a -href="FormView.html#M000047">form_tag</a>: +<a href="FormView.html#M000050">form_remote_tag</a> takes a block, like <a +href="FormView.html#M000049">form_tag</a>: </p> <pre> form_remote_tag :url =&gt; '/posts' do div do; input( :type =&gt; 'submit', :name =&gt; 'submit' :value =&gt; 'Save' ); end end </pre> <div class="sourcecode"> - <p class="source-link">[ <a href="javascript:toggleSource('M000048_source')" id="l_M000048_source">show source</a> ]</p> - <div id="M000048_source" class="dyn-source"> + <p class="source-link">[ <a href="javascript:toggleSource('M000050_source')" id="l_M000050_source">show source</a> ]</p> + <div id="M000050_source" class="dyn-source"> <pre> <span class="ruby-comment cmt"># File lib/bivouac/helpers/view/goh/form.rb, line 159</span> 159: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">form_remote_tag</span>(<span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 160: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:form</span>] = <span class="ruby-keyword kw">true</span> 161: @@ -218,25 +218,25 @@ 168: <span class="ruby-keyword kw">end</span> </pre> </div> </div> <h4 class="ruled">Public Instance method: -<strong><a name="M000047">form_tag(url, options = {}) {|| ...}</a></strong> <a href="#M000047"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: form_tag" /></a></h4> +<strong><a name="M000049">form_tag(url, options = {}) {|| ...}</a></strong> <a href="#M000049"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: form_tag" /></a></h4> <p> Starts a form tag that points the action to an url. The method for the form defaults to POST. </p> <p> Examples: </p> <ul> -<li><tt><a href="FormView.html#M000047">form_tag</a>(&#8217;/posts&#8217;) +<li><tt><a href="FormView.html#M000049">form_tag</a>(&#8217;/posts&#8217;) =&gt; &lt;form action=&quot;/posts&quot; method=&quot;post&quot;&gt;</tt> </li> -<li><tt><a href="FormView.html#M000047">form_tag</a>(&#8217;/upload&#8217;, +<li><tt><a href="FormView.html#M000049">form_tag</a>(&#8217;/upload&#8217;, :multipart =&gt; true) =&gt; &lt;form action=&quot;/upload&quot; method=&quot;post&quot; enctype=&quot;multipart/form-data&quot;&gt;</tt> </li> </ul> @@ -271,12 +271,12 @@ </pre> </li> </ul> <div class="sourcecode"> - <p class="source-link">[ <a href="javascript:toggleSource('M000047_source')" id="l_M000047_source">show source</a> ]</p> - <div id="M000047_source" class="dyn-source"> + <p class="source-link">[ <a href="javascript:toggleSource('M000049_source')" id="l_M000049_source">show source</a> ]</p> + <div id="M000049_source" class="dyn-source"> <pre> <span class="ruby-comment cmt"># File lib/bivouac/helpers/view/goh/form.rb, line 109</span> 109: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">form_tag</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 110: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:enctype</span>] = <span class="ruby-value str">&quot;multipart/form-data&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">:multipart</span>) 111: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:action</span>] = <span class="ruby-identifier">url</span> @@ -304,22 +304,22 @@ 133: <span class="ruby-keyword kw">end</span> </pre> </div> </div> <h4 class="ruled">Public Instance method: -<strong><a name="M000046">submit_to_remote(name, value, options = {})</a></strong> <a href="#M000046"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: submit_to_remote" /></a></h4> +<strong><a name="M000048">submit_to_remote(name, value, options = {})</a></strong> <a href="#M000048"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: submit_to_remote" /></a></h4> <p> Returns a button input tag that will submit form using XMLHttpRequest in the background instead of regular reloading POST arrangement. <tt>options</tt> argument is the same as in <tt><a -href="FormView.html#M000048">form_remote_tag</a></tt>. +href="FormView.html#M000050">form_remote_tag</a></tt>. </p> <div class="sourcecode"> - <p class="source-link">[ <a href="javascript:toggleSource('M000046_source')" id="l_M000046_source">show source</a> ]</p> - <div id="M000046_source" class="dyn-source"> + <p class="source-link">[ <a href="javascript:toggleSource('M000048_source')" id="l_M000048_source">show source</a> ]</p> + <div id="M000048_source" class="dyn-source"> <pre> <span class="ruby-comment cmt"># File lib/bivouac/helpers/view/goh/form.rb, line 78</span> 78: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">submit_to_remote</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span> = {}) 79: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:with</span>] <span class="ruby-operator">||=</span> <span class="ruby-value str">'Form.serialize(this.form)'</span> 80: @@ -333,11 +333,11 @@ 88: <span class="ruby-keyword kw">end</span> </pre> </div> </div> <h4 class="ruled">Public Instance method: -<strong><a name="M000044">text_field(field_name, value = &quot;&quot;, options = {})</a></strong> <a href="#M000044"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: text_field" /></a></h4> +<strong><a name="M000046">text_field(field_name, value = &quot;&quot;, options = {})</a></strong> <a href="#M000046"><img src="../../permalink.gif" border="0" title="Permalink to Public Instance method: text_field" /></a></h4> <p> Autocomplete options : </p> <p> @@ -353,11 +353,11 @@ them here, in the usual {field: &#8216;value&#8217;,another: &#8216;value&#8217;} or &#8216;field=value&amp;another=value&#8217; manner. </p> <div class="sourcecode"> - <p class="source-link">[ <a href="javascript:toggleSource('M000044_source')" id="l_M000044_source">show source</a> ]</p> - <div id="M000044_source" class="dyn-source"> + <p class="source-link">[ <a href="javascript:toggleSource('M000046_source')" id="l_M000046_source">show source</a> ]</p> + <div id="M000046_source" class="dyn-source"> <pre> <span class="ruby-comment cmt"># File lib/bivouac/helpers/view/goh/form.rb, line 30</span> 30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">text_field</span>(<span class="ruby-identifier">field_name</span>, <span class="ruby-identifier">value</span> = <span class="ruby-value str">&quot;&quot;</span>, <span class="ruby-identifier">options</span> = {}) 31: <span class="ruby-identifier">autocomplete_options</span> = <span class="ruby-keyword kw">nil</span> 32: \ No newline at end of file