Please make sure you have read the Tag Syntax document and understand how tag attribute syntax works.
|
The id attribute is deprecated in Struts 2.1.x, and has been replaced by the var attribute.
|
Description
{% comment %}start snippet id=javadoc|javadoc=true|url=org.apache.struts2.components.URL {% endcomment %}
Setting a default value for includeParams
The property struts.url.includeParams can be used to set the default value of the includeParams attribute.
Setting the default value of includeParams
<struts> ... <constant name="struts.url.includeParams" value="none" /> ... </struts>
See Constant Configuration for further information.
As of Struts 2.1.3 the includeParams constant defaults to “none”.
Parameters
{% comment %}start snippet id=tagattributes|javadoc=false|url=struts2-tags/url.html {% endcomment %}
<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">action</td> <td align="left" valign="top">false</td> <td 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 action to generate the URL for, if not using value</td> </tr> <tr> <td align="left" valign="top">anchor</td> <td align="left" valign="top">false</td> <td 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 anchor for this URL</td> </tr> <tr> <td align="left" valign="top">encode</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 encode parameters</td> </tr> <tr> <td align="left" valign="top">escapeAmp</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">Specifies whether to escape ampersand (&) to (&amp;) or not</td> </tr> <tr> <td align="left" valign="top">forceAddSchemeHostAndPort</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">Specifies whether to force the addition of scheme, host and port or not</td> </tr> <tr> <td align="left" valign="top">includeContext</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 actual context should be included in URL</td> </tr> <tr> <td align="left" valign="top">includeParams</td> <td align="left" valign="top">false</td> <td align="left" valign="top">none</td> <td align="left" valign="top">false</td> <td align="left" valign="top">String</td> <td align="left" valign="top">The includeParams attribute may have the value 'none', 'get' or 'all'</td> </tr> <tr> <td align="left" valign="top">method</td> <td align="left" valign="top">false</td> <td 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 method of action to use</td> </tr> <tr> <td align="left" valign="top">namespace</td> <td align="left" valign="top">false</td> <td 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 namespace to use</td> </tr> <tr> <td align="left" valign="top">portletMode</td> <td align="left" valign="top">false</td> <td 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 resulting portlet mode</td> </tr> <tr> <td align="left" valign="top">portletUrlType</td> <td align="left" valign="top">false</td> <td align="left" valign="top"></td> <td align="left" valign="top">false</td> <td align="left" valign="top">String</td> <td align="left" valign="top">Specifies if this should be a portlet render or action URL. Default is "render". To create an action URL, use "action".</td> </tr> <tr> <td align="left" valign="top">scheme</td> <td align="left" valign="top">false</td> <td 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 scheme attribute</td> </tr> <tr> <td align="left" valign="top">value</td> <td align="left" valign="top">false</td> <td align="left" valign="top"></td> <td align="left" valign="top">false</td> <td align="left" valign="top">String</td> <td align="left" valign="top">The target value to use, if not using action</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> <tr> <td align="left" valign="top">windowState</td> <td align="left" valign="top">false</td> <td 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 resulting portlet window state</td> </tr> </table>
Examples
{% comment %}start snippet id=example|lang=xml|javadoc=true|url=org.apache.struts2.components.URL {% endcomment %}
<!-- Example 1 --> <s:url value="editGadget.action"> <s:param name="id" value="%{selected}" /> </s:url> <!-- Example 2 --> <s:url action="editGadget"> <s:param name="id" value="%{selected}" /> </s:url> <!-- Example 3--> <s:url includeParams="get"> <s:param name="id" value="%{'22'}" /> </s:url>
{% comment %}end snippet id=example|lang=xml|javadoc=true|url=org.apache.struts2.components.URL {% endcomment %}