org.apache.velocity.tools.view.tools
Class LinkTool

java.lang.Object
  extended by org.apache.velocity.tools.generic.SafeConfig
      extended by org.apache.velocity.tools.generic.LinkTool
          extended by org.apache.velocity.tools.view.LinkTool
              extended by org.apache.velocity.tools.view.tools.LinkTool
All Implemented Interfaces:
Cloneable

Deprecated. Use LinkTool

@Deprecated
public class LinkTool
extends LinkTool


Field Summary
protected  ServletContext application
          Deprecated. 
static String AUTO_IGNORE_PARAMETERS_KEY
          Deprecated. 
static String SELF_ABSOLUTE_KEY
          Deprecated. 
static String SELF_INCLUDE_PARAMETERS_KEY
          Deprecated. 
 
Fields inherited from class org.apache.velocity.tools.view.LinkTool
INCLUDE_REQUEST_PARAMS_KEY, includeRequestParams, request, response
 
Fields inherited from class org.apache.velocity.tools.generic.LinkTool
APPEND_PARAMS_KEY, appendParams, charset, CHARSET_KEY, DEFAULT_CHARSET, DEFAULT_SCHEME, FORCE_RELATIVE_KEY, forceRelative, fragment, FRAGMENT_KEY, host, HOST_KEY, HTML_QUERY_DELIMITER, LOG, opaque, path, PATH_KEY, port, PORT_KEY, query, QUERY_KEY, queryDelim, scheme, SCHEME_KEY, SECURE_SCHEME, self, URI_KEY, user, USER_KEY, XHTML_MODE_KEY, XHTML_QUERY_DELIMITER
 
Fields inherited from class org.apache.velocity.tools.generic.SafeConfig
LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY
 
Constructor Summary
LinkTool()
          Deprecated.  
 
Method Summary
 LinkTool addAllParameters()
          Deprecated. use LinkTool.addRequestParams(String...) or LinkTool.addRequestParamsExcept(String...) or LinkTool.addMissingRequestParams(String...)
 LinkTool addIgnore(String parameterName)
          Deprecated. use LinkTool.addRequestParams(String...) or LinkTool.addRequestParamsExcept(String...) or LinkTool.addMissingRequestParams(String...)
 LinkTool addQueryData(Map parameters)
          Deprecated. use LinkTool.params(Object)
 LinkTool addQueryData(String key, Object value)
          Deprecated. use LinkTool.append(Object,Object)
protected  void configure(ValueParser parser)
          Deprecated. Does the actual configuration.
 String encodeURL(String url)
          Deprecated. use LinkTool.encode(Object)
 String getQueryData()
          Deprecated. use LinkTool.getQuery()
 String getURI()
          Deprecated. use LinkTool.getPath()
 void init(Object obj)
          Deprecated. 
 LinkTool setAbsolute(String uri)
          Deprecated. use LinkTool.absolute(Object)
 LinkTool setAnchor(String anchor)
          Deprecated. use LinkTool.anchor(Object) instead
 void setAutoIgnoreParameters(boolean autoIgnore)
          Deprecated. 
 void setParam(Object key, Object value, boolean append)
          Deprecated. If there is no existing value for this key in the query, it will simply add it and its value to the query.
 void setParams(Object obj, boolean append)
          Deprecated. If append is false, this simply delegates to LinkTool.setQuery(java.lang.Object).
 LinkTool setRelative(String uri)
          Deprecated. use LinkTool.relative(Object)
 void setRequest(HttpServletRequest request)
          Deprecated. 
 void setResponse(HttpServletResponse response)
          Deprecated. 
 void setSelfAbsolute(boolean selfAbsolute)
          Deprecated. use LinkTool.setForceRelative(boolean) as reversed replacement
 void setSelfIncludeParameters(boolean selfParams)
          Deprecated. use LinkTool.setIncludeRequestParams(boolean) instead
 LinkTool setURI(String uri)
          Deprecated. use LinkTool.uri(Object)
 void setXhtml(boolean useXhtml)
          Deprecated. 
 
Methods inherited from class org.apache.velocity.tools.view.LinkTool
addMissingRequestParams, addRequestParams, addRequestParamsExcept, getContextPath, getContextURL, getRequestPath, isPathChanged, setFromRequest, setIncludeRequestParams, toString
 
Methods inherited from class org.apache.velocity.tools.generic.LinkTool
absolute, absolute, anchor, append, append, appendAsArray, appendPath, appendQuery, combinePath, combineQuery, createURI, debug, debug, decode, decodeQueryPercents, directory, duplicate, duplicate, encode, equals, getAnchor, getAppendParams, getBaseRef, getCharacterEncoding, getDirectory, getFile, getHost, getParams, getPath, getPort, getQuery, getRoot, getScheme, getSelf, getUri, getUser, handleParamsBoolean, hashCode, host, insecure, isAbsolute, isOpaque, isRelative, isSecure, isXHTML, normalizeQuery, param, params, parseQuery, parseQuery, path, port, query, relative, relative, remove, removeParam, root, scheme, secure, set, setAppendParams, setCharacterEncoding, setForceRelative, setFragment, setFromURI, setHost, setPath, setPort, setQuery, setScheme, setUserInfo, setXHTML, toQuery, toQuery, toURI, uri, user
 
