This is an automated email from the ASF dual-hosted git repository. git-site-role pushed a commit to branch asf-staging in repository https://gitbox.apache.org/repos/asf/struts-site.git
The following commit(s) were added to refs/heads/asf-staging by this push: new 078baeb Updates stage by Jenkins 078baeb is described below commit 078baeb95c6b31c1bec17f8a29d73b00d75afefc Author: jenkins <bui...@apache.org> AuthorDate: Thu Feb 20 18:22:23 2020 +0000 Updates stage by Jenkins --- content/tag-developers/generator-tag.html | 235 +-- content/tag-developers/head-tag.html | 757 +------- content/tag-developers/hidden-tag.html | 762 +------- content/tag-developers/i18n-tag.html | 89 +- content/tag-developers/if-tag.html | 94 +- content/tag-developers/include-tag.html | 103 +- .../tag-developers/inputtransferselect-tag.html | 1147 +---------- content/tag-developers/iterator-tag.html | 410 ++-- content/tag-developers/label-tag.html | 774 +------- content/tag-developers/merge-tag.html | 201 +- content/tag-developers/optgroup-tag.html | 168 +- .../tag-developers/optiontransferselect-tag.html | 2025 +------------------- content/tag-developers/param-tag.html | 188 +- content/tag-developers/password-tag.html | 852 +------- content/tag-developers/property-tag.html | 177 +- content/tag-developers/push-tag.html | 146 +- content/tag-developers/radio-tag.html | 903 +-------- content/tag-developers/reset-tag.html | 850 +------- content/tag-developers/select-tag.html | 1014 +--------- content/tag-developers/set-tag.html | 148 +- content/tag-developers/sort-tag.html | 148 +- content/tag-developers/submit-tag.html | 867 +-------- content/tag-developers/subset-tag.html | 264 +-- content/tag-developers/text-tag.html | 135 +- content/tag-developers/textfield-tag.html | 833 +------- content/tag-developers/token-tag.html | 757 +------- content/tag-developers/updownselect-tag.html | 1109 +---------- content/tag-developers/url-tag.html | 388 +--- 28 files changed, 965 insertions(+), 14579 deletions(-) diff --git a/content/tag-developers/generator-tag.html b/content/tag-developers/generator-tag.html index 5dbabd1..9f389d8 100644 --- a/content/tag-developers/generator-tag.html +++ b/content/tag-developers/generator-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>generator tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,206 +127,93 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/generator-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="generator">generator</h1> -<p><strong>Description</strong></p> - -<p> <b>NOTE: JSP-TAG</b> - - <p>Generate an iterator based on the val attribute supplied.</p> - - <b>NOTE:</b> The generated iterator will <b>ALWAYS</b> be pushed into the top of the stack, and poped - at the end of the tag. -</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> - - <td align="left" valign="top">converter</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">org.apache.struts2.util.IteratorGenerator.Converter</td> - - <td align="left" valign="top">The converter to convert the String entry parsed from <i>val</i> into an object</td> - - </tr> - - <tr> - - <td align="left" valign="top">count</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Integer</td> - - <td align="left" valign="top">The max number entries to be in the iterator</td> - - </tr> - - <tr> - - <td align="left" valign="top">separator</td> - - <td align="left" valign="top"><strong>true</strong></td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The separator to be used in separating the <i>val</i> into entries of the iterator</td> - - </tr> - - <tr> - - <td align="left" valign="top">val</td> - - <td align="left" valign="top"><strong>true</strong></td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The source to be parsed into an iterator</td> - - </tr> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - <tr> +<h2 id="description">Description</h2> - <td align="left" valign="top">var</td> +<p>Generate an iterator based on the val attribute supplied.</p> - <td align="left" valign="top">false</td> +<blockquote> + <p>NOTE: The generated iterator will <strong>ALWAYS</strong> be pushed into the top of the stack, and poped at the end of the tag.</p> +</blockquote> - <td align="left" valign="top"></td> +<p>404: Not Found</p> - <td align="left" valign="top">false</td> +<h2 id="attributes">Attributes</h2> - <td align="left" valign="top">String</td> +<p>404: Not Found</p> - <td align="left" valign="top">The name to store the resultant iterator into page context, if such name is supplied</td> +<h2 id="examples">Examples</h2> - </tr> +<p><strong>Example 1</strong>: generate a simple iterator</p> - </table> +<pre><code class="language-jsp"><s:generator val="%{'aaa,bbb,ccc,ddd,eee'}"> + <s:iterator> + <s:property /><br/> + </s:iterator> +</s:generator> +</code></pre> -</p> +<p>This generates an iterator and print it out using the iterator tag.</p> -<p><strong>Examples</strong></p> +<p><strong>Example 2</strong>: generate an iterator with count attribute</p> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> Example One: - <span class="nt"><pre></span> - Generate a simple iterator - <span class="nt"><s:generator</span> <span class="na">val=</span><span class="s">"%{'aaa,bbb,ccc,ddd,eee'}"</span><span class="nt">></span> - <span class="nt"><s:iterator></span> - <span class="nt"><s:property</span> <span class="nt">/><br/></span> - <span class="nt"></s:iterator></span> - <span class="nt"></s:generator></span> - <span class="nt"></pre></span> - This generates an iterator and print it out using the iterator tag. +<pre><code class="language-jsp"><s:generator val="%{'aaa,bbb,ccc,ddd,eee'}" count="3"> + <s:iterator> + <s:property /><br/> + </s:iterator> +</s:generator> +</code></pre> - Example Two: - <span class="nt"><pre></span> - Generate an iterator with count attribute - <span class="nt"><s:generator</span> <span class="na">val=</span><span class="s">"%{'aaa,bbb,ccc,ddd,eee'}"</span> <span class="na">count=</span><span class="s">"3"</span><span class="nt">></span> - <span class="nt"><s:iterator></span> - <span class="nt"><s:property</span> <span class="nt">/><br/></span> - <span class="nt"></s:iterator></span> - <span class="nt"></s:generator></span> - <span class="nt"></pre></span> - This generates an iterator, but only 3 entries will be available in the iterator - generated, namely aaa, bbb and ccc respectively because count attribute is set to 3 +<p>This generates an iterator, but only 3 entries will be available in the iterator generated, namely aaa, bbb and ccc +respectively because count attribute is set to 3.</p> - Example Three: - <span class="nt"><pre></span> - Generate an iterator with var attribute - <span class="nt"><s:generator</span> <span class="na">val=</span><span class="s">"%{'aaa,bbb,ccc,ddd,eee'}"</span> <span class="na">count=</span><span class="s">"4"</span> <span class="na">separator=</span><span class="s">","</span> <span class="na">var=</span><span class="s">"myAtt"</span> <span class="nt">/></span> - <span class="err"><</span>% - Iterator i = (Iterator) pageContext.getAttribute("myAtt"); - while(i.hasNext()) { - String s = (String) i.next(); %> - <span class="err"><</span>%=s%> <span class="nt"><br/></span> - <span class="err"><</span>% } - %> - <span class="nt"></pre></span> - This generates an iterator and put it in the PageContext under the key as specified - by the var attribute. +<p><strong>Example 3</strong>: generate an iterator with var attribute</p> +<pre><code class="language-jsp"><s:generator val="%{'aaa,bbb,ccc,ddd,eee'}" count="4" separator="," var="myAtt" /> +<% + Iterator i = (Iterator) pageContext.getAttribute("myAtt"); + while(i.hasNext()) { + String s = (String) i.next(); %> + <%=s%> <br/> +<% } +%> +</code></pre> - Example Four: - <span class="nt"><pre></span> - Generate an iterator with comparator attribute - <span class="nt"><s:generator</span> <span class="na">val=</span><span class="s">"%{'aaa,bbb,ccc,ddd,eee'}"</span> <span class="na">converter=</span><span class="s">"%{myConverter}"</span><span class="nt">></span> - <span class="nt"><s:iterator></span> - <span class="nt"><s:property</span> <span class="nt">/><br/></span> - <span class="nt"></s:iterator></span> - <span class="nt"></s:generator></span> +<p>This generates an iterator and put it in the PageContext under the key as specified by the var attribute.</p> +<p><strong>Example 4</strong>: generate an iterator with comparator attribute</p> - public class GeneratorTagAction extends ActionSupport { +<pre><code class="language-jsp"><s:generator val="%{'aaa,bbb,ccc,ddd,eee'}" converter="%{myConverter}"> + <s:iterator> + <s:property /><br/> + </s:iterator> +</s:generator> +</code></pre> - .... +<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">GeneratorTagAction</span> <span class="kd">extends</span> <span class="n">ActionSupport</span> <span class="o">{</span> - public Converter getMyConverter() { - return new Converter() { - public Object convert(String value) throws Exception { - return "converter-"+value; - } - }; - } + <span class="o">....</span> - ... + <span class="kd">public</span> <span class="n">Converter</span> <span class="nf">getMyConverter</span><span class="o">()</span> <span class="o">{</span> + <span class="k">return</span> <span class="k">new</span> <span class="nf">Converter</span><span class="o">()</span> <span class="o">{</span> + <span class="kd">public</span> <span class="n">Object</span> <span class="nf">convert</span><span class="o">(</span><span class="n">String</span> <span class="n">value</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> + <span class="k">return</span> <span class="s">"converter-"</span><span class="o">+</span><span class="n">value</span><span class="o">;</span> + <span class="o">}</span> + <span class="o">};</span> + <span class="o">}</span> - } - <span class="nt"></pre></span> - This will generate an iterator with each entries decided by the converter supplied. With - this converter, it simply add "converter-" to each entries. + <span class="o">...</span> +<span class="o">}</span> </code></pre></div></div> +<p>This will generate an iterator with each entries decided by the converter supplied. With this converter, it simply +add “converter-“ to each entries.</p> </section> </article> diff --git a/content/tag-developers/head-tag.html b/content/tag-developers/head-tag.html index 2a563ad..adadb5c 100644 --- a/content/tag-developers/head-tag.html +++ b/content/tag-developers/head-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>head tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,756 +127,29 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/head-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="head">head</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p><strong>Description</strong></p> - -<p> - Renders parts of the HEAD section for an HTML file. Encoding can be set using this tag. -</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> true</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> - - <td align="left" valign="top">accesskey</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html accesskey attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">class</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css class to use for element - it's an alias of cssClass attribute.</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css class to use for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssErrorClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css error class to use for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssErrorStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css error style definitions for element to use</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css style definitions for element to use</td> - - </tr> - - <tr> - - <td align="left" valign="top">disabled</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html disabled attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">errorPosition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define error position of form element (top|bottom)</td> - - </tr> - - <tr> - - <td align="left" valign="top">id</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">HTML id attribute</td> - - </tr> - - <tr> - - <td align="left" valign="top">javascriptTooltip</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">Use JavaScript to generate tooltips</td> - - </tr> - - <tr> - - <td align="left" valign="top">key</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the key (name, value, label) for this particular component</td> - - </tr> - - <tr> - - <td align="left" valign="top">label</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Label expression used for rendering an element specific label</td> - - </tr> - - <tr> - - <td align="left" valign="top">labelSeparator</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">:</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">String that will be appended to the label</td> - - </tr> - - <tr> - - <td align="left" valign="top">labelposition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define label position of form element (top/left)</td> - - </tr> - - <tr> - - <td align="left" valign="top">name</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The name to set for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onblur</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top"> Set the html onblur attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onchange</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onchange attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onclick</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onclick attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">ondblclick</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html ondblclick attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onfocus</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onfocus attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeydown</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeydown attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeypress</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeypress attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeyup</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeyup attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmousedown</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmousedown attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmousemove</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmousemove attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseout</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseout attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseover</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseover attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseup</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseup attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onselect</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onselect attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">requiredLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">If set to true, the rendered element will indicate that input is required</td> - - </tr> - - <tr> - - <td align="left" valign="top">requiredPosition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define required position of required form element (left|right)</td> - - </tr> - - <tr> - - <td align="left" valign="top">style</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css style definitions for element to use - it's an alias of cssStyle attribute.</td> - - </tr> - - <tr> - - <td align="left" valign="top">tabindex</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html tabindex attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">template</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The template (other than default) to use for rendering the element</td> - - </tr> - - <tr> - - <td align="left" valign="top">templateDir</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The template directory.</td> - - </tr> - - <tr> - - <td align="left" valign="top">theme</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The theme (other than default) to use for rendering the element</td> - - </tr> - - <tr> - - <td align="left" valign="top">title</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html title attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltip</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the tooltip of this particular component</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipConfig</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Deprecated. Use individual tooltip configuration attributes instead.</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipCssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">StrutsTTClassic</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">CSS class applied to JavaScrip tooltips</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipDelay</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Classic</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Delay in milliseconds, before showing JavaScript tooltips </td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipIconPath</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Icon path used for image that will have the tooltip</td> - - </tr> - - <tr> - - <td align="left" valign="top">value</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Preset the value of input element.</td> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - </tr> +<h2 id="description">Description</h2> - </table> +<p>Renders parts of the HEAD section for an HTML file. Encoding can be set using this tag.</p> -</p> +<p>404: Not Found</p> -<p><strong>Examples</strong></p> +<h2 id="attributes">Attributes</h2> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><head></span> - <span class="nt"><title></span>My page<span class="nt"></title></span> - <span class="nt"><s:head/></span> - <span class="nt"></head></span> +<p>404: Not Found</p> -</code></pre></div></div> +<h2 id="examples">Examples</h2> +<pre><code class="language-jsp"> <head> + <title>My page</title> + <s:head/> + </head> +</code></pre> </section> </article> diff --git a/content/tag-developers/hidden-tag.html b/content/tag-developers/hidden-tag.html index d446bea..ca3d728 100644 --- a/content/tag-developers/hidden-tag.html +++ b/content/tag-developers/hidden-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>hidden tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,760 +127,42 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/hidden-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="hidden">hidden</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p><strong>Description</strong></p> - -<p> Renders an HTML input element of type hidden, populated by the specified property from the ValueStack. -</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> true</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> - - <td align="left" valign="top">accesskey</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html accesskey attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">class</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css class to use for element - it's an alias of cssClass attribute.</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css class to use for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssErrorClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css error class to use for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssErrorStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css error style definitions for element to use</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css style definitions for element to use</td> - - </tr> - - <tr> - - <td align="left" valign="top">disabled</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html disabled attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">errorPosition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define error position of form element (top|bottom)</td> - - </tr> - - <tr> - - <td align="left" valign="top">id</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">HTML id attribute</td> - - </tr> - - <tr> - - <td align="left" valign="top">javascriptTooltip</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">Use JavaScript to generate tooltips</td> - - </tr> - - <tr> - - <td align="left" valign="top">key</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the key (name, value, label) for this particular component</td> - - </tr> - - <tr> - - <td align="left" valign="top">label</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Label expression used for rendering an element specific label</td> - - </tr> - - <tr> - - <td align="left" valign="top">labelSeparator</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">:</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">String that will be appended to the label</td> - - </tr> - - <tr> - - <td align="left" valign="top">labelposition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define label position of form element (top/left)</td> - - </tr> - - <tr> - - <td align="left" valign="top">name</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The name to set for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onblur</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top"> Set the html onblur attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onchange</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onchange attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onclick</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onclick attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">ondblclick</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html ondblclick attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onfocus</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onfocus attribute on rendered html element</td> - - </tr> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - <tr> +<h2 id="description">Description</h2> - <td align="left" valign="top">onkeydown</td> +<p>Renders an HTML input element of type hidden, populated by the specified property from the ValueStack.</p> - <td align="left" valign="top">false</td> +<p>404: Not Found</p> - <td align="left" valign="top"></td> +<h2 id="attributes">Attributes</h2> - <td align="left" valign="top">false</td> +<p>404: Not Found</p> - <td align="left" valign="top">String</td> +<h2 id="examples">Examples</h2> - <td align="left" valign="top">Set the html onkeydown attribute on rendered html element</td> +<p><strong>Example 1</strong></p> - </tr> +<pre><code class="language-jsp"><s:hidden name="foo" /> +</code></pre> +<p>Example One Resulting HTML (if <code class="highlighter-rouge">foo</code> evaluates to <code class="highlighter-rouge">bar</code>):</p> - <tr> - - <td align="left" valign="top">onkeypress</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeypress attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeyup</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeyup attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmousedown</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmousedown attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmousemove</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmousemove attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseout</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseout attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseover</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseover attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseup</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseup attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onselect</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onselect attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">requiredLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">If set to true, the rendered element will indicate that input is required</td> - - </tr> - - <tr> - - <td align="left" valign="top">requiredPosition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define required position of required form element (left|right)</td> - - </tr> - - <tr> - - <td align="left" valign="top">style</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css style definitions for element to use - it's an alias of cssStyle attribute.</td> - - </tr> - - <tr> - - <td align="left" valign="top">tabindex</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html tabindex attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">template</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The template (other than default) to use for rendering the element</td> - - </tr> - - <tr> - - <td align="left" valign="top">templateDir</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The template directory.</td> - - </tr> - - <tr> - - <td align="left" valign="top">theme</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The theme (other than default) to use for rendering the element</td> - - </tr> - - <tr> - - <td align="left" valign="top">title</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html title attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltip</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the tooltip of this particular component</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipConfig</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Deprecated. Use individual tooltip configuration attributes instead.</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipCssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">StrutsTTClassic</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">CSS class applied to JavaScrip tooltips</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipDelay</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Classic</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Delay in milliseconds, before showing JavaScript tooltips </td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipIconPath</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Icon path used for image that will have the tooltip</td> - - </tr> - - <tr> - - <td align="left" valign="top">value</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Preset the value of input element.</td> - - </tr> - - </table> - -</p> - -<p><strong>Examples</strong></p> +<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><input</span> <span class="na">type=</span><span class="s">"hidden"</span> <span class="na">name=</span><span class="s">"foo"</span> <span class="na">value=</span><span class="s">"bar"</span> <span class="nt">/></span> +</code></pre></div></div> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><--</span> <span class="err">example</span> <span class="err">one</span> <span class="err">--</span><span class="nt">></span> - <span class="nt"><s:hidden</span> <span class="na">name=</span><span class="s">"foo"</span> <span class="nt">/></span> - <span class="nt"><--</span> <span class="err">example</span> <span class="err">two</span> <span class="err">--</span><span class="nt">></span> - <span class="nt"><s:hidden</span> <span class="na">name=</span><span class="s">"foo"</span> <span class="na">value=</span><span class="s">"%{bar}"</span> <span class="nt">/></span> +<p><strong>Example 2</strong></p> - Example One Resulting HTML (if foo evaluates to bar): - <span class="nt"><input</span> <span class="na">type=</span><span class="s">"hidden"</span> <span class="na">name=</span><span class="s">"foo"</span> <span class="na">value=</span><span class="s">"bar"</span> <span class="nt">/></span> - Example Two Resulting HTML (if getBar method of the action returns 'bar') - <span class="nt"><input</span> <span class="na">type=</span><span class="s">"hidden"</span> <span class="na">name=</span><span class="s">"foo"</span> <span class="na">value=</span><span class="s">"bar"</span> <span class="nt">/></span> +<pre><code class="language-jsp"><s:hidden name="foo" value="%{bar}" /> +</code></pre> -</code></pre></div></div> +<p>Example Two Resulting HTML (if <code class="highlighter-rouge">getBar</code> method of the action returns <code class="highlighter-rouge">bar</code>)</p> +<pre><code class="language-jsp"><input type="hidden" name="foo" value="bar" /> +</code></pre> </section> </article> diff --git a/content/tag-developers/i18n-tag.html b/content/tag-developers/i18n-tag.html index 1dd850b..89e36b5 100644 --- a/content/tag-developers/i18n-tag.html +++ b/content/tag-developers/i18n-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>i18n tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,88 +127,29 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/i18n-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="i18n">i18n</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p><strong>Description</strong></p> - -<p> - Gets a resource bundle and place it on the value stack. This allows - the text tag to access messages from any bundle, and not just the bundle - associated with the current action. - -</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> - - <td align="left" valign="top">name</td> - - <td align="left" valign="top"><strong>true</strong></td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Name of resource bundle to use (eg foo/bar/customBundle)</td> - - </tr> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - </table> +<h2 id="description">Description</h2> -</p> +<p>Gets a resource bundle and place it on the value stack. This allows the text tag to access messages from any bundle, +and not just the bundle associated with the current action.</p> -<p><strong>Examples</strong></p> +<p>404: Not Found</p> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - <span class="nt"><s:i18n</span> <span class="na">name=</span><span class="s">"myCustomBundle"</span><span class="nt">></span> - The i18n value for key aaa.bbb.ccc in myCustomBundle is <span class="nt"><s:property</span> <span class="na">value=</span><span class="s">"text('aaa.bbb.ccc')"</span> <span class="nt">/></span> - <span class="nt"></s:i18n></span> +<h2 id="attributes">Attributes</h2> +<p>404: Not Found</p> -</code></pre></div></div> +<h2 id="examples">Examples</h2> +<pre><code class="language-jsp"><s:i18n name="myCustomBundle"> + The i18n value for key aaa.bbb.ccc in myCustomBundle is <s:property value="text('aaa.bbb.ccc')" /> +</s:i18n> +</code></pre> </section> </article> diff --git a/content/tag-developers/if-tag.html b/content/tag-developers/if-tag.html index a13c958..12a846a 100644 --- a/content/tag-developers/if-tag.html +++ b/content/tag-developers/if-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>if tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,87 +127,35 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/if-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="if">if</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p><strong>Description</strong></p> - -<p>Perform basic condition flow. ‘If’ tag could be used by itself or can be followed by zero or more ‘Else if’ Tags followed by zero or one ‘Else’ Tag.</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> - - <td align="left" valign="top">test</td> - - <td align="left" valign="top"><strong>true</strong></td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">Expression to determine if body of tag is to be displayed</td> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - </tr> +<h2 id="description__">Description__</h2> - </table> +<p>Perform basic condition flow. <code class="highlighter-rouge">if</code> tag could be used by itself or can be followed by zero or more <code class="highlighter-rouge">elseif</code> tags +followed by zero or one <code class="highlighter-rouge">else</code> tag.</p> -</p> +<p>404: Not Found</p> -<p><strong>Examples</strong></p> +<h2 id="attributes">Attributes</h2> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><s:if</span> <span class="na">test=</span><span class="s">"%{false}"</span><span class="nt">></span> - <span class="nt"><div></span>Will Not Be Executed<span class="nt"></div></span> - <span class="nt"></s:if></span> - <span class="nt"><s:elseif</span> <span class="na">test=</span><span class="s">"%{true}"</span><span class="nt">></span> - <span class="nt"><div></span>Will Be Executed<span class="nt"></div></span> - <span class="nt"></s:elseif></span> - <span class="nt"><s:else></span> - <span class="nt"><div></span>Will Not Be Executed<span class="nt"></div></span> - <span class="nt"></s:else></span> +<p>404: Not Found</p> -</code></pre></div></div> +<h2 id="examples">Examples</h2> +<pre><code class="language-jsp"><s:if test="%{false}"> + <div>Will Not Be Executed</div> +</s:if> +<s:elseif test="%{true}"> + <div>Will Be Executed</div> +</s:elseif> +<s:else> + <div>Will Not Be Executed</div> +</s:else> +</code></pre> </section> </article> diff --git a/content/tag-developers/include-tag.html b/content/tag-developers/include-tag.html index 4971cfa..abbfad8 100644 --- a/content/tag-developers/include-tag.html +++ b/content/tag-developers/include-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>include tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,98 +127,61 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/include-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="include">include</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> -<p><strong>Description</strong></p> +<h2 id="description">Description</h2> <p>Include a servlet’s output (result of servlet or a JSP page).</p> -<p><strong>Note:</strong> Any additional params supplied to the included page are <strong>not</strong> - accessible within the rendered page through the <s:property…> tag - since no valuestack will be created. You can, however, access them in a - servlet via the HttpServletRequest object or from a JSP page via - a scriptlet.</p> +<blockquote> + <p><strong>Note:</strong> Any additional params supplied to the included page are <strong>not</strong> accessible within the rendered page +through the <code class="highlighter-rouge"><s:property.../></code> tag since no ValueStack will be created. You can, however, access them in a servlet +via the HttpServletRequest object or from a JSP page via a scriptlet.</p> +</blockquote> <p><strong>How To access parameters</strong></p> -<p>Parameters are passed as request parameters, so use the <code class="highlighter-rouge">${param.ParamName}</code> notation to access them. Do not use the <strong>property</strong> tag to access parameters in included files.</p> - -<p><strong>Parameters</strong></p> - -<table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> +<p>Parameters are passed as request parameters, so use the <code class="highlighter-rouge">${param.ParamName}</code> notation to access them. Do not use +the <strong>property</strong> tag to access parameters in included files.</p> - <th align="left" valign="top"><h4>Required</h4></th> +<p>404: Not Found</p> - <th align="left" valign="top"><h4>Default</h4></th> +<h2 id="attributes">Attributes</h2> - <th align="left" valign="top"><h4>Evaluated</h4></th> +<p>404: Not Found</p> - <th align="left" valign="top"><h4>Type</h4></th> +<h2 id="example">Example</h2> - <th align="left" valign="top"><h4>Description</h4></th> +<p><strong>Example 1</strong></p> - </tr> - - <tr> - - <td align="left" valign="top">value</td> - - <td align="left" valign="top"><strong>true</strong></td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The jsp/servlet output to include</td> - - </tr> - -</table> +<pre><code class="language-jsp"><s:include value="myJsp.jsp" /> +</code></pre> -<p><strong>Example</strong></p> +<p>do an include myJsp.jsp page</p> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="c"><!-- One: --></span> - <span class="nt"><s:include</span> <span class="na">value=</span><span class="s">"myJsp.jsp"</span> <span class="nt">/></span> +<p><strong>Example 2</strong></p> - <span class="c"><!-- Two: --></span> - <span class="nt"><s:include</span> <span class="na">value=</span><span class="s">"myJsp.jsp"</span><span class="nt">></span> - <span class="nt"><s:param</span> <span class="na">name=</span><span class="s">"param1"</span> <span class="na">value=</span><span class="s">"value2"</span> <span class="nt">/></span> - <span class="nt"><s:param</span> <span class="na">name=</span><span class="s">"param2"</span> <span class="na">value=</span><span class="s">"value2"</span> <span class="nt">/></span> - <span class="nt"></s:include></span> +<pre><code class="language-jsp"><s:include value="myJsp.jsp"> + <s:param name="param1" value="value2" /> + <s:param name="param2" value="value2" /> +</s:include> +</code></pre> - <span class="c"><!-- Three: --></span> - <span class="nt"><s:include</span> <span class="na">value=</span><span class="s">"myJsp.jsp"</span><span class="nt">></span> - <span class="nt"><s:param</span> <span class="na">name=</span><span class="s">"param1"</span><span class="nt">></span>value1<span class="nt"></s:param></span> - <span class="nt"><s:param</span> <span class="na">name=</span><span class="s">"param2"</span><span class="nt">></span>value2<span class="nt"></s:param></span> - <span class="nt"></s:include></span> -</code></pre></div></div> +<p>do an include to myJsp.jsp page with parameters <code class="highlighter-rouge">param1=value1</code> and <code class="highlighter-rouge">param2=value2</code></p> -<pre><code class="language-none"> Example one - do an include myJsp.jsp page - Example two - do an include to myJsp.jsp page with parameters param1=value1 and param2=value2 - Example three - do an include to myJsp.jsp page with parameters param1=value1 and param2=value2 +<p><strong>Example 3</strong></p> +<pre><code class="language-jsp"><s:include value="myJsp.jsp"> + <s:param name="param1">value1</s:param> + <s:param name="param2">value2</s:param> +</s:include> </code></pre> +<p>do an include to myJsp.jsp page with parameters <code class="highlighter-rouge">param1=value1</code> and <code class="highlighter-rouge">param2=value2</code></p> </section> </article> diff --git a/content/tag-developers/inputtransferselect-tag.html b/content/tag-developers/inputtransferselect-tag.html index ba6fcc3..054e927 100644 --- a/content/tag-developers/inputtransferselect-tag.html +++ b/content/tag-developers/inputtransferselect-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>inputtransferselect tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,1139 +127,38 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/inputtransferselect-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="inputtransferselect">inputtransferselect</h1> -<p><strong>Description</strong></p> - -<p> <p> - Create a input transfer select component which is basically an text input - and <select ...> tag with buttons in the middle of them allowing text - to be added to the transfer select. Will auto-select all its - elements upon its containing form submission. - </p> -</p> - -<p> <p> - NOTE: The id and doubleId need not be supplied as they will generated provided - that the inputtransferselect tag is being used in a form tag. The generated id - and doubleId will be <form_id>_<inputtransferselect_doubleName> and - <form_id>_<inputtransferselect_doubleName> respectively. - </p> -</p> - - -__Parameters__ - - - - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> - - <td align="left" valign="top">accesskey</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html accesskey attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">addLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the label used for the add button</td> - - </tr> - - <tr> - - <td align="left" valign="top">allowRemoveAll</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Determine whether the remove all button will display</td> - - </tr> - - <tr> - - <td align="left" valign="top">allowUpDown</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Determine whether items in the list can be reordered</td> - - </tr> - - <tr> - - <td align="left" valign="top">buttonCssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the css class used for rendering buttons</td> - - </tr> - - <tr> - - <td align="left" valign="top">buttonCssStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the css style used for rendering buttons</td> - - </tr> - - <tr> - - <td align="left" valign="top">class</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css class to use for element - it's an alias of cssClass attribute.</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css class to use for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssErrorClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css error class to use for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssErrorStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css error style definitions for element to use</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css style definitions for element to use</td> - - </tr> - - <tr> - - <td align="left" valign="top">disabled</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html disabled attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">downLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the label used for the down button</td> - - </tr> - - <tr> - - <td align="left" valign="top">errorPosition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define error position of form element (top|bottom)</td> - - </tr> - - <tr> - - <td align="left" valign="top">headerKey</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the header key of the select box</td> - - </tr> - - <tr> - - <td align="left" valign="top">headerValue</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the header value of the select box</td> - - </tr> - - <tr> - - <td align="left" valign="top">id</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">HTML id attribute</td> - - </tr> - - <tr> - - <td align="left" valign="top">javascriptTooltip</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">Use JavaScript to generate tooltips</td> - - </tr> - - <tr> - - <td align="left" valign="top">key</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the key (name, value, label) for this particular component</td> - - </tr> - - <tr> - - <td align="left" valign="top">label</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Label expression used for rendering an element specific label</td> - - </tr> - - <tr> - - <td align="left" valign="top">labelSeparator</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">:</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">String that will be appended to the label</td> - - </tr> - - <tr> - - <td align="left" valign="top">labelposition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define label position of form element (top/left)</td> - - </tr> - - <tr> - - <td align="left" valign="top">leftTitle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the left hand title</td> - - </tr> - - <tr> - - <td align="left" valign="top">list</td> - - <td align="left" valign="top"><strong>true</strong></td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Iterable source to populate from. If the list is a Map (key, value), the Map key will become the option 'value' parameter and the Map value will become the option body.</td> - - </tr> - - <tr> - - <td align="left" valign="top">listCssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Property of list objects to get css class from</td> - - </tr> - - <tr> - - <td align="left" valign="top">listCssStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Property of list objects to get css style from</td> - - </tr> - - <tr> - - <td align="left" valign="top">listKey</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Property of list objects to get field value from</td> - - </tr> - - <tr> - - <td align="left" valign="top">listLabelKey</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Property of list objects to be used to lookup for localised version of field label</td> - - </tr> - - <tr> - - <td align="left" valign="top">listTitle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Property of list objects to get title from</td> - - </tr> - - <tr> - - <td align="left" valign="top">listValue</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Property of list objects to get field content from</td> - - </tr> - - <tr> - - <td align="left" valign="top">listValueKey</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Property of list objects to get field value label from</td> - - </tr> - - <tr> - - <td align="left" valign="top">multiple</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Determine whether or not multiple entries are shown</td> - - </tr> - - <tr> - - <td align="left" valign="top">name</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The name to set for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onblur</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top"> Set the html onblur attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onchange</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onchange attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onclick</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onclick attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">ondblclick</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html ondblclick attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onfocus</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onfocus attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeydown</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeydown attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeypress</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeypress attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeyup</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeyup attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmousedown</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmousedown attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmousemove</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmousemove attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseout</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseout attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseover</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseover attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseup</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseup attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onselect</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onselect attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">removeAllLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the label used for the remove all button</td> - - </tr> - - <tr> - - <td align="left" valign="top">removeLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the label used for the remove button</td> - - </tr> - - <tr> - - <td align="left" valign="top">requiredLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">If set to true, the rendered element will indicate that input is required</td> - - </tr> - - <tr> - - <td align="left" valign="top">requiredPosition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define required position of required form element (left|right)</td> - - </tr> - - <tr> - - <td align="left" valign="top">rightTitle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the right hand title</td> - - </tr> - - <tr> - - <td align="left" valign="top">size</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the size of the select box</td> - - </tr> - - <tr> - - <td align="left" valign="top">style</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css style definitions for element to use - it's an alias of cssStyle attribute.</td> - - </tr> - - <tr> - - <td align="left" valign="top">tabindex</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html tabindex attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">template</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The template (other than default) to use for rendering the element</td> - - </tr> - - <tr> - - <td align="left" valign="top">templateDir</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The template directory.</td> - - </tr> - - <tr> - - <td align="left" valign="top">theme</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The theme (other than default) to use for rendering the element</td> - - </tr> - - <tr> - - <td align="left" valign="top">title</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html title attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltip</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the tooltip of this particular component</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipConfig</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Deprecated. Use individual tooltip configuration attributes instead.</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipCssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">StrutsTTClassic</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">CSS class applied to JavaScrip tooltips</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipDelay</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Classic</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Delay in milliseconds, before showing JavaScript tooltips </td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipIconPath</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Icon path used for image that will have the tooltip</td> - - </tr> - - <tr> - - <td align="left" valign="top">upLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the label used for the up button</td> - - </tr> - - <tr> - - <td align="left" valign="top">value</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Preset the value of input element.</td> - - </tr> - - </table> - -</p> - - -__Example__ - - +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> +<h2 id="description">Description</h2> +<p>Create a input transfer select component which is basically an text input and <code class="highlighter-rouge"><select ...></code> tag with buttons +in the middle of them allowing text to be added to the transfer select. Will auto-select all its elements upon its +containing form submission.</p> -```xml +<blockquote> + <p><strong>NOTE</strong>: The id and doubleId need not be supplied as they will generated provided that the inputtransferselect +tag is being used in a form tag. The generated id and doubleId will be <code class="highlighter-rouge"><form_id>_<inputtransferselect_doubleName></code> +and <code class="highlighter-rouge"><form_id>_<inputtransferselect_doubleName></code> respectively.</p> +</blockquote> - <-- minimum configuration --> - <s:inputtransferselect label="Favourite Cartoons Characters" name="cartoons" list="{'Popeye', 'He-Man', 'Spiderman'}" /> +<p>404: Not Found</p> +<h2 id="attributes">Attributes</h2> -``` +<p>404: Not Found</p> +<h2 id="example">Example</h2> -</inputtransferselect_doubleName></form_id></inputtransferselect_doubleName></form_id></p></p> +<pre><code class="language-jsp"><s:inputtransferselect + label="Favourite Cartoons Characters" + name="cartoons" + list="{'Popeye', 'He-Man', 'Spiderman'}" + /> +</code></pre> </section> </article> diff --git a/content/tag-developers/iterator-tag.html b/content/tag-developers/iterator-tag.html index 12e4e80..49a8925 100644 --- a/content/tag-developers/iterator-tag.html +++ b/content/tag-developers/iterator-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>iterator tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,310 +127,122 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/iterator-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="iterator">iterator</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p>The id attribute is deprecated in Struts 2.1.x, and has been replaced by the var attribute.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p>The begin, end and step attributes are only available from 2.1.7 on</p> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> <blockquote> - + <p><strong>NOTE</strong>: The id attribute is deprecated in Struts 2.1.x, and has been replaced by the var attribute. +The <code class="highlighter-rouge">begin</code>, <code class="highlighter-rouge">end</code> and <code class="highlighter-rouge">step</code> attributes are only available from 2.1.7+</p> </blockquote> -<p><strong>Description</strong></p> - -<p> - <p>Iterator will iterate over a value. An iterable value can be any of: java.util.Collection, java.util.Iterator, - java.util.Enumeration, java.util.Map, or an array.</p> - -</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> - - <td align="left" valign="top">begin</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">0</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Integer</td> - - <td align="left" valign="top">if specified the iteration will start on that index</td> - - </tr> - - <tr> - - <td align="left" valign="top">end</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Size of the 'values' List or array, or 0 if 'step' is negative</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Integer</td> - - <td align="left" valign="top">if specified the iteration will end on that index(inclusive)</td> - - </tr> - - <tr> - - <td align="left" valign="top">status</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">If specified, an instanceof IteratorStatus will be pushed into stack upon each iteration</td> - - </tr> - - <tr> - - <td align="left" valign="top">step</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">1</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Integer</td> - - <td align="left" valign="top">if specified the iteration index will be increased by this value on each iteration. It can be a negative value, in which case 'begin' must be greater than 'end'</td> - - </tr> - - <tr> - - <td align="left" valign="top">value</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">the iteratable source to iterate over, else an the object itself will be put into a newly created List</td> - - </tr> - - <tr> - - <td align="left" valign="top">var</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Name used to reference the value pushed into the Value Stack</td> - - </tr> - - </table> - -</p> - -<p><strong>Examples</strong></p> - -<p> - <p>The following example retrieves the value of the getDays() method of the current object on the value stack and - uses it to iterate over. The <s:property /> tag prints out the current value of the iterator.</p> - -</p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><s:iterator</span> <span class="na">value=</span><span class="s">"days"</span><span class="nt">></span> - <span class="nt"><p></span>day is: <span class="nt"><s:property/></p></span> - <span class="nt"></s:iterator></span> - -</code></pre></div></div> - -<p> - <p>The following example uses a {@link Bean} tag and places it into the ActionContext. The iterator tag will retrieve - that object from the ActionContext and then calls its getDays() method as above. The status attribute is also used to - create an {@link IteratorStatus} object, which in this example, its odd() method is used to alternate row - colours:</p> - -</p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - <span class="nt"><s:bean</span> <span class="na">name=</span><span class="s">"org.apache.struts2.example.IteratorExample"</span> <span class="na">var=</span><span class="s">"it"</span><span class="nt">></span> - <span class="nt"><s:param</span> <span class="na">name=</span><span class="s">"day"</span> <span class="na">value=</span><span class="s">"'foo'"</span><span class="nt">/></span> - <span class="nt"><s:param</span> <span class="na">name=</span><span class="s">"day"</span> <span class="na">value=</span><span class="s">"'bar'"</span><span class="nt">/></span> - <span class="nt"></s:bean></span> - - <span class="nt"><table</span> <span class="na">border=</span><span class="s">"0"</span> <span class="na">cellspacing=</span><span class="s">"0"</span> <span class="na">cellpadding=</span><span class="s">"1"</span><span class="nt">></span> - <span class="nt"><tr></span> - <span class="nt"><th></span>Days of the week<span class="nt"></th></span> - <span class="nt"></tr></span> - - <span class="nt"><s:iterator</span> <span class="na">value=</span><span class="s">"#it.days"</span> <span class="na">status=</span><span class="s">"rowstatus"</span><span class="nt">></span> - <span class="nt"><tr></span> - <span class="nt"><s:if</span> <span class="na">test=</span><span class="s">"#rowstatus.odd == true"</span><span class="nt">></span> - <span class="nt"><td</span> <span class="na">style=</span><span class="s">"background: grey"</span><span class="nt">><s:property/></td></span> - <span class="nt"></s:if></span> - <span class="nt"><s:else></span> - <span class="nt"><td><s:property/></td></span> - <span class="nt"></s:else></span> - <span class="nt"></tr></span> - <span class="nt"></s:iterator></span> - <span class="nt"></table></span> - - -</code></pre></div></div> - -<p> - <p> The next example will further demonstrate the use of the status attribute, using a DAO obtained from the action - class through OGNL, iterating over groups and their users (in a security context). The last() method indicates if the - current object is the last available in the iteration, and if not, we need to separate the users using a comma: </p> - -</p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - <span class="nt"><s:iterator</span> <span class="na">value=</span><span class="s">"groupDao.groups"</span> <span class="na">status=</span><span class="s">"groupStatus"</span><span class="nt">></span> - <span class="nt"><tr</span> <span class="na">class=</span><span class="s">"<s:if test="</span><span class="err">#</span><span class="na">groupStatus.odd =</span><span class="s">=</span> <span class="err">true</span> <span class="err">"</span><span class="nt">></span>odd<span class="nt"></s:if><s:else></span>even<span class="nt"></s:else></span>"> - <span class="nt"><td><s:property</span> <span class="na">value=</span><span class="s">"name"</span> <span class="nt">/></td></span> - <span class="nt"><td><s:property</span> <span class="na">value=</span><span class="s">"description"</span> <span class="nt">/></td></span> - <span class="nt"><td></span> - <span class="nt"><s:iterator</span> <span class="na">value=</span><span class="s">"users"</span> <span class="na">status=</span><span class="s">"userStatus"</span><span class="nt">></span> - <span class="nt"><s:property</span> <span class="na">value=</span><span class="s">"fullName"</span> <span class="nt">/><s:if</span> <span class="na">test=</span><span class="s">"!#userStatus.last"</span><span class="nt">></span>,<span class="nt"></s:if></span> - <span class="nt"></s:iterator></span> - <span class="nt"></td></span> - <span class="nt"></tr></span> - <span class="nt"></s:iterator></span> - - -</code></pre></div></div> - -<p> - <p> The next example iterates over a an action collection and passes every iterator value to another action. The - trick here lies in the use of the '[0]' operator. It takes the current iterator value and passes it on to the edit - action. Using the '[0]' operator has the same effect as using <s:property />. (The latter, however, does not - work from inside the param tag). </p> - -</p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - <span class="nt"><s:action</span> <span class="na">name=</span><span class="s">"entries"</span> <span class="na">var=</span><span class="s">"entries"</span><span class="nt">/></span> - <span class="nt"><s:iterator</span> <span class="na">value=</span><span class="s">"#entries.entries"</span> <span class="nt">></span> - <span class="nt"><s:property</span> <span class="na">value=</span><span class="s">"name"</span> <span class="nt">/></span> - <span class="nt"><s:property</span> <span class="nt">/></span> - <span class="nt"><s:push</span> <span class="na">value=</span><span class="s">"..."</span><span class="nt">></span> - <span class="nt"><s:action</span> <span class="na">name=</span><span class="s">"edit"</span> <span class="na">var=</span><span class="s">"edit"</span> <span class="nt">></span> - <span class="nt"><s:param</span> <span class="na">name=</span><span class="s">"entry"</span> <span class="na">value=</span><span class="s">"[0]"</span> <span class="nt">/></span> - <span class="nt"></s:action></span> - <span class="nt"></push></span> - <span class="nt"></s:iterator></span> - - -</code></pre></div></div> - -<p> - <p>A loop that iterates 5 times</p> - -</p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - <span class="nt"><s:iterator</span> <span class="na">var=</span><span class="s">"counter"</span> <span class="na">begin=</span><span class="s">"1"</span> <span class="na">end=</span><span class="s">"5"</span> <span class="nt">></span> - <span class="c"><!-- current iteration value (1, ... 5) --></span> - <span class="nt"><s:property</span> <span class="na">value=</span><span class="s">"top"</span> <span class="nt">/></span> - <span class="nt"></s:iterator></span> - - -</code></pre></div></div> - -<p> - <p>Another way to create a simple loop, similar to JSTL's - <c:forEach begin="..." end="..." ...> is to use some - OGNL magic, which provides some under-the-covers magic to - make 0-n loops trivial. This example also loops five times.</p> - -</p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - <span class="nt"><s:iterator</span> <span class="na">status=</span><span class="s">"stat"</span> <span class="na">value=</span><span class="s">"(5).{ #this }"</span> <span class="nt">></span> - <span class="nt"><s:property</span> <span class="na">value=</span><span class="s">"#stat.count"</span> <span class="nt">/></span> <span class="c"><!-- Note that "count" is 1-based, "index" is 0-based. --></span> - <span class="nt"></s:iterator></span> - - -</code></pre></div></div> - -<p> - <p>A loop that iterates over a partial list</p> - -</p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - <span class="nt"><s:iterator</span> <span class="na">value=</span><span class="s">"{1,2,3,4,5}"</span> <span class="na">begin=</span><span class="s">"2"</span> <span class="na">end=</span><span class="s">"4"</span> <span class="nt">></span> - <span class="c"><!-- current iteration value (2,3,4) --></span> - <span class="nt"><s:property</span> <span class="na">value=</span><span class="s">"top"</span> <span class="nt">/></span> - <span class="nt"></s:iterator></span> - - -</code></pre></div></div> - +<h2 id="description">Description</h2> + +<p>Iterator will iterate over a value. An iterable value can be any of: <code class="highlighter-rouge">java.util.Collection</code>, <code class="highlighter-rouge">java.util.Iterator</code>, +<code class="highlighter-rouge">java.util.Enumeration</code>, <code class="highlighter-rouge">java.util.Map</code>, or an array.</p> + +<p>404: Not Found</p> + +<h2 id="attributes">Attributes</h2> + +<p>404: Not Found</p> + +<h2 id="examples">Examples</h2> + +<p>The following example retrieves the value of the getDays() method of the current object on the value stack and uses +it to iterate over. The <code class="highlighter-rouge"><s:property/></code> tag prints out the current value of the iterator.</p> + +<pre><code class="language-jsp"><s:iterator value="days"> + <p>day is: <s:property/></p> +</s:iterator> +</code></pre> + +<p>The following example uses a {@link Bean} tag and places it into the ActionContext. The iterator tag will retrieve that +object from the <code class="highlighter-rouge">ActionContext</code> and then calls its <code class="highlighter-rouge">getDays()</code> method as above. The status attribute is also used +to create an <code class="highlighter-rouge">IteratorStatus</code> object, which in this example, its <code class="highlighter-rouge">odd()</code> method is used to alternate row colours:</p> + +<pre><code class="language-jsp"><s:bean name="org.apache.struts2.example.IteratorExample" var="it"> + <s:param name="day" value="'foo'"/> + <s:param name="day" value="'bar'"/> +</s:bean> + +<table border="0" cellspacing="0" cellpadding="1"> +<tr> + <th>Days of the week</th> +</tr> + +<s:iterator value="#it.days" status="rowstatus"> + <tr> + <s:if test="#rowstatus.odd == true"> + <td style="background: grey"><s:property/></td> + </s:if> + <s:else> + <td><s:property/></td> + </s:else> + </tr> +</s:iterator> +</table> +</code></pre> + +<p>The next example will further demonstrate the use of the status attribute, using a DAO obtained from the action class +through OGNL, iterating over groups and their users (in a security context). The last() method indicates if the current +object is the last available in the iteration, and if not, we need to separate the users using a comma:</p> + +<pre><code class="language-jsp"><s:iterator value="groupDao.groups" status="groupStatus"> + <tr class="<s:if test="#groupStatus.odd == true ">odd</s:if><s:else>even</s:else>"> + <td><s:property value="name" /></td> + <td><s:property value="description" /></td> + <td> + <s:iterator value="users" status="userStatus"> + <s:property value="fullName" /><s:if test="!#userStatus.last">,</s:if> + </s:iterator> + </td> + </tr> +</s:iterator> +</code></pre> + +<p>The next example iterates over a an action collection and passes every iterator value to another action. The trick here +lies in the use of the <code class="highlighter-rouge">[0]</code> operator. It takes the current iterator value and passes it on to the edit action. +Using the <code class="highlighter-rouge">[0]</code> operator has the same effect as using <code class="highlighter-rouge"><s:property /></code>. (The latter, however, does not work from inside +the <code class="highlighter-rouge">param</code> tag).</p> + +<pre><code class="language-jsp"><s:action name="entries" var="entries"/> +<s:iterator value="#entries.entries" > + <s:property value="name" /> + <s:property /> + <s:push value="..."> + <s:action name="edit" var="edit" > + <s:param name="entry" value="[0]" /> + </s:action> + </push> +</s:iterator> +</code></pre> + +<p>A loop that iterates 5 times</p> + +<pre><code class="language-jsp"><s:iterator var="counter" begin="1" end="5" > + <!-- current iteration value (1, ... 5) --> + <s:property value="top" /> +</s:iterator> +</code></pre> + +<p>Another way to create a simple loop, similar to JSTL’s <code class="highlighter-rouge"><c:forEach begin="..." end="..." ...></code> is to use some OGNL +magic, which provides some under-the-covers magic to make 0-n loops trivial. This example also loops five times.</p> + +<pre><code class="language-jsp"><s:iterator status="stat" value="(5).{ #this }" > + <s:property value="#stat.count" /> <!-- Note that "count" is 1-based, "index" is 0-based. --> +</s:iterator> +</code></pre> + +<p>A loop that iterates over a partial list</p> + +<pre><code class="language-jsp"><s:iterator value="{1,2,3,4,5}" begin="2" end="4" > + <!-- current iteration value (2,3,4) --> + <s:property value="top" /> +</s:iterator> +</code></pre> </section> </article> diff --git a/content/tag-developers/label-tag.html b/content/tag-developers/label-tag.html index 686a8c6..7d6604b 100644 --- a/content/tag-developers/label-tag.html +++ b/content/tag-developers/label-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>label tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,775 +127,31 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/label-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="label">label</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p><strong>Description</strong></p> - -<p> <p>Renders an HTML LABEL that will allow you to output label:name combination that has the same format treatment as - the rest of your UI controls.</p> -</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> true</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> - - <td align="left" valign="top">accesskey</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html accesskey attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">class</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css class to use for element - it's an alias of cssClass attribute.</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css class to use for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssErrorClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css error class to use for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssErrorStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css error style definitions for element to use</td> - - </tr> - - <tr> - - <td align="left" valign="top">cssStyle</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css style definitions for element to use</td> - - </tr> - - <tr> - - <td align="left" valign="top">disabled</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html disabled attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">errorPosition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define error position of form element (top|bottom)</td> - - </tr> - - <tr> - - <td align="left" valign="top">for</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top"> HTML for attribute</td> - - </tr> - - <tr> - - <td align="left" valign="top">id</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">HTML id attribute</td> - - </tr> - - <tr> - - <td align="left" valign="top">javascriptTooltip</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">Use JavaScript to generate tooltips</td> - - </tr> - - <tr> - - <td align="left" valign="top">key</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the key (name, value, label) for this particular component</td> - - </tr> - - <tr> - - <td align="left" valign="top">label</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Label expression used for rendering an element specific label</td> - - </tr> - - <tr> - - <td align="left" valign="top">labelSeparator</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">:</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">String that will be appended to the label</td> - - </tr> - - <tr> - - <td align="left" valign="top">labelposition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define label position of form element (top/left)</td> - - </tr> - - <tr> - - <td align="left" valign="top">name</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The name to set for element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onblur</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top"> Set the html onblur attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onchange</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onchange attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onclick</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onclick attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">ondblclick</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html ondblclick attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onfocus</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onfocus attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeydown</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeydown attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeypress</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeypress attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onkeyup</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onkeyup attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmousedown</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmousedown attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmousemove</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmousemove attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseout</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseout attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseover</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseover attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onmouseup</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onmouseup attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">onselect</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html onselect attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">requiredLabel</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">If set to true, the rendered element will indicate that input is required</td> - - </tr> - - <tr> - - <td align="left" valign="top">requiredPosition</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Define required position of required form element (left|right)</td> - - </tr> - - <tr> - - <td align="left" valign="top">style</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The css style definitions for element to use - it's an alias of cssStyle attribute.</td> - - </tr> - - <tr> - - <td align="left" valign="top">tabindex</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html tabindex attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">template</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The template (other than default) to use for rendering the element</td> - - </tr> - - <tr> - - <td align="left" valign="top">templateDir</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The template directory.</td> - - </tr> - - <tr> - - <td align="left" valign="top">theme</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The theme (other than default) to use for rendering the element</td> - - </tr> - - <tr> - - <td align="left" valign="top">title</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the html title attribute on rendered html element</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltip</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Set the tooltip of this particular component</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipConfig</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Deprecated. Use individual tooltip configuration attributes instead.</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipCssClass</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">StrutsTTClassic</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">CSS class applied to JavaScrip tooltips</td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipDelay</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Classic</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Delay in milliseconds, before showing JavaScript tooltips </td> - - </tr> - - <tr> - - <td align="left" valign="top">tooltipIconPath</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Icon path used for image that will have the tooltip</td> - - </tr> - - <tr> - - <td align="left" valign="top">value</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top"></td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Preset the value of input element.</td> - - </tr> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - </table> +<h2 id="description">Description</h2> -</p> +<p>Renders an HTML LABEL that will allow you to output label:name combination that has the same format treatment +as the rest of your UI controls.</p> -<p><strong>Examples</strong></p> +<p>404: Not Found</p> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><s:label</span> <span class="na">key=</span><span class="s">"userName"</span> <span class="nt">/></span> +<h2 id="attributes">Attributes</h2> -</code></pre></div></div> +<p>404: Not Found</p> -<pre><code class="language-none"> <p>In this example, a label is rendered. The label is retrieved from a ResourceBundle via the key attribute - giving you an output of 'User Name: Ford.Prefect'. Assuming that i18n message userName corresponds - to 'User Name' and the action's getUserName() method returns 'Ford.Prefect'</p> +<h2 id="examples">Examples</h2> +<pre><code class="language-jsp"><s:label key="userName" /> </code></pre> +<p>In this example, a label is rendered. The label is retrieved from a ResourceBundle via the key attribute giving +you an output of ‘User Name: Ford.Prefect’. Assuming that i18n message userName corresponds to <em>User Name</em> +and the action’s <code class="highlighter-rouge">getUserName()</code> method returns <em>Ford.Prefect</em>.</p> </section> </article> diff --git a/content/tag-developers/merge-tag.html b/content/tag-developers/merge-tag.html index f4c7ec4..62dc6cb 100644 --- a/content/tag-developers/merge-tag.html +++ b/content/tag-developers/merge-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>merge tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,149 +127,92 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/merge-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="merge">merge</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p><strong>Description</strong></p> - -<p> <p>Component for MergeIteratorTag, which job is to merge iterators and successive - call to the merged iterator will cause each merge iterator to have a chance to - expose its element, subsequently next call will allow the next iterator to expose - its element. Once the last iterator is done exposing its element, the first iterator - is allowed to do so again (unless it is exhausted of entries).</p> - - <p>Internally the task are delegated to MergeIteratorFilter</p> - - <p>Example if there are 3 lists being merged, each list have 3 entries, the following will - be the logic.</p> - <ol> - <li>Display first element of the first list</li> - <li>Display first element of the second list</li> - <li>Display first element of the third list</li> - <li>Display second element of the first list</li> - <li>Display second element of the second list</li> - <li>Display second element of the third list</li> - <li>Display third element of the first list</li> - <li>Display thrid element of the second list</li> - <li>Display third element of the thrid list</li> - </ol> -</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> - - <tr> +<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - <td align="left" valign="top">var</td> +<h2 id="description">Description</h2> - <td align="left" valign="top">false</td> +<p>Component for MergeIteratorTag, which job is to merge iterators and successive call to the merged iterator will cause +each merge iterator to have a chance to expose its element, subsequently next call will allow the next iterator to expose +its element. Once the last iterator is done exposing its element, the first iterator is allowed to do so again (unless +it is exhausted of entries).</p> - <td align="left" valign="top"></td> +<p>Internally the task are delegated to <code class="highlighter-rouge">MergeIteratorFilter</code>.</p> - <td align="left" valign="top">false</td> +<p>Example if there are 3 lists being merged, each list have 3 entries, the following will be the logic.</p> - <td align="left" valign="top">String</td> +<ol> + <li>Display first element of the first list</li> + <li>Display first element of the second list</li> + <li>Display first element of the third list</li> + <li>Display second element of the first list<</li> + <li>Display second element of the second list</li> + <li>Display second element of the third list</li> + <li>Display third element of the first list<</li> + <li>Display third element of the second list</li> + <li>Display third element of the third list</li> +</ol> - <td align="left" valign="top">The name where the resultant merged iterator will be stored in the stack's context</td> +<p>404: Not Found</p> - </tr> +<h2 id="attributes">Attributes</h2> - </table> +<p>404: Not Found</p> -</p> +<h2 id="examples">Examples</h2> -<p><strong>Examples</strong></p> - -<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="kd">public</span> <span class="kd">class</span> <span class="nc">MergeIteratorTagAction</span> <span class="kd">extends</span> <span class="n">ActionSupport</span> <span class="o">{</span> - - <span class="kd">private</span> <span class="n">List</span> <span class="n">myList1</span><span class="o">;</span> - <span class="kd">private</span> <span class="n">List</span> <span class="n">myList2</span><span class="o">;</span> - <span class="kd">private</span> <span class="n">List</span> <span class="n">myList3</span><span class="o">;</span> - - <span class="kd">public</span> <span class="n">List</span> <span class="nf">getMyList1</span><span class="o">()</span> <span class="o">{</span> - <span class="k">return</span> <span class="n">myList1</span><span class="o">;</span> - <span class="o">}</span> - - <span class="kd">public</span> <span class="n">List</span> <span class="nf">getMyList2</span><span class="o">()</span> <span class="o">{</span> - <span class="k">return</span> <span class="n">myList2</span><span class="o">;</span> - <span class="o">}</span> - - <span class="kd">public</span> <span class="n">List</span> <span class="nf">getMyList3</span><span class="o">()</span> <span class="o">{</span> - <span class="k">return</span> <span class="n">myList3</span><span class="o">;</span> - <span class="o">}</span> - - - <span class="kd">public</span> <span class="n">String</span> <span class="nf">execute</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> - - <span class="n">myList1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o">();</span> - <span class="n">myList1</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"1"</span><span class="o">);</span> - <span class="n">myList1</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"2"</span><span class="o">);</span> - <span class="n">myList1</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"3"</span><span class="o">);</span> - - <span class="n">myList2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o">();</span> - <span class="n">myList2</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"a"</span><span class="o">);</span> - <span class="n">myList2</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"b"</span><span class="o">);</span> - <span class="n">myList2</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"c"</span><span class="o">);</span> - - <span class="n">myList3</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o">();</span> - <span class="n">myList3</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"A"</span><span class="o">);</span> - <span class="n">myList3</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"B"</span><span class="o">);</span> - <span class="n">myList3</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"C"</span><span class="o">);</span> - - <span class="k">return</span> <span class="s">"done"</span><span class="o">;</span> - <span class="o">}</span> - <span class="o">}</span> - -</code></pre></div></div> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><s:merge</span> <span class="na">var=</span><span class="s">"myMergedIterator1"</span><span class="nt">></span> - <span class="nt"><s:param</span> <span class="na">value=</span><span class="s">"%{myList1}"</span> <span class="nt">/></span> - <span class="nt"><s:param</span> <span class="na">value=</span><span class="s">"%{myList2}"</span> <span class="nt">/></span> - <span class="nt"><s:param</span> <span class="na">value=</span><span class="s">"%{myList3}"</span> <span class="nt">/></span> - <span class="nt"></s:merge></span> - <span class="nt"><s:iterator</span> <span class="na">value=</span><span class="s">"%{#myMergedIterator1}"</span><span class="nt">></span> - <span class="nt"><s:property</span> <span class="nt">/></span> - <span class="nt"></s:iterator></span> +<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">MergeIteratorTagAction</span> <span class="kd">extends</span> <span class="n">ActionSupport</span> <span class="o">{</span> + <span class="kd">private</span> <span class="n">List</span> <span class="n">myList1</span><span class="o">;</span> + <span class="kd">private</span> <span class="n">List</span> <span class="n">myList2</span><span class="o">;</span> + <span class="kd">private</span> <span class="n">List</span> <span class="n">myList3</span><span class="o">;</span> + + <span class="kd">public</span> <span class="n">List</span> <span class="nf">getMyList1</span><span class="o">()</span> <span class="o">{</span> + <span class="k">return</span> <span class="n">myList1</span><span class="o">;</span> + <span class="o">}</span> + + <span class="kd">public</span> <span class="n">List</span> <span class="nf">getMyList2</span><span class="o">()</span> <span class="o">{</span> + <span class="k">return</span> <span class="n">myList2</span><span class="o">;</span> + <span class="o">}</span> + + <span class="kd">public</span> <span class="n">List</span> <span class="nf">getMyList3</span><span class="o">()</span> <span class="o">{</span> + <span class="k">return</span> <span class="n">myList3</span><span class="o">;</span> + <span class="o">}</span> + + + <span class="kd">public</span> <span class="n">String</span> <span class="nf">execute</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span> + <span class="n">myList1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o">();</span> + <span class="n">myList1</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"1"</span><span class="o">);</span> + <span class="n">myList1</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"2"</span><span class="o">);</span> + <span class="n">myList1</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"3"</span><span class="o">);</span> + + <span class="n">myList2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o">();</span> + <span class="n">myList2</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"a"</span><span class="o">);</span> + <span class="n">myList2</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"b"</span><span class="o">);</span> + <span class="n">myList2</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"c"</span><span class="o">);</span> + + <span class="n">myList3</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o">();</span> + <span class="n">myList3</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"A"</span><span class="o">);</span> + <span class="n">myList3</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"B"</span><span class="o">);</span> + <span class="n">myList3</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="s">"C"</span><span class="o">);</span> + + <span class="k">return</span> <span class="s">"done"</span><span class="o">;</span> + <span class="o">}</span> +<span class="o">}</span> </code></pre></div></div> +<pre><code class="language-jsp"><s:merge var="myMergedIterator1"> + <s:param value="%{myList1}" /> + <s:param value="%{myList2}" /> + <s:param value="%{myList3}" /> +</s:merge> +<s:iterator value="%{#myMergedIterator1}"> + <s:property /> +</s:iterator> +</code></pre> </section> </article> diff --git a/content/tag-developers/optgroup-tag.html b/content/tag-developers/optgroup-tag.html index f74fd16..819fbf6 100644 --- a/content/tag-developers/optgroup-tag.html +++ b/content/tag-developers/optgroup-tag.html @@ -7,7 +7,7 @@ <meta http-equiv="Content-Language" content="en"/> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> - <title>Tag Developers Guide</title> + <title>optgroup tag</title> <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> @@ -127,162 +127,36 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/optgroup-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> + <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> + <h1 id="optgroup">optgroup</h1> -<p>Please make sure you have read the <a href="tag-syntax.html">Tag Syntax</a> document and understand how tag attribute syntax works.</p> - -<table> - <tbody> - <tr> - </tr> - </tbody> -</table> - -<p><strong>Description</strong></p> - -<p> <p> - Create a optgroup component which needs to resides within a select tag. - </p> -</p> - -<p> <p> - This component is to be used within a Select component. - </p> - -</p> - -<p><strong>Parameters</strong></p> - -<p> <table width="100%"> - - <tr> - - <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> - - </tr> - - <tr> - - <td colspan="6"> </td> - - </tr> - - <tr> - - <th align="left" valign="top"><h4>Name</h4></th> - - <th align="left" valign="top"><h4>Required</h4></th> - - <th align="left" valign="top"><h4>Default</h4></th> - - <th align="left" valign="top"><h4>Evaluated</h4></th> - - <th align="left" valign="top"><h4>Type</h4></th> - - <th align="left" valign="top"><h4>Description</h4></th> - - </tr> ... 11486 lines suppressed ...