File: C:/Ruby27-x64/share/doc/ruby/html/CGI/HtmlExtension.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module CGI::HtmlExtension - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-i-a">#a</a>
<li class="calls-super" ><a href="#method-i-base">#base</a>
<li class="calls-super" ><a href="#method-i-blockquote">#blockquote</a>
<li class="calls-super" ><a href="#method-i-caption">#caption</a>
<li ><a href="#method-i-checkbox">#checkbox</a>
<li ><a href="#method-i-checkbox_group">#checkbox_group</a>
<li ><a href="#method-i-file_field">#file_field</a>
<li class="calls-super" ><a href="#method-i-form">#form</a>
<li ><a href="#method-i-hidden">#hidden</a>
<li class="calls-super" ><a href="#method-i-html">#html</a>
<li ><a href="#method-i-image_button">#image_button</a>
<li class="calls-super" ><a href="#method-i-img">#img</a>
<li ><a href="#method-i-multipart_form">#multipart_form</a>
<li ><a href="#method-i-password_field">#password_field</a>
<li ><a href="#method-i-popup_menu">#popup_menu</a>
<li ><a href="#method-i-radio_button">#radio_button</a>
<li ><a href="#method-i-radio_group">#radio_group</a>
<li ><a href="#method-i-reset">#reset</a>
<li ><a href="#method-i-scrolling_list">#scrolling_list</a>
<li ><a href="#method-i-submit">#submit</a>
<li ><a href="#method-i-text_field">#text_field</a>
<li class="calls-super" ><a href="#method-i-textarea">#textarea</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-CGI::HtmlExtension">
<h1 id="module-CGI::HtmlExtension" class="module">
module CGI::HtmlExtension
</h1>
<section class="description">
<p>Mixin module providing HTML generation methods.</p>
<p>For example,</p>
<pre class="ruby"><span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">a</span>(<span class="ruby-string">"http://www.example.com"</span>) { <span class="ruby-string">"Example"</span> }
<span class="ruby-comment"># => "<A HREF=\"http://www.example.com\">Example</A>"</span>
</pre>
<p>Modules Html3, Html4, etc., contain more basic HTML-generation methods (<code>#title</code>, <code>#h1</code>, etc.).</p>
<p>See class <a href="../CGI.html"><code>CGI</code></a> for a detailed example.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-a" class="method-detail ">
<div class="method-heading">
<span class="method-name">a</span><span
class="method-args">(href = "") { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate an Anchor element as a string.</p>
<p><code>href</code> can either be a string, giving the URL for the HREF attribute, or it can be a hash of the element's attributes.</p>
<p>The body of the element is the string returned by the no-argument block passed in.</p>
<pre class="ruby"><span class="ruby-identifier">a</span>(<span class="ruby-string">"http://www.example.com"</span>) { <span class="ruby-string">"Example"</span> }
<span class="ruby-comment"># => "<A HREF=\"http://www.example.com\">Example</A>"</span>
<span class="ruby-identifier">a</span>(<span class="ruby-string">"HREF"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"http://www.example.com"</span>, <span class="ruby-string">"TARGET"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"_top"</span>) { <span class="ruby-string">"Example"</span> }
<span class="ruby-comment"># => "<A HREF=\"http://www.example.com\" TARGET=\"_top\">Example</A>"</span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="a-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">a</span>(<span class="ruby-identifier">href</span> = <span class="ruby-string">""</span>) <span class="ruby-comment"># :yield:</span>
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">href</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"HREF"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">href</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">href</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-base" class="method-detail ">
<div class="method-heading">
<span class="method-name">base</span><span
class="method-args">(href = "") { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a Document Base <a href="../URI.html"><code>URI</code></a> element as a <a href="../String.html"><code>String</code></a>.</p>
<p><code>href</code> can either by a string, giving the base URL for the HREF attribute, or it can be a has of the element's attributes.</p>
<p>The passed-in no-argument block is ignored.</p>
<pre class="ruby"><span class="ruby-identifier">base</span>(<span class="ruby-string">"http://www.example.com/cgi"</span>)
<span class="ruby-comment"># => "<BASE HREF=\"http://www.example.com/cgi\">"</span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="base-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 115</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">base</span>(<span class="ruby-identifier">href</span> = <span class="ruby-string">""</span>) <span class="ruby-comment"># :yield:</span>
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">href</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"HREF"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">href</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">href</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-blockquote" class="method-detail ">
<div class="method-heading">
<span class="method-name">blockquote</span><span
class="method-args">(cite = {}) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a BlockQuote element as a string.</p>
<p><code>cite</code> can either be a string, give the <a href="../URI.html"><code>URI</code></a> for the source of the quoted text, or a hash, giving all attributes of the element, or it can be omitted, in which case the element has no attributes.</p>
<p>The body is provided by the passed-in no-argument block</p>
<pre class="ruby"><span class="ruby-identifier">blockquote</span>(<span class="ruby-string">"http://www.example.com/quotes/foo.html"</span>) { <span class="ruby-string">"Foo!"</span> }
<span class="ruby-comment">#=> "<BLOCKQUOTE CITE=\"http://www.example.com/quotes/foo.html\">Foo!</BLOCKQUOTE></span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="blockquote-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 134</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">blockquote</span>(<span class="ruby-identifier">cite</span> = {}) <span class="ruby-comment"># :yield:</span>
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">cite</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"CITE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cite</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">cite</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-caption" class="method-detail ">
<div class="method-heading">
<span class="method-name">caption</span><span
class="method-args">(align = {}) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a Table Caption element as a string.</p>
<p><code>align</code> can be a string, giving the alignment of the caption (one of top, bottom, left, or right). It can be a hash of all the attributes of the element. Or it can be omitted.</p>
<p>The body of the element is provided by the passed-in no-argument block.</p>
<pre class="ruby"><span class="ruby-identifier">caption</span>(<span class="ruby-string">"left"</span>) { <span class="ruby-string">"Capital Cities"</span> }
<span class="ruby-comment"># => <CAPTION ALIGN=\"left\">Capital Cities</CAPTION></span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="caption-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 154</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">caption</span>(<span class="ruby-identifier">align</span> = {}) <span class="ruby-comment"># :yield:</span>
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">align</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"ALIGN"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">align</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">align</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-checkbox" class="method-detail ">
<div class="method-heading">
<span class="method-name">checkbox</span><span
class="method-args">(name = "", value = nil, checked = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a Checkbox Input element as a string.</p>
<p>The attributes of the element can be specified as three arguments, <code>name</code>, <code>value</code>, and <code>checked</code>. <code>checked</code> is a boolean value; if true, the CHECKED attribute will be included in the element.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">checkbox</span>(<span class="ruby-string">"name"</span>)
<span class="ruby-comment"># = checkbox("NAME" => "name")</span>
<span class="ruby-identifier">checkbox</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>)
<span class="ruby-comment"># = checkbox("NAME" => "name", "VALUE" => "value")</span>
<span class="ruby-identifier">checkbox</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-comment"># = checkbox("NAME" => "name", "VALUE" => "value", "CHECKED" => true)</span>
</pre>
<div class="method-source-code" id="checkbox-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 180</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">checkbox</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">value</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">checked</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"checkbox"</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>,
<span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>, <span class="ruby-string">"CHECKED"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">checked</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">name</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"checkbox"</span>
<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-checkbox_group" class="method-detail ">
<div class="method-heading">
<span class="method-name">checkbox_group</span><span
class="method-args">(name = "", *values)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a sequence of checkbox elements, as a <a href="../String.html"><code>String</code></a>.</p>
<p>The checkboxes will all have the same <code>name</code> attribute. Each checkbox is followed by a label. There will be one checkbox for each value. Each value can be specified as a <a href="../String.html"><code>String</code></a>, which will be used both as the value of the VALUE attribute and as the label for that checkbox. A single-element array has the same effect.</p>
<p>Each value can also be specified as a three-element array. The first element is the VALUE attribute; the second is the label; and the third is a boolean specifying whether this checkbox is CHECKED.</p>
<p>Each value can also be specified as a two-element array, by omitting either the value element (defaults to the same as the label), or the boolean checked element (defaults to false).</p>
<pre class="ruby"><span class="ruby-identifier">checkbox_group</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"foo"</span>, <span class="ruby-string">"bar"</span>, <span class="ruby-string">"baz"</span>)
<span class="ruby-comment"># <INPUT TYPE="checkbox" NAME="name" VALUE="foo">foo</span>
<span class="ruby-comment"># <INPUT TYPE="checkbox" NAME="name" VALUE="bar">bar</span>
<span class="ruby-comment"># <INPUT TYPE="checkbox" NAME="name" VALUE="baz">baz</span>
<span class="ruby-identifier">checkbox_group</span>(<span class="ruby-string">"name"</span>, [<span class="ruby-string">"foo"</span>], [<span class="ruby-string">"bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"baz"</span>)
<span class="ruby-comment"># <INPUT TYPE="checkbox" NAME="name" VALUE="foo">foo</span>
<span class="ruby-comment"># <INPUT TYPE="checkbox" CHECKED NAME="name" VALUE="bar">bar</span>
<span class="ruby-comment"># <INPUT TYPE="checkbox" NAME="name" VALUE="baz">baz</span>
<span class="ruby-identifier">checkbox_group</span>(<span class="ruby-string">"name"</span>, [<span class="ruby-string">"1"</span>, <span class="ruby-string">"Foo"</span>], [<span class="ruby-string">"2"</span>, <span class="ruby-string">"Bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"Baz"</span>)
<span class="ruby-comment"># <INPUT TYPE="checkbox" NAME="name" VALUE="1">Foo</span>
<span class="ruby-comment"># <INPUT TYPE="checkbox" CHECKED NAME="name" VALUE="2">Bar</span>
<span class="ruby-comment"># <INPUT TYPE="checkbox" NAME="name" VALUE="Baz">Baz</span>
<span class="ruby-identifier">checkbox_group</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>,
<span class="ruby-string">"VALUES"</span> <span class="ruby-operator">=></span> [<span class="ruby-string">"foo"</span>, <span class="ruby-string">"bar"</span>, <span class="ruby-string">"baz"</span>])
<span class="ruby-identifier">checkbox_group</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>,
<span class="ruby-string">"VALUES"</span> <span class="ruby-operator">=></span> [[<span class="ruby-string">"foo"</span>], [<span class="ruby-string">"bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"baz"</span>])
<span class="ruby-identifier">checkbox_group</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>,
<span class="ruby-string">"VALUES"</span> <span class="ruby-operator">=></span> [[<span class="ruby-string">"1"</span>, <span class="ruby-string">"Foo"</span>], [<span class="ruby-string">"2"</span>, <span class="ruby-string">"Bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"Baz"</span>])
</pre>
<div class="method-source-code" id="checkbox_group-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 234</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">checkbox_group</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">values</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-identifier">values</span> = <span class="ruby-identifier">name</span>[<span class="ruby-string">"VALUES"</span>]
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>[<span class="ruby-string">"NAME"</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">values</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">checkbox</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">value</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">checkbox</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>], <span class="ruby-identifier">value</span>[<span class="ruby-value">-1</span>]) <span class="ruby-operator">+</span>
<span class="ruby-identifier">value</span>[<span class="ruby-value">-2</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">checkbox</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>]) <span class="ruby-operator">+</span>
<span class="ruby-identifier">value</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
}.<span class="ruby-identifier">join</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-file_field" class="method-detail ">
<div class="method-heading">
<span class="method-name">file_field</span><span
class="method-args">(name = "", size = 20, maxlength = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate an <a href="../File.html"><code>File</code></a> Upload Input element as a string.</p>
<p>The attributes of the element can be specified as three arguments, <code>name</code>, <code>size</code>, and <code>maxlength</code>. <code>maxlength</code> is the maximum length of the file's <em>name</em>, not of the file's <em>contents</em>.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<p>See <a href="HtmlExtension.html#method-i-multipart_form"><code>multipart_form()</code></a> for forms that include file uploads.</p>
<pre class="ruby"><span class="ruby-identifier">file_field</span>(<span class="ruby-string">"name"</span>)
<span class="ruby-comment"># <INPUT TYPE="file" NAME="name" SIZE="20"></span>
<span class="ruby-identifier">file_field</span>(<span class="ruby-string">"name"</span>, <span class="ruby-value">40</span>)
<span class="ruby-comment"># <INPUT TYPE="file" NAME="name" SIZE="40"></span>
<span class="ruby-identifier">file_field</span>(<span class="ruby-string">"name"</span>, <span class="ruby-value">40</span>, <span class="ruby-value">100</span>)
<span class="ruby-comment"># <INPUT TYPE="file" NAME="name" SIZE="40" MAXLENGTH="100"></span>
<span class="ruby-identifier">file_field</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>, <span class="ruby-string">"SIZE"</span> <span class="ruby-operator">=></span> <span class="ruby-value">40</span>)
<span class="ruby-comment"># <INPUT TYPE="file" NAME="name" SIZE="40"></span>
</pre>
<div class="method-source-code" id="file_field-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 276</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">file_field</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">size</span> = <span class="ruby-value">20</span>, <span class="ruby-identifier">maxlength</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"file"</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>,
<span class="ruby-string">"SIZE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">size</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">name</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"file"</span>
<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">attributes</span>[<span class="ruby-string">"MAXLENGTH"</span>] = <span class="ruby-identifier">maxlength</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">maxlength</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-form" class="method-detail ">
<div class="method-heading">
<span class="method-name">form</span><span
class="method-args">(method = "post", action = script_name, enctype = "application/x-www-form-urlencoded") { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a Form element as a string.</p>
<p><code>method</code> should be either “get” or “post”, and defaults to the latter. <code>action</code> defaults to the current <a href="../CGI.html"><code>CGI</code></a> script name. <code>enctype</code> defaults to “application/x-www-form-urlencoded”.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<p>See also <a href="HtmlExtension.html#method-i-multipart_form"><code>multipart_form()</code></a> for forms that include file uploads.</p>
<pre class="ruby"><span class="ruby-identifier">form</span>{ <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <FORM METHOD="post" ENCTYPE="application/x-www-form-urlencoded">string</FORM></span>
<span class="ruby-identifier">form</span>(<span class="ruby-string">"get"</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <FORM METHOD="get" ENCTYPE="application/x-www-form-urlencoded">string</FORM></span>
<span class="ruby-identifier">form</span>(<span class="ruby-string">"get"</span>, <span class="ruby-string">"url"</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <FORM METHOD="get" ACTION="url" ENCTYPE="application/x-www-form-urlencoded">string</FORM></span>
<span class="ruby-identifier">form</span>(<span class="ruby-string">"METHOD"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"post"</span>, <span class="ruby-string">"ENCTYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"enctype"</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <FORM METHOD="post" ENCTYPE="enctype">string</FORM></span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="form-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 310</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">form</span>(<span class="ruby-identifier">method</span> = <span class="ruby-string">"post"</span>, <span class="ruby-identifier">action</span> = <span class="ruby-identifier">script_name</span>, <span class="ruby-identifier">enctype</span> = <span class="ruby-string">"application/x-www-form-urlencoded"</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"METHOD"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">method</span>, <span class="ruby-string">"ACTION"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">action</span>,
<span class="ruby-string">"ENCTYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">enctype</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">"METHOD"</span>)
<span class="ruby-identifier">method</span>[<span class="ruby-string">"METHOD"</span>] = <span class="ruby-string">"post"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">"ENCTYPE"</span>)
<span class="ruby-identifier">method</span>[<span class="ruby-string">"ENCTYPE"</span>] = <span class="ruby-identifier">enctype</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">method</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">body</span> = <span class="ruby-keyword">yield</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">body</span> = <span class="ruby-string">""</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@output_hidden</span>
<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@output_hidden</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-node">"<INPUT TYPE=\"HIDDEN\" NAME=\"#{k}\" VALUE=\"#{v}\">"</span>
}.<span class="ruby-identifier">join</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">attributes</span>){<span class="ruby-identifier">body</span>}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-hidden" class="method-detail ">
<div class="method-heading">
<span class="method-name">hidden</span><span
class="method-args">(name = "", value = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a Hidden Input element as a string.</p>
<p>The attributes of the element can be specified as two arguments, <code>name</code> and <code>value</code>.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">hidden</span>(<span class="ruby-string">"name"</span>)
<span class="ruby-comment"># <INPUT TYPE="hidden" NAME="name"></span>
<span class="ruby-identifier">hidden</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>)
<span class="ruby-comment"># <INPUT TYPE="hidden" NAME="name" VALUE="value"></span>
<span class="ruby-identifier">hidden</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>, <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"reset"</span>, <span class="ruby-string">"ID"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"foo"</span>)
<span class="ruby-comment"># <INPUT TYPE="hidden" NAME="name" VALUE="value" ID="foo"></span>
</pre>
<div class="method-source-code" id="hidden-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 351</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hidden</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">value</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"hidden"</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>, <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">name</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"hidden"</span>
<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-html" class="method-detail ">
<div class="method-heading">
<span class="method-name">html</span><span
class="method-args">(attributes = {}) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a top-level HTML element as a string.</p>
<p>The attributes of the element are specified as a hash. The pseudo-attribute “PRETTY” can be used to specify that the generated HTML string should be indented. “PRETTY” can also be specified as a string as the sole argument to this method. The pseudo-attribute “DOCTYPE”, if given, is used as the leading DOCTYPE SGML tag; it should include the entire text of this tag, including angle brackets.</p>
<p>The body of the html element is supplied as a block.</p>
<pre class="ruby"><span class="ruby-identifier">html</span>{ <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"><HTML>string</HTML></span>
<span class="ruby-identifier">html</span>(<span class="ruby-string">"LANG"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"ja"</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"><HTML LANG="ja">string</HTML></span>
<span class="ruby-identifier">html</span>(<span class="ruby-string">"DOCTYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <HTML>string</HTML></span>
<span class="ruby-identifier">html</span>(<span class="ruby-string">"DOCTYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">'<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">'</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"><HTML>string</HTML></span>
<span class="ruby-identifier">html</span>(<span class="ruby-string">"PRETTY"</span> <span class="ruby-operator">=></span> <span class="ruby-string">" "</span>) { <span class="ruby-string">"<BODY></BODY>"</span> }
<span class="ruby-comment"># <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"></span>
<span class="ruby-comment"># <HTML></span>
<span class="ruby-comment"># <BODY></span>
<span class="ruby-comment"># </BODY></span>
<span class="ruby-comment"># </HTML></span>
<span class="ruby-identifier">html</span>(<span class="ruby-string">"PRETTY"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"\t"</span>) { <span class="ruby-string">"<BODY></BODY>"</span> }
<span class="ruby-comment"># <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"></span>
<span class="ruby-comment"># <HTML></span>
<span class="ruby-comment"># <BODY></span>
<span class="ruby-comment"># </BODY></span>
<span class="ruby-comment"># </HTML></span>
<span class="ruby-identifier">html</span>(<span class="ruby-string">"PRETTY"</span>) { <span class="ruby-string">"<BODY></BODY>"</span> }
<span class="ruby-comment"># = html("PRETTY" => " ") { "<BODY></BODY>" }</span>
<span class="ruby-identifier">html</span>(<span class="ruby-keyword">if</span> <span class="ruby-identifier">$VERBOSE</span> <span class="ruby-keyword">then</span> <span class="ruby-string">"PRETTY"</span> <span class="ruby-keyword">end</span>) { <span class="ruby-string">"HTML string"</span> }
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="html-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 403</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">html</span>(<span class="ruby-identifier">attributes</span> = {}) <span class="ruby-comment"># :yield:</span>
<span class="ruby-keyword">if</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">attributes</span>
<span class="ruby-identifier">attributes</span> = {}
<span class="ruby-keyword">elsif</span> <span class="ruby-string">"PRETTY"</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">attributes</span>
<span class="ruby-identifier">attributes</span> = { <span class="ruby-string">"PRETTY"</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">pretty</span> = <span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"PRETTY"</span>)
<span class="ruby-identifier">pretty</span> = <span class="ruby-string">" "</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">pretty</span>
<span class="ruby-identifier">buf</span> = <span class="ruby-string">""</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">"DOCTYPE"</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">attributes</span>[<span class="ruby-string">"DOCTYPE"</span>]
<span class="ruby-identifier">buf</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"DOCTYPE"</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"DOCTYPE"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">buf</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">doctype</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">buf</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">super</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">pretty</span>
<span class="ruby-constant">CGI</span>.<span class="ruby-identifier">pretty</span>(<span class="ruby-identifier">buf</span>, <span class="ruby-identifier">pretty</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">buf</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-image_button" class="method-detail ">
<div class="method-heading">
<span class="method-name">image_button</span><span
class="method-args">(src = "", name = nil, alt = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate an Image Button Input element as a string.</p>
<p><code>src</code> is the URL of the image to use for the button. <code>name</code> is the input name. <code>alt</code> is the alternative text for the image.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">image_button</span>(<span class="ruby-string">"url"</span>)
<span class="ruby-comment"># <INPUT TYPE="image" SRC="url"></span>
<span class="ruby-identifier">image_button</span>(<span class="ruby-string">"url"</span>, <span class="ruby-string">"name"</span>, <span class="ruby-string">"string"</span>)
<span class="ruby-comment"># <INPUT TYPE="image" SRC="url" NAME="name" ALT="string"></span>
<span class="ruby-identifier">image_button</span>(<span class="ruby-string">"SRC"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"url"</span>, <span class="ruby-string">"ALT"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"string"</span>)
<span class="ruby-comment"># <INPUT TYPE="image" SRC="url" ALT="string"></span>
</pre>
<div class="method-source-code" id="image_button-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 448</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">image_button</span>(<span class="ruby-identifier">src</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">name</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">alt</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">src</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"image"</span>, <span class="ruby-string">"SRC"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">src</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>,
<span class="ruby-string">"ALT"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">alt</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">src</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"image"</span>
<span class="ruby-identifier">src</span>[<span class="ruby-string">"SRC"</span>] <span class="ruby-operator">||=</span> <span class="ruby-string">""</span>
<span class="ruby-identifier">src</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-img" class="method-detail ">
<div class="method-heading">
<span class="method-name">img</span><span
class="method-args">(src = "", alt = "", width = nil, height = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate an Image element as a string.</p>
<p><code>src</code> is the URL of the image. <code>alt</code> is the alternative text for the image. <code>width</code> is the width of the image, and <code>height</code> is its height.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">img</span>(<span class="ruby-string">"src"</span>, <span class="ruby-string">"alt"</span>, <span class="ruby-value">100</span>, <span class="ruby-value">50</span>)
<span class="ruby-comment"># <IMG SRC="src" ALT="alt" WIDTH="100" HEIGHT="50"></span>
<span class="ruby-identifier">img</span>(<span class="ruby-string">"SRC"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"src"</span>, <span class="ruby-string">"ALT"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"alt"</span>, <span class="ruby-string">"WIDTH"</span> <span class="ruby-operator">=></span> <span class="ruby-value">100</span>, <span class="ruby-string">"HEIGHT"</span> <span class="ruby-operator">=></span> <span class="ruby-value">50</span>)
<span class="ruby-comment"># <IMG SRC="src" ALT="alt" WIDTH="100" HEIGHT="50"></span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="img-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 474</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">img</span>(<span class="ruby-identifier">src</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">alt</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">width</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">height</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">src</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"SRC"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">src</span>, <span class="ruby-string">"ALT"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">alt</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">src</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">attributes</span>[<span class="ruby-string">"WIDTH"</span>] = <span class="ruby-identifier">width</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">width</span>
<span class="ruby-identifier">attributes</span>[<span class="ruby-string">"HEIGHT"</span>] = <span class="ruby-identifier">height</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">height</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-multipart_form" class="method-detail ">
<div class="method-heading">
<span class="method-name">multipart_form</span><span
class="method-args">(action = nil, enctype = "multipart/form-data") { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a Form element with multipart encoding as a <a href="../String.html"><code>String</code></a>.</p>
<p>Multipart encoding is used for forms that include file uploads.</p>
<p><code>action</code> is the action to perform. <code>enctype</code> is the encoding type, which defaults to “multipart/form-data”.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">multipart_form</span>{ <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <FORM METHOD="post" ENCTYPE="multipart/form-data">string</FORM></span>
<span class="ruby-identifier">multipart_form</span>(<span class="ruby-string">"url"</span>) { <span class="ruby-string">"string"</span> }
<span class="ruby-comment"># <FORM METHOD="post" ACTION="url" ENCTYPE="multipart/form-data">string</FORM></span>
</pre>
<div class="method-source-code" id="multipart_form-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 500</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">multipart_form</span>(<span class="ruby-identifier">action</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">enctype</span> = <span class="ruby-string">"multipart/form-data"</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
{ <span class="ruby-string">"METHOD"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"post"</span>, <span class="ruby-string">"ENCTYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">enctype</span> }
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">action</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"METHOD"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"post"</span>, <span class="ruby-string">"ACTION"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">action</span>,
<span class="ruby-string">"ENCTYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">enctype</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">action</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">"METHOD"</span>)
<span class="ruby-identifier">action</span>[<span class="ruby-string">"METHOD"</span>] = <span class="ruby-string">"post"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">action</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">"ENCTYPE"</span>)
<span class="ruby-identifier">action</span>[<span class="ruby-string">"ENCTYPE"</span>] = <span class="ruby-identifier">enctype</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">action</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">form</span>(<span class="ruby-identifier">attributes</span>){ <span class="ruby-keyword">yield</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">form</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-password_field" class="method-detail ">
<div class="method-heading">
<span class="method-name">password_field</span><span
class="method-args">(name = "", value = nil, size = 40, maxlength = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a Password Input element as a string.</p>
<p><code>name</code> is the name of the input field. <code>value</code> is its default value. <code>size</code> is the size of the input field display. <code>maxlength</code> is the maximum length of the inputted password.</p>
<p>Alternatively, attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">password_field</span>(<span class="ruby-string">"name"</span>)
<span class="ruby-comment"># <INPUT TYPE="password" NAME="name" SIZE="40"></span>
<span class="ruby-identifier">password_field</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>)
<span class="ruby-comment"># <INPUT TYPE="password" NAME="name" VALUE="value" SIZE="40"></span>
<span class="ruby-identifier">password_field</span>(<span class="ruby-string">"password"</span>, <span class="ruby-string">"value"</span>, <span class="ruby-value">80</span>, <span class="ruby-value">200</span>)
<span class="ruby-comment"># <INPUT TYPE="password" NAME="name" VALUE="value" SIZE="80" MAXLENGTH="200"></span>
<span class="ruby-identifier">password_field</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>, <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"value"</span>)
<span class="ruby-comment"># <INPUT TYPE="password" NAME="name" VALUE="value"></span>
</pre>
<div class="method-source-code" id="password_field-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 542</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password_field</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">value</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">size</span> = <span class="ruby-value">40</span>, <span class="ruby-identifier">maxlength</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"password"</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>,
<span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>, <span class="ruby-string">"SIZE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">size</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">name</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"password"</span>
<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">attributes</span>[<span class="ruby-string">"MAXLENGTH"</span>] = <span class="ruby-identifier">maxlength</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">maxlength</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-popup_menu" class="method-detail ">
<div class="method-heading">
<span class="method-name">popup_menu</span><span
class="method-args">(name = "", *values)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a Select element as a string.</p>
<p><code>name</code> is the name of the element. The <code>values</code> are the options that can be selected from the Select menu. Each value can be a <a href="../String.html"><code>String</code></a> or a one, two, or three-element <a href="../Array.html"><code>Array</code></a>. If a <a href="../String.html"><code>String</code></a> or a one-element <a href="../Array.html"><code>Array</code></a>, this is both the value of that option and the text displayed for it. If a three-element <a href="../Array.html"><code>Array</code></a>, the elements are the option value, displayed text, and a boolean value specifying whether this option starts as selected. The two-element version omits either the option value (defaults to the same as the display text) or the boolean selected specifier (defaults to false).</p>
<p>The attributes and options can also be specified as a hash. In this case, options are specified as an array of values as described above, with the hash key of “VALUES”.</p>
<pre class="ruby"><span class="ruby-identifier">popup_menu</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"foo"</span>, <span class="ruby-string">"bar"</span>, <span class="ruby-string">"baz"</span>)
<span class="ruby-comment"># <SELECT NAME="name"></span>
<span class="ruby-comment"># <OPTION VALUE="foo">foo</OPTION></span>
<span class="ruby-comment"># <OPTION VALUE="bar">bar</OPTION></span>
<span class="ruby-comment"># <OPTION VALUE="baz">baz</OPTION></span>
<span class="ruby-comment"># </SELECT></span>
<span class="ruby-identifier">popup_menu</span>(<span class="ruby-string">"name"</span>, [<span class="ruby-string">"foo"</span>], [<span class="ruby-string">"bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"baz"</span>)
<span class="ruby-comment"># <SELECT NAME="name"></span>
<span class="ruby-comment"># <OPTION VALUE="foo">foo</OPTION></span>
<span class="ruby-comment"># <OPTION VALUE="bar" SELECTED>bar</OPTION></span>
<span class="ruby-comment"># <OPTION VALUE="baz">baz</OPTION></span>
<span class="ruby-comment"># </SELECT></span>
<span class="ruby-identifier">popup_menu</span>(<span class="ruby-string">"name"</span>, [<span class="ruby-string">"1"</span>, <span class="ruby-string">"Foo"</span>], [<span class="ruby-string">"2"</span>, <span class="ruby-string">"Bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"Baz"</span>)
<span class="ruby-comment"># <SELECT NAME="name"></span>
<span class="ruby-comment"># <OPTION VALUE="1">Foo</OPTION></span>
<span class="ruby-comment"># <OPTION SELECTED VALUE="2">Bar</OPTION></span>
<span class="ruby-comment"># <OPTION VALUE="Baz">Baz</OPTION></span>
<span class="ruby-comment"># </SELECT></span>
<span class="ruby-identifier">popup_menu</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>, <span class="ruby-string">"SIZE"</span> <span class="ruby-operator">=></span> <span class="ruby-value">2</span>, <span class="ruby-string">"MULTIPLE"</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-string">"VALUES"</span> <span class="ruby-operator">=></span> [[<span class="ruby-string">"1"</span>, <span class="ruby-string">"Foo"</span>], [<span class="ruby-string">"2"</span>, <span class="ruby-string">"Bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"Baz"</span>])
<span class="ruby-comment"># <SELECT NAME="name" MULTIPLE SIZE="2"></span>
<span class="ruby-comment"># <OPTION VALUE="1">Foo</OPTION></span>
<span class="ruby-comment"># <OPTION SELECTED VALUE="2">Bar</OPTION></span>
<span class="ruby-comment"># <OPTION VALUE="Baz">Baz</OPTION></span>
<span class="ruby-comment"># </SELECT></span>
</pre>
<div class="method-source-code" id="popup_menu-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 597</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">popup_menu</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">values</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-identifier">values</span> = <span class="ruby-identifier">name</span>[<span class="ruby-string">"VALUES"</span>]
<span class="ruby-identifier">size</span> = <span class="ruby-identifier">name</span>[<span class="ruby-string">"SIZE"</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>[<span class="ruby-string">"SIZE"</span>]
<span class="ruby-identifier">multiple</span> = <span class="ruby-identifier">name</span>[<span class="ruby-string">"MULTIPLE"</span>]
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>[<span class="ruby-string">"NAME"</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">size</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">multiple</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">select</span>({ <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>, <span class="ruby-string">"SIZE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">size</span>,
<span class="ruby-string">"MULTIPLE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">multiple</span> }){
<span class="ruby-identifier">values</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">option</span>({ <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span> }){ <span class="ruby-identifier">value</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>[<span class="ruby-identifier">value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
<span class="ruby-identifier">option</span>({ <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>], <span class="ruby-string">"SELECTED"</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span> }){
<span class="ruby-identifier">value</span>[<span class="ruby-identifier">value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">2</span>]
}
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">option</span>({ <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>] }){
<span class="ruby-identifier">value</span>[<span class="ruby-identifier">value</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>]
}
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
}.<span class="ruby-identifier">join</span>
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="HtmlExtension.html#method-i-scrolling_list">scrolling_list</a>
</div>
</div>
<div id="method-i-radio_button" class="method-detail ">
<div class="method-heading">
<span class="method-name">radio_button</span><span
class="method-args">(name = "", value = nil, checked = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generates a radio-button Input element.</p>
<p><code>name</code> is the name of the input field. <code>value</code> is the value of the field if checked. <code>checked</code> specifies whether the field starts off checked.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">radio_button</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>)
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="value"></span>
<span class="ruby-identifier">radio_button</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="value" CHECKED></span>
<span class="ruby-identifier">radio_button</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>, <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"value"</span>, <span class="ruby-string">"ID"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"foo"</span>)
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="value" ID="foo"></span>
</pre>
<div class="method-source-code" id="radio_button-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 646</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">radio_button</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">value</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">checked</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"radio"</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>,
<span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>, <span class="ruby-string">"CHECKED"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">checked</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">name</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"radio"</span>
<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-radio_group" class="method-detail ">
<div class="method-heading">
<span class="method-name">radio_group</span><span
class="method-args">(name = "", *values)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a sequence of radio button Input elements, as a <a href="../String.html"><code>String</code></a>.</p>
<p>This works the same as <a href="HtmlExtension.html#method-i-checkbox_group"><code>checkbox_group()</code></a>. However, it is not valid to have more than one radiobutton in a group checked.</p>
<pre class="ruby"><span class="ruby-identifier">radio_group</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"foo"</span>, <span class="ruby-string">"bar"</span>, <span class="ruby-string">"baz"</span>)
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="foo">foo</span>
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="bar">bar</span>
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="baz">baz</span>
<span class="ruby-identifier">radio_group</span>(<span class="ruby-string">"name"</span>, [<span class="ruby-string">"foo"</span>], [<span class="ruby-string">"bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"baz"</span>)
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="foo">foo</span>
<span class="ruby-comment"># <INPUT TYPE="radio" CHECKED NAME="name" VALUE="bar">bar</span>
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="baz">baz</span>
<span class="ruby-identifier">radio_group</span>(<span class="ruby-string">"name"</span>, [<span class="ruby-string">"1"</span>, <span class="ruby-string">"Foo"</span>], [<span class="ruby-string">"2"</span>, <span class="ruby-string">"Bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"Baz"</span>)
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="1">Foo</span>
<span class="ruby-comment"># <INPUT TYPE="radio" CHECKED NAME="name" VALUE="2">Bar</span>
<span class="ruby-comment"># <INPUT TYPE="radio" NAME="name" VALUE="Baz">Baz</span>
<span class="ruby-identifier">radio_group</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>,
<span class="ruby-string">"VALUES"</span> <span class="ruby-operator">=></span> [<span class="ruby-string">"foo"</span>, <span class="ruby-string">"bar"</span>, <span class="ruby-string">"baz"</span>])
<span class="ruby-identifier">radio_group</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>,
<span class="ruby-string">"VALUES"</span> <span class="ruby-operator">=></span> [[<span class="ruby-string">"foo"</span>], [<span class="ruby-string">"bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"baz"</span>])
<span class="ruby-identifier">radio_group</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>,
<span class="ruby-string">"VALUES"</span> <span class="ruby-operator">=></span> [[<span class="ruby-string">"1"</span>, <span class="ruby-string">"Foo"</span>], [<span class="ruby-string">"2"</span>, <span class="ruby-string">"Bar"</span>, <span class="ruby-keyword">true</span>], <span class="ruby-string">"Baz"</span>])
</pre>
<div class="method-source-code" id="radio_group-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 685</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">radio_group</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">values</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-identifier">values</span> = <span class="ruby-identifier">name</span>[<span class="ruby-string">"VALUES"</span>]
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>[<span class="ruby-string">"NAME"</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">values</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">radio_button</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">value</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">radio_button</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>], <span class="ruby-identifier">value</span>[<span class="ruby-value">-1</span>]) <span class="ruby-operator">+</span>
<span class="ruby-identifier">value</span>[<span class="ruby-value">-2</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">radio_button</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>]) <span class="ruby-operator">+</span>
<span class="ruby-identifier">value</span>[<span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
}.<span class="ruby-identifier">join</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reset" class="method-detail ">
<div class="method-heading">
<span class="method-name">reset</span><span
class="method-args">(value = nil, name = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a reset button Input element, as a <a href="../String.html"><code>String</code></a>.</p>
<p>This resets the values on a form to their initial values. <code>value</code> is the text displayed on the button. <code>name</code> is the name of this button.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">reset</span>
<span class="ruby-comment"># <INPUT TYPE="reset"></span>
<span class="ruby-identifier">reset</span>(<span class="ruby-string">"reset"</span>)
<span class="ruby-comment"># <INPUT TYPE="reset" VALUE="reset"></span>
<span class="ruby-identifier">reset</span>(<span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"reset"</span>, <span class="ruby-string">"ID"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"foo"</span>)
<span class="ruby-comment"># <INPUT TYPE="reset" VALUE="reset" ID="foo"></span>
</pre>
<div class="method-source-code" id="reset-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 720</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>(<span class="ruby-identifier">value</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">name</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> (<span class="ruby-keyword">not</span> <span class="ruby-identifier">value</span>) <span class="ruby-keyword">or</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"reset"</span>, <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">value</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"reset"</span>
<span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scrolling_list" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">scrolling_list</span><span
class="method-args">(name = "", *values)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="HtmlExtension.html#method-i-popup_menu">popup_menu</a>
</div>
</div>
<div id="method-i-submit" class="method-detail ">
<div class="method-heading">
<span class="method-name">submit</span><span
class="method-args">(value = nil, name = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a submit button Input element, as a <a href="../String.html"><code>String</code></a>.</p>
<p><code>value</code> is the text to display on the button. <code>name</code> is the name of the input.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">submit</span>
<span class="ruby-comment"># <INPUT TYPE="submit"></span>
<span class="ruby-identifier">submit</span>(<span class="ruby-string">"ok"</span>)
<span class="ruby-comment"># <INPUT TYPE="submit" VALUE="ok"></span>
<span class="ruby-identifier">submit</span>(<span class="ruby-string">"ok"</span>, <span class="ruby-string">"button1"</span>)
<span class="ruby-comment"># <INPUT TYPE="submit" VALUE="ok" NAME="button1"></span>
<span class="ruby-identifier">submit</span>(<span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"ok"</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"button1"</span>, <span class="ruby-string">"ID"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"foo"</span>)
<span class="ruby-comment"># <INPUT TYPE="submit" VALUE="ok" NAME="button1" ID="foo"></span>
</pre>
<div class="method-source-code" id="submit-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 750</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">submit</span>(<span class="ruby-identifier">value</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">name</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> (<span class="ruby-keyword">not</span> <span class="ruby-identifier">value</span>) <span class="ruby-keyword">or</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"submit"</span>, <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">value</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"submit"</span>
<span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-text_field" class="method-detail ">
<div class="method-heading">
<span class="method-name">text_field</span><span
class="method-args">(name = "", value = nil, size = 40, maxlength = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a text field Input element, as a <a href="../String.html"><code>String</code></a>.</p>
<p><code>name</code> is the name of the input field. <code>value</code> is its initial value. <code>size</code> is the size of the input area. <code>maxlength</code> is the maximum length of input accepted.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<pre class="ruby"><span class="ruby-identifier">text_field</span>(<span class="ruby-string">"name"</span>)
<span class="ruby-comment"># <INPUT TYPE="text" NAME="name" SIZE="40"></span>
<span class="ruby-identifier">text_field</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>)
<span class="ruby-comment"># <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="40"></span>
<span class="ruby-identifier">text_field</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>, <span class="ruby-value">80</span>)
<span class="ruby-comment"># <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="80"></span>
<span class="ruby-identifier">text_field</span>(<span class="ruby-string">"name"</span>, <span class="ruby-string">"value"</span>, <span class="ruby-value">80</span>, <span class="ruby-value">200</span>)
<span class="ruby-comment"># <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="80" MAXLENGTH="200"></span>
<span class="ruby-identifier">text_field</span>(<span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"name"</span>, <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"value"</span>)
<span class="ruby-comment"># <INPUT TYPE="text" NAME="name" VALUE="value"></span>
</pre>
<div class="method-source-code" id="text_field-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 782</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">text_field</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">value</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">size</span> = <span class="ruby-value">40</span>, <span class="ruby-identifier">maxlength</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"TYPE"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"text"</span>, <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>, <span class="ruby-string">"VALUE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>,
<span class="ruby-string">"SIZE"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">size</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">name</span>[<span class="ruby-string">"TYPE"</span>] = <span class="ruby-string">"text"</span>
<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">attributes</span>[<span class="ruby-string">"MAXLENGTH"</span>] = <span class="ruby-identifier">maxlength</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">maxlength</span>
<span class="ruby-identifier">input</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-textarea" class="method-detail ">
<div class="method-heading">
<span class="method-name">textarea</span><span
class="method-args">(name = "", cols = 70, rows = 10) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate a TextArea element, as a <a href="../String.html"><code>String</code></a>.</p>
<p><code>name</code> is the name of the textarea. <code>cols</code> is the number of columns and <code>rows</code> is the number of rows in the display.</p>
<p>Alternatively, the attributes can be specified as a hash.</p>
<p>The body is provided by the passed-in no-argument block</p>
<pre class="ruby"><span class="ruby-identifier">textarea</span>(<span class="ruby-string">"name"</span>)
<span class="ruby-comment"># = textarea("NAME" => "name", "COLS" => 70, "ROWS" => 10)</span>
<span class="ruby-identifier">textarea</span>(<span class="ruby-string">"name"</span>, <span class="ruby-value">40</span>, <span class="ruby-value">5</span>)
<span class="ruby-comment"># = textarea("NAME" => "name", "COLS" => 40, "ROWS" => 5)</span>
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="textarea-source">
<pre><span class="ruby-comment"># File lib/cgi/html.rb, line 808</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">textarea</span>(<span class="ruby-identifier">name</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">cols</span> = <span class="ruby-value">70</span>, <span class="ruby-identifier">rows</span> = <span class="ruby-value">10</span>) <span class="ruby-comment"># :yield:</span>
<span class="ruby-identifier">attributes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
{ <span class="ruby-string">"NAME"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>, <span class="ruby-string">"COLS"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cols</span>.<span class="ruby-identifier">to_s</span>,
<span class="ruby-string">"ROWS"</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">rows</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">attributes</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>