Methods inherited from class org.apache.velocity.tools.generic.SafeConfig
configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SELF_ABSOLUTE_KEY

@Deprecated
public static final String SELF_ABSOLUTE_KEY
Deprecated. 
See Also:
Constant Field Values

SELF_INCLUDE_PARAMETERS_KEY

@Deprecated
public static final String SELF_INCLUDE_PARAMETERS_KEY
Deprecated. 
See Also:
Constant Field Values

AUTO_IGNORE_PARAMETERS_KEY

@Deprecated
public static final String AUTO_IGNORE_PARAMETERS_KEY
Deprecated. 
See Also:
Constant Field Values

application

@Deprecated
protected ServletContext application
Deprecated. 
Constructor Detail

LinkTool

public LinkTool()
Deprecated. 
Method Detail

configure

protected void configure(ValueParser parser)
Deprecated. 
Description copied from class: SafeConfig
Does the actual configuration. This is protected, so subclasses may share the same ValueParser and call configure at any time, while preventing templates from doing so when configure(Map) is locked.

Overrides:
configure in class LinkTool

init

@Deprecated
public void init(Object obj)
Deprecated. 


setXhtml

@Deprecated
public void setXhtml(boolean useXhtml)
Deprecated. 


setSelfAbsolute

@Deprecated
public void setSelfAbsolute(boolean selfAbsolute)
Deprecated. use LinkTool.setForceRelative(boolean) as reversed replacement


setSelfIncludeParameters

@Deprecated
public void setSelfIncludeParameters(boolean selfParams)
Deprecated. use LinkTool.setIncludeRequestParams(boolean) instead


setAutoIgnoreParameters

@Deprecated
public void setAutoIgnoreParameters(boolean autoIgnore)
Deprecated. 


setRequest

@Deprecated
public void setRequest(HttpServletRequest request)
Deprecated. 


setResponse

@Deprecated
public void setResponse(HttpServletResponse response)
Deprecated. 


setAnchor

@Deprecated
public LinkTool setAnchor(String anchor)
Deprecated. use LinkTool.anchor(Object) instead


setRelative

@Deprecated
public LinkTool setRelative(String uri)
Deprecated. use LinkTool.relative(Object)


setAbsolute

@Deprecated
public LinkTool setAbsolute(String uri)
Deprecated. use LinkTool.absolute(Object)


setURI

@Deprecated
public LinkTool setURI(String uri)
Deprecated. use LinkTool.uri(Object)


getURI

@Deprecated
public String getURI()
Deprecated. use LinkTool.getPath()


addQueryData

@Deprecated
public LinkTool addQueryData(String key,
                                        Object value)
Deprecated. use LinkTool.append(Object,Object)


addQueryData

@Deprecated
public LinkTool addQueryData(Map parameters)
Deprecated. use LinkTool.params(Object)


getQueryData

@Deprecated
public String getQueryData()
Deprecated. use LinkTool.getQuery()


encodeURL

@Deprecated
public String encodeURL(String url)
Deprecated. use LinkTool.encode(Object)


addIgnore

@Deprecated
public LinkTool addIgnore(String parameterName)
Deprecated. use LinkTool.addRequestParams(String...) or LinkTool.addRequestParamsExcept(String...) or LinkTool.addMissingRequestParams(String...)

If you do use this, then you must use addAllParameters() and not the replacements for it, or these will not be honored.


addAllParameters

@Deprecated
public LinkTool addAllParameters()
Deprecated. use LinkTool.addRequestParams(String...) or LinkTool.addRequestParamsExcept(String...) or LinkTool.addMissingRequestParams(String...)


setParam

public void setParam(Object key,
                     Object value,
                     boolean append)
Deprecated. 
Description copied from class: LinkTool
If there is no existing value for this key in the query, it will simply add it and its value to the query. If the key already is present in the query and append is true, this will add the specified value to those already under that key. If LinkTool.appendParams is false, this will override the existing values with the specified new value.

Overrides:
setParam in class LinkTool

setParams

public void setParams(Object obj,
                      boolean append)
Deprecated. 
Description copied from class: LinkTool
If append is false, this simply delegates to LinkTool.setQuery(java.lang.Object). Otherwise, if the specified object is null, it does nothing. If the object is not a Map, it will turn it into a String and use LinkTool.parseQuery(java.lang.String) to parse it. Once it is a Map, it will iterate through the entries appending each key/value to the current query data.

Overrides:
setParams in class LinkTool


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.