Java Doc for URL.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » components » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This tag is used to create a URL.

You can use the "param" tag inside the body to provide additional request parameters.

By default request parameters will be separated using escaped ampersands (i.e., &amp;). This is necessary for XHTML compliance, however, when using the URL generated by this tag with the <s:property> tag, the escapeAmp attribute should be used to disable ampersand escaping.

When includeParams is 'all' or 'get', the parameter defined in param tag will take precedence and will not be overriden if they exists in the parameter submitted. For example, in Example 3 below, if there is a id parameter in the url where the page this tag is included like http://://editUser.action?id=3333&name=John the generated url will be http://:/context>/editUser.action?id=22&name=John cause the parameter defined in the param tag will take precedence.

• action (String) - (value or action choose either one, if both exist value takes precedence) action's name (alias)
• value (String) - (value or action choose either one, if both exist value takes precedence) the url itself
• scheme (String) - http scheme (http, https) defaults to the scheme this request is in
• namespace - action's namespace
• method (String) - action's method name, defaults to 'execute'
• encode (Boolean) - url encode the generated url. Defaults to 'true'.
• includeParams (String) - The includeParams attribute may have the value 'none', 'get' or 'all'. Defaults to 'get'. none - include no parameters in the URL get - include only GET parameters in the URL (default) all - include both GET and POST parameters in the URL
• includeContext (Boolean) - Specifies whether to include the web app context path. Defaults to 'true'.
• escapeAmp (Boolean) - Specifies whether to escape ampersand (&) to (&amp;) or not. Defaults to 'true'.
• portletMode (String) - The resulting portlet mode.
• windowState (String) - The resulting portlet window state.
• portletUrlType (String) - Specifies if this should be a portlet render or action URL.
• forceAddSchemeHostAndPort (Boolean) - Specifies whether to force the addition of scheme, host and port or not.

Examples

 
 <-- 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>
 
 

• parameter from the current request (least priority)
• parameter form the value attribute (more priority)
• parameter from the param tag (most priority)