org.apache.velocity.tools.examples.showcase.tool

Class LayoutLinkTool

java.lang.Object

org.apache.velocity.tools.generic.SafeConfig

org.apache.velocity.tools.generic.LinkTool

org.apache.velocity.tools.view.LinkTool

org.apache.velocity.tools.examples.showcase.tool.LayoutLinkTool

All Implemented Interfaces:

Serializable, Cloneable

public class LayoutLinkTool
extends LinkTool

This is meant to demonstrate how to extend the LinkTool to avoid the manual use of "magic" or common query parameters. So instead of doing $link.param('layout', 'Table.vm') in your template, you would just do $link.layout('Table').

Version:

$Id: LayoutLinkTool.java 479724 2006-11-27 18:49:37Z nbubna $

Author:

Nathan Bubna

See Also:

Serialized Form

Field Summary

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, 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, log, LOGGER_NAME_KEY, SAFE_MODE_KEY, USE_CLASS_LOGGER_KEY

Constructor Summary

Constructors

Constructor and Description
LayoutLinkTool()

Method Summary

Modifier and Type	Method and Description
LayoutLinkTool	layout(Object obj)
LayoutLinkTool	layout(String layout)

Methods inherited from class org.apache.velocity.tools.view.LinkTool

addMissingRequestParams, addRequestParams, addRequestParamsExcept, configure, 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, 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, setParam, setParams, setPath, setPort, setQuery, setScheme, setUserInfo, setXHTML, toQuery, toQuery, toURI, uri, user

Methods inherited from class org.apache.velocity.tools.generic.SafeConfig

configure, getLog, initLogger, isConfigLocked, isSafeMode, setLockConfig, setSafeMode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LayoutLinkTool

public LayoutLinkTool()

Method Detail

layout

public LayoutLinkTool layout(Object obj)

layout

public LayoutLinkTool layout(String layout)