Java Doc for StrutsLinkTool.java in  » Template-Engine » Velocity » org » apache » velocity » tools » struts » Java Source Code / Java DocumentationJava Source Code and Java Documentation

View tool to work with URI links in Struts.

 Template example(s):
 <a href="$link.action.update">update something</a>
 #set( $base = $link.forward.MyPage.anchor('view') )
 <a href="$base.param('select','this')">view this</a>
 <a href="$base.param('select','that')">view that</a>
 Toolbox configuration:
 <tool>
 <key>link</key>
 <scope>request</scope>
 <class>org.apache.velocity.tools.struts.StrutsLinkTool</class>
 </tool>
 

This tool should only be used in the request scope.

This exists to enable a simplified syntax for using this tool in a template.

Returns a copy of the link with the given action name converted into a server-relative URI reference.

Returns a copy of the link with the given global forward name converted into a server-relative URI reference.

This exists to enable a simplified syntax for using this tool in a template. Now, users can do $link.action.saveFoo instead of $link.setAction('saveFoo') and $link.forward.profile instead of $link.setForward('profile'). Neat, eh? :)

Returns a copy of the link with the given action name converted into a server-relative URI reference. This method does not check if the specified action really is defined. This method will overwrite any previous URI reference settings but will copy the query string.

Returns a copy of the link with the given global forward name converted into a server-relative URI reference. If the parameter does not map to an existing global forward name, null is returned. This method will overwrite any previous URI reference settings but will copy the query string.