| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181) on Wed Oct 10 00:41:13 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>LinkTool (VelocityTools 3.0 API)</title> |
| <meta name="date" content="2018-10-10"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="LinkTool (VelocityTools 3.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/LinkTool.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/velocity/tools/view/JsonTool.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/velocity/tools/view/PagerTool.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/velocity/tools/view/LinkTool.html" target="_top">Frames</a></li> |
| <li><a href="LinkTool.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.velocity.tools.view</div> |
| <h2 title="Class LinkTool" class="title">Class LinkTool</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.SafeConfig</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.LinkTool</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.velocity.tools.view.LinkTool</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">LinkTool</span> |
| extends <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</a></pre> |
| <div class="block"><p>The LinkTool provides many methods to work with URIs and can help you: |
| <ul> |
| <li>construct full URIs (absolute or relative)</li> |
| <li>encode session ID into a URI</li> |
| <li>retrieve server, port and path info for the current request</li> |
| <li>reconstruct or alter the current request URI</li> |
| <li>and more..</li> |
| </ul> |
| |
| <p>The LinkTool is somewhat special in that nearly all public methods return |
| a new instance of LinkTool. This facilitates greatly the repeated use |
| of the LinkTool in Velocity and leads to an elegant syntax.</p> |
| |
| <p>Template example(s):</p><pre> |
| |
| #set( $base = $link.path('MyPage.vm').anchor('view') ) |
| <a href="$base.param('select','this')">this</a> |
| <a href="$base.param('select','that')">that</a> |
| |
| Toolbox configuration: |
| <tools> |
| <toolbox scope="request"> |
| <tool class="org.apache.velocity.tools.view.LinkTool" |
| forceRelative="true" includeRequestParams="true"/> |
| </toolbox> |
| </tools> |
| </pre> |
| |
| <p>This tool may only be used in the request scope.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>VelocityTools 2.0</dd> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Id: LinkTool.java 1842523 2018-10-01 17:27:15Z cbrisson $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:sidler@teamup.com">Gabe Sidler</a>, Nathan Bubna, Chris Schultz</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.velocity.tools.view.LinkTool">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#INCLUDE_REQUEST_PARAMS_KEY">INCLUDE_REQUEST_PARAMS_KEY</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#includeRequestParams">includeRequestParams</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected javax.servlet.http.HttpServletRequest</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#request">request</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected javax.servlet.http.HttpServletResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#response">response</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.generic.LinkTool"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.velocity.tools.generic.<a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</a></h3> |
| <code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#APPEND_PARAMS_KEY">APPEND_PARAMS_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#appendParams">appendParams</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#charset">charset</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#CHARSET_KEY">CHARSET_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#DEFAULT_CHARSET">DEFAULT_CHARSET</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#DEFAULT_SCHEME">DEFAULT_SCHEME</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#FORCE_RELATIVE_KEY">FORCE_RELATIVE_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#forceRelative">forceRelative</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#fragment">fragment</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#FRAGMENT_KEY">FRAGMENT_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#host">host</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#HOST_KEY">HOST_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#HTML_QUERY_DELIMITER">HTML_QUERY_DELIMITER</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#opaque">opaque</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#path">path</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#PATH_KEY">PATH_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#port">port</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#PORT_KEY">PORT_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#query">query</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#QUERY_KEY">QUERY_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#queryDelim">queryDelim</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#scheme">scheme</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#SCHEME_KEY">SCHEME_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#SECURE_SCHEME">SECURE_SCHEME</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#self">self</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#URI_KEY">URI_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#user">user</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#USER_KEY">USER_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#XHTML_MODE_KEY">XHTML_MODE_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#XHTML_QUERY_DELIMITER">XHTML_QUERY_DELIMITER</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.generic.SafeConfig"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.velocity.tools.generic.<a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</a></h3> |
| <code><a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOCK_CONFIG_KEY">LOCK_CONFIG_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#log">log</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOGGER_NAME_KEY">LOGGER_NAME_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#SAFE_MODE_KEY">SAFE_MODE_KEY</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#USE_CLASS_LOGGER_KEY">USE_CLASS_LOGGER_KEY</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#LinkTool--">LinkTool</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#addMissingRequestParams-java.lang.Object...-">addMissingRequestParams</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... ignoreThese)</code> |
| <div class="block">Adds all of the current request's parameters to this link's |
| "query data" except for those whose keys match any of the specified strings |
| or already have a value set for them in the current instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#addRequestParams-java.lang.Object...-">addRequestParams</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... butOnlyThese)</code> |
| <div class="block">Adds the specified parameters (if they exist) from the current |
| request to the query data of a copy of this instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#addRequestParamsExcept-java.lang.Object...-">addRequestParamsExcept</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... ignoreThese)</code> |
| <div class="block">Adds all of the current request's parameters to this link's |
| "query data" except for those whose keys match any of the specified strings.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#configure-org.apache.velocity.tools.generic.ValueParser-">configure</a></span>(<a href="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</a> props)</code> |
| <div class="block">Configuration</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#getContextPath--">getContextPath</a></span>()</code> |
| <div class="block">Initially, this returns the context path that addresses this web |
| application, e.g.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#getContextURL--">getContextURL</a></span>()</code> |
| <div class="block">Returns a URL that addresses the web application.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#getRequestPath--">getRequestPath</a></span>()</code> |
| <div class="block">Initially, this retrieves the path for the current |
| request regardless of |
| whether this is a direct request or an include by the |
| RequestDispatcher.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#isPathChanged--">isPathChanged</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#setFromRequest-javax.servlet.http.HttpServletRequest-">setFromRequest</a></span>(javax.servlet.http.HttpServletRequest request)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#setIncludeRequestParams-boolean-">setIncludeRequestParams</a></span>(boolean includeRequestParams)</code> |
| <div class="block">Controls whether or not this tool starts off with all parameters |
| from the last request automatically.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#toString--">toString</a></span>()</code> |
| <div class="block">Overrides to use response.encodeURL to get session id into URL |
| if sessions are used but cookies are not supported.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.generic.LinkTool"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.velocity.tools.generic.<a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</a></h3> |
| <code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#absolute--">absolute</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#absolute-java.lang.Object-">absolute</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#anchor-java.lang.Object-">anchor</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#append-java.lang.Object-">append</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#append-java.lang.Object-java.lang.Object-">append</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#appendAsArray-java.lang.StringBuilder-java.lang.Object-java.lang.Object:A-">appendAsArray</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#appendPath-java.lang.Object-">appendPath</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#appendQuery-java.lang.Object-">appendQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#combinePath-java.lang.String-java.lang.String-">combinePath</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#combineQuery-java.lang.String-java.lang.String-">combineQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#createURI--">createURI</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#decode-java.lang.Object-">decode</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#decodeQueryPercents-java.lang.String-">decodeQueryPercents</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#directory--">directory</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#duplicate--">duplicate</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#duplicate-boolean-">duplicate</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#encode-java.lang.Object-">encode</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getAnchor--">getAnchor</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getAppendParams--">getAppendParams</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getBaseRef--">getBaseRef</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getCharacterEncoding--">getCharacterEncoding</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getDirectory--">getDirectory</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getFile--">getFile</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getHost--">getHost</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getParams--">getParams</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getPath--">getPath</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getPort--">getPort</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getQuery--">getQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getRoot--">getRoot</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getScheme--">getScheme</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getSelf--">getSelf</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getUri--">getUri</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getUser--">getUser</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#handleParamsBoolean-boolean-">handleParamsBoolean</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#host-java.lang.Object-">host</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#insecure--">insecure</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isAbsolute--">isAbsolute</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isOpaque--">isOpaque</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isRelative--">isRelative</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isSecure--">isSecure</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isXHTML--">isXHTML</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#normalizeQuery-java.lang.String-">normalizeQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#param-java.lang.Object-java.lang.Object-">param</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#params-java.lang.Object-">params</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#parseQuery-java.lang.String-">parseQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#parseQuery-java.lang.String-java.lang.String-">parseQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#path-java.lang.Object-">path</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#port-java.lang.Object-">port</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#query-java.lang.Object-">query</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#relative--">relative</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#relative-java.lang.Object-">relative</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#remove-java.lang.Object-">remove</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#removeParam-java.lang.Object-">removeParam</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#root--">root</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#scheme-java.lang.Object-">scheme</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#secure--">secure</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#set-java.lang.Object-java.lang.Object-">set</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setAppendParams-boolean-">setAppendParams</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setCharacterEncoding-java.lang.String-">setCharacterEncoding</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setForceRelative-boolean-">setForceRelative</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setFragment-java.lang.Object-">setFragment</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setFromURI-java.lang.Object-">setFromURI</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setHost-java.lang.Object-">setHost</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setParam-java.lang.Object-java.lang.Object-boolean-">setParam</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setParams-java.lang.Object-boolean-">setParams</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setPath-java.lang.Object-">setPath</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setPort-java.lang.Object-">setPort</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setQuery-java.lang.Object-">setQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setScheme-java.lang.Object-">setScheme</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setUserInfo-java.lang.Object-">setUserInfo</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setXHTML-boolean-">setXHTML</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#toQuery-java.util.Map-">toQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#toQuery-java.lang.Object-java.lang.Object-">toQuery</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#toURI-java.lang.Object-">toURI</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#uri-java.lang.Object-">uri</a>, <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#user-java.lang.Object-">user</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.generic.SafeConfig"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.velocity.tools.generic.<a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</a></h3> |
| <code><a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure-java.util.Map-">configure</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#getLog--">getLog</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#initLogger-org.apache.velocity.tools.generic.ValueParser-">initLogger</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isConfigLocked--">isConfigLocked</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isSafeMode--">isSafeMode</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setLockConfig-boolean-">setLockConfig</a>, <a href="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setSafeMode-boolean-">setSafeMode</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="INCLUDE_REQUEST_PARAMS_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INCLUDE_REQUEST_PARAMS_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> INCLUDE_REQUEST_PARAMS_KEY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.LinkTool.INCLUDE_REQUEST_PARAMS_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="request"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>request</h4> |
| <pre>protected javax.servlet.http.HttpServletRequest request</pre> |
| </li> |
| </ul> |
| <a name="response"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>response</h4> |
| <pre>protected javax.servlet.http.HttpServletResponse response</pre> |
| </li> |
| </ul> |
| <a name="includeRequestParams"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>includeRequestParams</h4> |
| <pre>protected boolean includeRequestParams</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="LinkTool--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LinkTool</h4> |
| <pre>public LinkTool()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="configure-org.apache.velocity.tools.generic.ValueParser-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre>protected void configure(<a href="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</a> props)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#configure-org.apache.velocity.tools.generic.ValueParser-">LinkTool</a></code></span></div> |
| <div class="block">Configuration</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#configure-org.apache.velocity.tools.generic.ValueParser-">configure</a></code> in class <code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>props</code> - configuration values</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFromRequest-javax.servlet.http.HttpServletRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFromRequest</h4> |
| <pre>protected void setFromRequest(javax.servlet.http.HttpServletRequest request)</pre> |
| </li> |
| </ul> |
| <a name="setIncludeRequestParams-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludeRequestParams</h4> |
| <pre>public void setIncludeRequestParams(boolean includeRequestParams)</pre> |
| <div class="block"><p>Controls whether or not this tool starts off with all parameters |
| from the last request automatically. Default is false.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>includeRequestParams</code> - whether or not to keep current request params</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRequestParams-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRequestParams</h4> |
| <pre>public <a href="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</a> addRequestParams(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... butOnlyThese)</pre> |
| <div class="block">Adds the specified parameters (if they exist) from the current |
| request to the query data of a copy of this instance. |
| If no parameters are specified, |
| then all of the current request's parameters will be added.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>butOnlyThese</code> - curent request parameters to keep</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A LinkTool object with the specified parameters from |
| the current request added to it or all the params if none specified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRequestParamsExcept-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRequestParamsExcept</h4> |
| <pre>public <a href="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</a> addRequestParamsExcept(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... ignoreThese)</pre> |
| <div class="block">Adds all of the current request's parameters to this link's |
| "query data" except for those whose keys match any of the specified strings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ignoreThese</code> - curent request parameters to ignore</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A LinkTool object with all of the current request's parameters |
| added to it, except those specified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMissingRequestParams-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMissingRequestParams</h4> |
| <pre>public <a href="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</a> addMissingRequestParams(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... ignoreThese)</pre> |
| <div class="block">Adds all of the current request's parameters to this link's |
| "query data" except for those whose keys match any of the specified strings |
| or already have a value set for them in the current instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ignoreThese</code> - curent request parameters to ignore</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A LinkTool object with all of the current request's parameters |
| added to it, except those specified or those that already have |
| values.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPathChanged--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPathChanged</h4> |
| <pre>protected boolean isPathChanged()</pre> |
| </li> |
| </ul> |
| <a name="getContextPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContextPath</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getContextPath()</pre> |
| <div class="block"><p>Initially, this returns the context path that addresses this web |
| application, e.g. <code>/myapp</code>. This string starts |
| with a "/" but does not end with a "/". If the path has been |
| changed (e.g. via a call to <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#path-java.lang.Object-"><code>LinkTool.path(Object)</code></a>), then this will |
| simply be the first "directory" in the path (i.e. everything from |
| the start up to the second backslash).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getContextPath--">getContextPath</a></code> in class <code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>context path</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#relative-java.lang.Object-"><code>LinkTool.relative(Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRequestPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestPath</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRequestPath()</pre> |
| <div class="block"><p>Initially, this retrieves the path for the current |
| request regardless of |
| whether this is a direct request or an include by the |
| RequestDispatcher. This string should always start with |
| a "/". If the path has been changed (e.g. via a call to |
| <a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#path-java.lang.Object-"><code>LinkTool.path(Object)</code></a>), then this will |
| simply be everything in the path after the <a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#getContextPath--"><code>getContextPath()</code></a> |
| (i.e. the second "/" in the path and everything after).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>request path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContextURL--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContextURL</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getContextURL()</pre> |
| <div class="block"><p>Returns a URL that addresses the web application. (e.g. |
| <code>http://myserver.net/myapp/</code>. |
| This essentially just replaces the full path with |
| the <a href="../../../../../org/apache/velocity/tools/view/LinkTool.html#getContextPath--"><code>getContextPath()</code></a> and removes the anchor and query |
| data.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>context URL</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <div class="block">Overrides to use response.encodeURL to get session id into URL |
| if sessions are used but cookies are not supported.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html#toString--">toString</a></code> in class <code><a href="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>final string representation</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/LinkTool.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/velocity/tools/view/JsonTool.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/velocity/tools/view/PagerTool.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/velocity/tools/view/LinkTool.html" target="_top">Frames</a></li> |
| <li><a href="LinkTool.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2002–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |