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 f7ae438 Updates stage by Jenkins f7ae438 is described below commit f7ae43849e850701b82dd2e4be4d5031e807cf70 Author: jenkins <bui...@apache.org> AuthorDate: Thu Feb 20 07:58:06 2020 +0000 Updates stage by Jenkins --- content/tag-developers/a-tag.html | 2 +- content/tag-developers/action-tag.html | 199 +--- content/tag-developers/actionerror-tag.html | 766 +------------ content/tag-developers/actionmessage-tag.html | 766 +------------ content/tag-developers/append-tag.html | 110 +- content/tag-developers/bean-tag.html | 130 +-- content/tag-developers/checkbox-tag.html | 774 +------------ content/tag-developers/checkboxlist-tag.html | 870 +------------- content/tag-developers/combobox-tag.html | 998 +--------------- content/tag-developers/component-tag.html | 799 +------------ content/tag-developers/date-tag.html | 306 ++--- content/tag-developers/datetextfield-tag.html | 763 +------------ content/tag-developers/debug-tag.html | 6 +- content/tag-developers/doubleselect-tag.html | 1498 +------------------------ content/tag-developers/else-tag.html | 81 +- content/tag-developers/elseif-tag.html | 97 +- content/tag-developers/fielderror-tag.html | 825 +------------- content/tag-developers/file-tag.html | 784 +------------ content/tag-developers/form-tag.html | 1019 +---------------- 19 files changed, 475 insertions(+), 10318 deletions(-) diff --git a/content/tag-developers/a-tag.html b/content/tag-developers/a-tag.html index 4ff9ab9..0c78365 100644 --- a/content/tag-developers/a-tag.html +++ b/content/tag-developers/a-tag.html @@ -138,7 +138,7 @@ <p>A tag that creates a HTML <code class="highlighter-rouge"><a>.</code> This tag supports the same attributes as the <code class="highlighter-rouge">url</code> tag, including nested parameters using the <code class="highlighter-rouge">param</code> tag.</p> -<h2 id="parameters">Parameters</h2> +<h2 id="attributes">Attributes</h2> <p>404: Not Found</p> diff --git a/content/tag-developers/action-tag.html b/content/tag-developers/action-tag.html index e2ed87b..7768ba5 100644 --- a/content/tag-developers/action-tag.html +++ b/content/tag-developers/action-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>action 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,18 +127,17 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/action-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="action">action</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> <h2 id="description">Description</h2> -<p> <p>This tag enables developers to call actions directly from a JSP page by specifying the action name and an optional - namespace. The body content of the tag is used to render the results from the Action. Any result processor defined - for this action in struts.xml will be ignored, <i>unless</i> the executeResult parameter is specified.</p> -</p> +<p>404: Not Found</p> -<p>Parameters can be passed to the action using nested <a href="param-tag.html">param</a> tags.</p> +<p>Parameters can be passed to the action using nested <a href="param-tag">param</a> tags.</p> <h2 id="placement-in-context">Placement in context</h2> @@ -152,158 +151,14 @@ the action cannot be accessed, For example:</p> </code></pre> <p>Will print:</p> +<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Is "myAction" null inside the tag? true -<p>Is “myAction” null inside the tag? true</p> - -<p>Is “myAction” null outside the tag? false</p> - -<h2 id="parameters">Parameters</h2> - -<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">executeResult</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">Whether the result of this action (probably a view) should be executed/rendered</td> - - </tr> - - <tr> - - <td align="left" valign="top">flush</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">true</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">Whether the writer should be flush upon end of action component tag, default to true</td> - - </tr> - - <tr> - - <td align="left" valign="top">ignoreContextParams</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">Whether the request parameters are to be included when the action is invoked</td> - - </tr> - - <tr> - - <td align="left" valign="top">name</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">Name of the action to be executed (without the extension suffix eg. .action)</td> - - </tr> - - <tr> - - <td align="left" valign="top">namespace</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">namespace from where tag is used</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Namespace for action to call</td> - - </tr> - - <tr> - - <td align="left" valign="top">rethrowException</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">Whether an exception should be rethrown, if the target action throws an exception</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> +Is "myAction" null outside the tag? false +</code></pre></div></div> - </table> +<h2 id="attributes">Attributes</h2> -</p> +<p>404: Not Found</p> <h2 id="examples">Examples</h2> @@ -321,7 +176,7 @@ the action cannot be accessed, For example:</p> </code></pre></div></div> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><xwork></span> +<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><struts></span> .... <span class="nt"><action</span> <span class="na">name=</span><span class="s">"actionTagAction1"</span> <span class="na">class=</span><span class="s">"tmjee.testing.ActionTagAction"</span><span class="nt">></span> <span class="nt"><result</span> <span class="na">name=</span><span class="s">"done"</span><span class="nt">></span>success.jsp<span class="nt"></result></span> @@ -330,25 +185,25 @@ the action cannot be accessed, For example:</p> <span class="nt"><result</span> <span class="na">name=</span><span class="s">"done"</span><span class="nt">></span>success.jsp<span class="nt"></result></span> <span class="nt"></action></span> .... - <span class="nt"></xwork></span> - + <span class="nt"></struts></span> </code></pre></div></div> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><span></span>The following action tag will execute result and include it in this page<span class="nt"></span></span> - <span class="nt"><br></span> - <span class="nt"><s:action</span> <span class="na">name=</span><span class="s">"actionTagAction"</span> <span class="na">executeResult=</span><span class="s">"true"</span> <span class="nt">/></span> - <span class="nt"><br></span> - <span class="nt"><span></span>The following action tag will do the same as above, but invokes method specialMethod in action<span class="nt"></span></span> - <span class="nt"><br></span> - <span class="nt"><s:action</span> <span class="na">name=</span><span class="s">"actionTagAction!specialMethod"</span> <span class="na">executeResult=</span><span class="s">"true"</span> <span class="nt">/></span> - <span class="nt"><br></span> - <span class="nt"><span></span>The following action tag will not execute result, but put a String in request scope - under an id "stringByAction" which will be retrieved using property tag<span class="nt"></span></span> - <span class="nt"><s:action</span> <span class="na">name=</span><span class="s">"actionTagAction!default"</span> <span class="na">executeResult=</span><span class="s">"false"</span> <span class="nt">/></span> - <span class="nt"><s:property</span> <span class="na">value=</span><span class="s">"#attr.stringByAction"</span> <span class="nt">/></span> +<p>The following action tag will execute result and include it in this page</p> -</code></pre></div></div> +<pre><code class="language-jsp"> <s:action name="actionTagAction" executeResult="true" /> +</code></pre> +<p>The following action tag will do the same as above, but invokes method specialMethod in action</span></p> + +<pre><code class="language-jsp"> <s:action name="actionTagAction!specialMethod" executeResult="true" /> +</code></pre> + +<p>The following action tag will not execute result, but put a String in request scope under an id <code class="highlighter-rouge">stringByAction</code> which +will be retrieved using property tag</span></p> + +<pre><code class="language-jsp"> <s:action name="actionTagAction!default" executeResult="false" /> + <s:property value="#attr.stringByAction" /> +</code></pre> </section> </article> diff --git a/content/tag-developers/actionerror-tag.html b/content/tag-developers/actionerror-tag.html index bd8b3f0..8cb37b2 100644 --- a/content/tag-developers/actionerror-tag.html +++ b/content/tag-developers/actionerror-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>actionerror 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,768 +127,30 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/actionerror-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="actionerror">actionerror</h1> -<h2 id="description">Description</h2> - -<p> - Render action errors if they exists the specific layout of the rendering depends on - the theme itself. Empty (null or blank string) errors will not be printed. The action error - strings will be html escaped by default. - -</p> - -<h2 id="parameters">Parameters</h2> - -<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">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">escape</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">true</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top"> Whether to escape HTML</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> +<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> - - <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> +<h2 id="description">Description</h2> - <td align="left" valign="top">Preset the value of input element.</td> +<p>Render action errors if they exists the specific layout of the rendering depends on the theme itself. Empty (null or +blank string) errors will not be printed. The action error strings will be html escaped by default.</p> - </tr> +<p>404: Not Found</p> - </table> +<h2 id="attributes">Attributes</h2> -</p> +<p>404: Not Found</p> <h2 id="examples">Examples</h2> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - <span class="nt"><s:actionerror</span> <span class="nt">/></span> - <span class="nt"><s:form</span> <span class="err">....</span> <span class="nt">></span> +<pre><code class="language-jsp"> <s:actionerror /> + <s:form .... > .... - <span class="nt"></s:form></span> - - -</code></pre></div></div> - + </s:form> +</code></pre> </section> </article> diff --git a/content/tag-developers/actionmessage-tag.html b/content/tag-developers/actionmessage-tag.html index 8294be3..8570f06 100644 --- a/content/tag-developers/actionmessage-tag.html +++ b/content/tag-developers/actionmessage-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>actionmessage 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,766 +127,30 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/actionmessage-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="actionmessage">actionmessage</h1> -<p><strong>Description</strong></p> - -<p> - Render action messages if they exists, specific rendering layout depends on the - theme itself. Empty (null or blank string) messages will not be printed. The action message - strings will be html escaped by default. - -</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">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">escape</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">true</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">Boolean</td> - - <td align="left" valign="top">Whether to escape HTML</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> +<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">Set the html onfocus attribute on rendered html element</td> +<h2 id="description">Description</h2> - </tr> +<p>Render action messages if they exists, specific rendering layout depends on the theme itself. Empty (null or blank +string) messages will not be printed. The action message strings will be html escaped by default.</p> - <tr> +<p>404: Not Found</p> - <td align="left" valign="top">onkeydown</td> +<h2 id="attributes">Attributes</h2> - <td align="left" valign="top">false</td> +<p>404: Not Found</p> - <td align="left" valign="top"></td> +<h2 id="examples">Examples</h2> - <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> - - </table> - -</p> - -<p><strong>Examples</strong></p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><s:actionmessage</span> <span class="nt">/></span> - <span class="nt"><s:form</span> <span class="err">....</span> <span class="nt">></span> +<pre><code class="language-jsp"> <s:actionmessage /> + <s:form .... > .... - <span class="nt"></s:form></span> - -</code></pre></div></div> - + </s:form> +</code></pre> </section> </article> diff --git a/content/tag-developers/append-tag.html b/content/tag-developers/append-tag.html index 9e78a24..14711a1 100644 --- a/content/tag-developers/append-tag.html +++ b/content/tag-developers/append-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>append 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,83 +127,37 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/append-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="append">append</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> <h2 id="description">Description</h2> -<p> <p>Component for AppendIteratorTag, which jobs is to append iterators to form an - appended iterator whereby entries goes from one iterator to another after each - respective iterator is exhausted of entries.</p> - - <p>For example, if there are 3 iterator appended (each iterator has 3 entries), - the following will be how the appended iterator entries will be arranged:</p> - - <ol> - <li>First Entry of the First Iterator</li> - <li>Second Entry of the First Iterator</li> - <li>Third Entry of the First Iterator</li> - <li>First Entry of the Second Iterator</li> - <li>Second Entry of the Second Iterator</li> - <li>Third Entry of the Second Iterator</li> - <li>First Entry of the Third Iterator</li> - <li>Second Entry of the Third Iterator</li> - <li>Third Entry of the Third ITerator</li> - </ol> -</p> - -<h2 id="parameters">Parameters</h2> - -<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> +<p>Component for AppendIteratorTag, which jobs is to append iterators to form an appended iterator whereby entries goes +from one iterator to another after each respective iterator is exhausted of entries.</p> - <th align="left" valign="top"><h4>Default</h4></th> +<p>For example, if there are 3 iterator appended (each iterator has 3 entries the following will be how the appended +iterator entries will be arranged:</p> - <th align="left" valign="top"><h4>Evaluated</h4></th> +<ol> + <li>First Entry of the First Iterator</li> + <li>Second Entry of the First Iterator</li> + <li>Third Entry of the First Iterator</li> + <li>First Entry of the Second Iterator</li> + <li>Second Entry of the Second Iterator</li> + <li>Third Entry of the Second Iterator</li> + <li>First Entry of the Third Iterator</li> + <li>Second Entry of the Third Iterator</li> + <li>Third Entry of the Third Iterator</li> +</ol> - <th align="left" valign="top"><h4>Type</h4></th> +<p>404: Not Found</p> - <th align="left" valign="top"><h4>Description</h4></th> +<h2 id="attributes">Attributes</h2> - </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">The name of which if supplied will have the resultant appended iterator stored under in the stack's context</td> - - </tr> - - </table> - -</p> +<p>404: Not Found</p> <h2 id="example">Example</h2> @@ -241,17 +195,15 @@ </code></pre></div></div> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><s:append</span> <span class="na">var=</span><span class="s">"myAppendIterator"</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:append></span> - <span class="nt"><s:iterator</span> <span class="na">value=</span><span class="s">"%{#myAppendIterator}"</span><span class="nt">></span> - <span class="nt"><s:property</span> <span class="nt">/></span> - <span class="nt"></s:iterator></span> - -</code></pre></div></div> - +<pre><code class="language-jsp"> <s:append var="myAppendIterator"> + <s:param value="%{myList1}" /> + <s:param value="%{myList2}" /> + <s:param value="%{myList3}" /> + </s:append> + <s:iterator value="%{#myAppendIterator}"> + <s:property /> + </s:iterator> +</code></pre> </section> </article> diff --git a/content/tag-developers/bean-tag.html b/content/tag-developers/bean-tag.html index 7288ff2..4d1ac74 100644 --- a/content/tag-developers/bean-tag.html +++ b/content/tag-developers/bean-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>bean 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,123 +127,63 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/bean-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="bean">bean</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> <h2 id="description">Description</h2> -<p> <p>Instantiates a class that conforms to the JavaBeans specification. This tag has a body which can contain - a number of {@link Param} elements to set any mutator methods on that class.</p> - - <p>If the var attribute is set on the BeanTag, it will place the instantiated bean into the - stack's Context.</p> - -</p> - -<h2 id="parameters">Parameters</h2> - -<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>Instantiates a class that conforms to the JavaBeans specification. This tag has a body which can contain a number +of <a href="param-tag">param</a> elements to set any mutator methods on that class.</p> - <td align="left" valign="top">name</td> +<p>If the var attribute is set on the BeanTag, it will place the instantiated bean into the stack’s Context.</p> - <td align="left" valign="top"><strong>true</strong></td> +<p>404: Not Found</p> - <td align="left" valign="top"></td> +<h2 id="attributes">Attributes</h2> - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The class name of the bean to be instantiated (must respect JavaBean specification)</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>404: Not Found</p> <h2 id="examples">Examples</h2> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><--</span> <span class="err">in</span> <span class="err">freemarker</span> <span class="err">form</span> <span class="err">--</span><span class="nt">></span> - [@s.bean name="org.apache.struts2.example.counter.SimpleCounter" var="counter"] +<h3 id="in-freemarker-form">in freemarker form</h3> + +<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> [@s.bean name="org.apache.struts2.example.counter.SimpleCounter" var="counter"] [s:param name="foo" value="BAR"/] The value of foo is : [s:property value="foo"/], when inside the bean tag. [/s:bean] +</code></pre></div></div> - <span class="nt"><--</span> <span class="err">in</span> <span class="err">jsp</span> <span class="err">form</span> <span class="err">--</span><span class="nt">></span> - <span class="nt"><s:bean</span> <span class="na">name=</span><span class="s">"org.apache.struts2.example.counter.SimpleCounter"</span> <span class="na">var=</span><span class="s">"counter"</span><span class="nt">></span> - <span class="nt"><s:param</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> - The value of foot is : <span class="nt"><s:property</span> <span class="na">value=</span><span class="s">"foo"</span><span class="nt">/></span>, when inside the bean tag <span class="nt"><br</span> <span class="nt">/></span> - <span class="nt"></s:bean></span> +<h3 id="in-jsp-form">in jsp form</h3> -</code></pre></div></div> +<pre><code class="language-jsp"> <s:bean name="org.apache.struts2.example.counter.SimpleCounter" var="counter"> + <s:param name="foo" value="BAR" /> + The value of foot is : <s:property value="foo"/>, when inside the bean tag <br /> + </s:bean> + +</code></pre> -<p> <p>This example instantiates a bean called SimpleCounter and sets the foo property (setFoo('BAR')). The - SimpleCounter object is then pushed onto the Valuestack, which means that we can call its accessor methods (getFoo()) - with the Property tag and get their values.</p> +<p>This example instantiates a bean called SimpleCounter and sets the foo property (<code class="highlighter-rouge">setFoo('BAR')</code>). The <code class="highlighter-rouge">SimpleCounter</code> +object is then pushed onto the <code class="highlighter-rouge">ValueStack</code>, which means that we can call its accessor methods (<code class="highlighter-rouge">getFoo()</code>) with +the property tag and get their values.</p> - <p>In the above example, the id has been set to a value of <i>counter</i>. This means that the SimpleCounter class - will be placed into the stack's context. You can access the SimpleCounter class using a Struts tag:</p> +<p>In the above example, the id has been set to a value of <code class="highlighter-rouge">counter</code>. This means that the <code class="highlighter-rouge">SimpleCounter</code> class +will be placed into the stack’s context. You can access the <code class="highlighter-rouge">SimpleCounter</code> class using a Struts tag:</p> - <pre> - <-- jsp form --> - <s:property value="#counter" /> +<h3 id="jsp-form">jsp form</h3> - <-- freemarker form --> - [s:property value="#counter.foo"/] - </pre> +<pre><code class="language-jsp"> <s:property value="#counter" /> +</code></pre> - <p>In the property tag example, the <i>#</i> tells Ognl to search the context for the SimpleCounter class which has - an id(key) of <i>counter</i></p> -</p> +<h3 id="freemarker-form">freemarker form</h3> + +<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> [s:property value="#counter.foo"/] +</code></pre></div></div> +<p>In the property tag example, the <i>#</i> tells Ognl to search the context for the SimpleCounter class which has +an <code class="highlighter-rouge">id(key)</code> of <code class="highlighter-rouge">counter</code>.</p> </section> </article> diff --git a/content/tag-developers/checkbox-tag.html b/content/tag-developers/checkbox-tag.html index f19fa2e..8b9a863 100644 --- a/content/tag-developers/checkbox-tag.html +++ b/content/tag-developers/checkbox-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>checkbox 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,777 +127,39 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/checkbox-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="checkbox">checkbox</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 checkbox, 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">fieldValue</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">true</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">The actual HTML value attribute of the checkbox.</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> +<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">String</td> +<h2 id="description">Description</h2> - <td align="left" valign="top">Set the html onfocus attribute on rendered html element</td> +<p>Renders an HTML input element of type checkbox, populated by the specified property from the ValueStack.</p> - </tr> +<p>404: Not Found</p> - <tr> +<h2 id="attributes">Attributes</h2> - <td align="left" valign="top">onkeydown</td> +<p>404: Not Found</p> - <td align="left" valign="top">false</td> +<h2 id="examples">Examples</h2> - <td align="left" valign="top"></td> +<h3 id="jsp">JSP</h3> - <td align="left" valign="top">false</td> +<pre><code class="language-jsp"><s:checkbox label="checkbox test" name="checkboxField1" value="aBoolean" fieldValue="true"/> +</code></pre> - <td align="left" valign="top">String</td> +<h3 id="velocity">Velocity</h3> - <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> - - </table> - -</p> - -<p><strong>Examples</strong></p> - -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> JSP: - <span class="nt"><s:checkbox</span> <span class="na">label=</span><span class="s">"checkbox test"</span> <span class="na">name=</span><span class="s">"checkboxField1"</span> <span class="na">value=</span><span class="s">"aBoolean"</span> <span class="na">fieldValue=</span><span class="s">"true"</span><span class="nt">/></span> - - Velocity: - #tag( Checkbox "label=checkbox test" "name=checkboxField1" "value=aBoolean" ) - - Resulting HTML (simple template, aBoolean == true): - <span class="nt"><input</span> <span class="na">type=</span><span class="s">"checkbox"</span> <span class="na">name=</span><span class="s">"checkboxField1"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="na">checked=</span><span class="s">"checked"</span> <span class="nt">/></span> +<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>#tag( Checkbox "label=checkbox test" "name=checkboxField1" "value=aBoolean" ) +</code></pre></div></div> +<h3 id="resulting-html-simple-template-aboolean--true">Resulting HTML (simple template, aBoolean == true):</h3> +<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">"checkbox"</span> <span class="na">name=</span><span class="s">"checkboxField1"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="na">checked=</span><span class="s">"checked"</span> <span class="nt">/></span> </code></pre></div></div> - </section> </article> diff --git a/content/tag-developers/checkboxlist-tag.html b/content/tag-developers/checkboxlist-tag.html index e79687c..40bf21a 100644 --- a/content/tag-developers/checkboxlist-tag.html +++ b/content/tag-developers/checkboxlist-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>checkboxlist 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,872 +127,30 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/checkboxlist-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="checkboxlist">checkboxlist</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>Note that the <code class="highlighter-rouge">listkey</code> and <code class="highlighter-rouge">listvalue</code> attribute will default to <code class="highlighter-rouge">"key"</code> and <code class="highlighter-rouge">"value"</code> -respectively only when the list attribute is evaluated to a Map or its descendant. -Everything else will result in <code class="highlighter-rouge">listkey</code> and <code class="highlighter-rouge">listvalue</code> to be null and not used.</p> +<p>Note that the <code class="highlighter-rouge">listkey</code> and <code class="highlighter-rouge">listvalue</code> attribute will default to <code class="highlighter-rouge">"key"</code> and <code class="highlighter-rouge">"value"</code> respectively only when +the list attribute is evaluated to a Map or its descendant. Everything else will result in <code class="highlighter-rouge">listkey</code> and <code class="highlighter-rouge">listvalue</code> +to be null and not used.</p> -<p><strong>Description</strong></p> +<h2 id="description">Description</h2> <p>Creates a series of checkboxes from a list. Setup is like <code class="highlighter-rouge"><s:select /></code> or <code class="highlighter-rouge"><s:radio /></code>, but creates checkbox tags.</p> -<p><strong>Parameters</strong></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">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">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">Set element name. Set Struts Action field to populate with selected list keys.</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>404: Not Found</p> - </tr> +<h2 id="attributes">Attributes</h2> -</table> +<p>404: Not Found</p> -<p><strong>Examples</strong></p> +<h2 id="examples">Examples</h2> -<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><s:checkboxlist</span> <span class="na">name=</span><span class="s">"foo"</span> <span class="na">list=</span><span class="s">"bar"</span><span class="nt">/></span> -</code></pre></div></div> +<pre><code class="language-jsp"> <s:checkboxlist name="foo" list="bar"/> +</code></pre> </section> </article> diff --git a/content/tag-developers/combobox-tag.html b/content/tag-developers/combobox-tag.html index 5f93e4d..393d1ad 100644 --- a/content/tag-developers/combobox-tag.html +++ b/content/tag-developers/combobox-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>combobox 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,973 +127,69 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/combobox-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="combobox">combobox</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> - The combo box is basically an HTML INPUT of type text and HTML SELECT grouped together to give you a combo box - functionality. You can place text in the INPUT control by using the SELECT control or type it in directly in - the text field. - </p> - - <p> - In this example, the SELECT will be populated from id=year attribute. Counter is itself an Iterator. It will - span from first to last. The population is done via javascript, and requires that this tag be surrounded by a - <form>. - </p> - - <p> - Note that unlike the <s:select /> tag, there is no ability to define the individual <option> tags' id attribute - or content separately. Each of these is simply populated from the toString() method of the list item. Presumably - this is because the select box isn't intended to actually submit useful data, but to assist the user in filling - out the text field. - </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">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">emptyOption</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">Decide if an empty option is to be inserted. Default false.</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">Set the header key for the header option.</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">Set the header value for the header option.</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">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 this is missing, the select widget is simply not displayed.</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">Set the key used to retrieve the option key.</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">Set the value used to retrieve the option value.</td> - - </tr> - - <tr> - - <td align="left" valign="top">maxLength</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">Deprecated. Use maxlength instead.</td> - - </tr> - - <tr> - - <td align="left" valign="top">maxlength</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">HTML maxlength attribute</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">readonly</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">Whether the input is readonly</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">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">Integer</td> - - <td align="left" valign="top">HTML size attribute</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">type</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">text</td> - - <td align="left" valign="top">false</td> - - <td align="left" valign="top">String</td> - - <td align="left" valign="top">Specifies the html5 type element to display. e.g. text, email, url</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>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> -</p> +<h2 id="description">Description</h2> +<p>The combo box is basically an HTML INPUT of type text and HTML SELECT grouped together to give you a combo box +functionality. You can place text in the INPUT control by using the SELECT control or type it in directly in +the text field.</p> -__Examples__ +<p>In this example, the SELECT will be populated from id=year attribute. Counter is itself an Iterator. It will +span from first to last. The population is done via javascript, and requires that this tag be surrounded by a</p> +<p>Note that unlike the <code class="highlighter-rouge"><s:select/></code> tag, there is no ability to define the individual <code class="highlighter-rouge"><option></code> tags’ id attribute +or content separately. Each of these is simply populated from the toString() method of the list item. Presumably +this is because the select box isn’t intended to actually submit useful data, but to assist the user in filling +out the text field.</p> +<p>404: Not Found</p> +<h2 id="attributes">Attributes</h2> +<p>404: Not Found</p> -```xml - JSP: - <-- Example One --> - <s:bean name="struts.util.Counter" var="year"> - <s:param name="first" value="text('firstBirthYear')" /> - <s:param name="last" value="2000" /> +<h2 id="examples">Examples</h2> - <s:combobox label="Birth year" size="6" maxlength="4" name="birthYear" list="#year" /> - </s:bean> +<h3 id="jsp">JSP:</h3> - <-- Example Two --> - <s:combobox label="My Favourite Fruit" name="myFavouriteFruit" list="{'apple','banana','grape','pear'}" headerKey="-1" headerValue="--- Please Select ---" emptyOption="true" value="banana" /> +<pre><code class="language-jsp"><-- Example One --> +<s:bean name="struts.util.Counter" var="year"> + <s:param name="first" value="text('firstBirthYear')"/> + <s:param name="last" value="2000"/> - <-- Example Two --> - <s:combobox label="My Favourite Color" name="myFavouriteColor" list="#{'red':'red','green':'green','blue':'blue'}" headerKey="-1" headerValue="--- Please Select ---" emptyOption="true" value="green" /> + <s:combobox label="Birth year" size="6" maxlength="4" name="birthYear" list="#year"/> +</s:bean> - Velocity: - #tag( ComboBox "label=Birth year" "size=6" "maxlength=4" "name=birthYear" "list=#year" ) +<-- Example Two --> +<s:combobox + label="My Favourite Fruit" + name="myFavouriteFruit" + list="{'apple','banana','grape','pear'}" + headerKey="-1" + headerValue="--- Please Select ---" + emptyOption="true" + value="banana" /> -``` +<-- Example Two --> +<s:combobox + label="My Favourite Color" + name="myFavouriteColor" + list="#{'red':'red','green':'green','blue':'blue'}" + headerKey="-1" + headerValue="--- Please Select ---" + emptyOption="true" + value="green" /> +</code></pre> +<h3 id="velocity">Velocity:</h3> -</option></p></form></p></p> +<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>#tag( ComboBox "label=Birth year" "size=6" "maxlength=4" "name=birthYear" "list=#year" ) +</code></pre></div></div> </section> </article> diff --git a/content/tag-developers/component-tag.html b/content/tag-developers/component-tag.html index c737ca9..7498ea8 100644 --- a/content/tag-developers/component-tag.html +++ b/content/tag-developers/component-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>component 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,12 +127,18 @@ <section class="col-md-12"> <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/component-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="component">component</h1> -<p><strong>Description</strong></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> + +<h2 id="description">Description</h2> <p>Renders an custom UI widget using the specified templates. Additional objects can be passed in to the template - using the <code class="highlighter-rouge">param</code> tags.</p> +using the <a href="param-tag">param</a> tags.</p> + +<p>404: Not Found</p> <h3 id="freemarker">Freemarker:</h3> @@ -143,7 +149,7 @@ <p>Objects provided can be retrieve from within the template via <code class="highlighter-rouge"><s:property value="%{parameters._paramname_}" /></code></p> <p>In the bottom JSP and Velocity samples, two parameters are being passed in to the component. From within the - component, they can be accessed as:</p> +component, they can be accessed as:</p> <h3 id="freemarker-1">Freemarker:</h3> @@ -152,791 +158,54 @@ <h3 id="jsp-1">JSP:</h3> <p><code class="highlighter-rouge"><s:property value="%{parameters.key1}" /></code> and <code class="highlighter-rouge"><s:property value="%{'parameters.key2'}" /></code> or - <code class="highlighter-rouge"><s:property value="%{parameters.get('key1')}" /></code> and <code class="highlighter-rouge"><s:property value="%{parameters.get('key2')}" /></code></p> +<code class="highlighter-rouge"><s:property value="%{parameters.get('key1')}" /></code> and <code class="highlighter-rouge"><s:property value="%{parameters.get('key2')}" /></code></p> <p>Currently, your custom UI components can be written in Velocity, JSP, or Freemarker, and the correct rendering - engine will be found based on file extension.</p> +engine will be found based on file extension.</p> -<p><strong>Remember:</strong> the value <code class="highlighter-rouge">params</code> will always be resolved against the ValueStack so if you mean to pass a - string literal to your component, make sure to wrap it in single quotes i.e. <code class="highlighter-rouge">value="'value1'"</code> (note the opening <code class="highlighter-rouge">"'</code> and closing <code class="highlighter-rouge">'"</code> otherwise, the value - stack will search for an Object on the stack with a method of <code class="highlighter-rouge">getValue1()</code>.</p> +<p><strong>Remember:</strong> the value <code class="highlighter-rouge">params</code> will always be resolved against the ValueStack so if you mean to pass a string literal +to your component, make sure to wrap it in single quotes i.e. <code class="highlighter-rouge">value="'value1'"</code> (note the opening <code class="highlighter-rouge">"'</code> and closing <code class="highlighter-rouge">'"</code> +otherwise, the value stack will search for an Object on the stack with a method of <code class="highlighter-rouge">getValue1()</code>.</p> ... 6442 lines suppressed ...