org.apache.turbine.util.template
Class TemplateLink

java.lang.Object
  org.apache.turbine.util.DynamicURI
      org.apache.turbine.util.template.TemplateLink

All Implemented Interfaces:

ApplicationTool, URI

Direct Known Subclasses:

TemplateLinkWithSlash

Deprecated. Use TemplateLink for tool usage and TemplateURI for code usage instead.

public class TemplateLink

extends DynamicURI

implements ApplicationTool

A customized version of the DynamicURI to be used in Templates. This is automatically inserted into the template context by the appropriate templating service so page authors can create links in templates. Here's an example of its Velocity/WebMacro use:

$link.setPage("index.wm").addPathInfo("hello","world")
This would return: http://foo.com/Turbine/template/index.wm/hello/world

Version:

$Id: TemplateLink.java 264152 2005-08-29 14:50:22Z henning $

Author:

Dave Bryson, Jon S. Stevens, Henning P. Schmiedehausen

Field Summary

Fields inherited from class org.apache.turbine.util.DynamicURI

data, hasPathInfo, hasQueryData, HTTP, HTTPS, PATH_INFO, pathInfo, QUERY_DATA, queryData, redirect, reference, res, sd

Constructor Summary

TemplateLink()
Deprecated. Default constructor.

TemplateLink(RunData data)
Deprecated. Constructor.

TemplateLink(ServerData data)
Deprecated. Constructor.

Method Summary

java.lang.String	getPage() Deprecated. Gets the template variable used by the Template Service.
java.lang.String	getURI() Deprecated. Returns the URI leaving the source intact.
void	init(java.lang.Object data) Deprecated. This will initialize a TemplateLink object that was constructed with the default constructor (ApplicationTool method).
void	refresh() Deprecated. Refresh method - does nothing
TemplateLink	setEncodeURLOff() Deprecated. This will turn off the execution of res.encodeURL() by making res == null.
TemplateLink	setPage(java.lang.String template) Deprecated. Sets the template variable used by the Template Service.
java.lang.String	toString() Deprecated. Returns the URI.

Methods inherited from class org.apache.turbine.util.DynamicURI

add, add, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addQueryData, addQueryData, addQueryData, addQueryData, addQueryData, addQueryData, assertInitialized, getA, getContextPath, getReference, getScriptName, getServerData, getServerName, getServerPort, getServerScheme, init, init, remove, removePathInfo, removePathInfo, removeQueryData, removeQueryData, renderPathInfo, renderQueryString, setAction, setActionEvent, setContextPath, setReference, setScreen, setScriptName, setSecure, setSecure, setServerData, setServerName, setServerPort, setServerScheme, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TemplateLink

public TemplateLink()

Deprecated.

Default constructor.

The init method must be called before use.

TemplateLink

public TemplateLink(RunData data)

Deprecated.

Constructor.

Parameters:

data - a Turbine RunData object.

TemplateLink

public TemplateLink(ServerData data)

Deprecated.

Constructor.

Parameters:

data - a Turbine ServerData object.

Method Detail

init

public void init(java.lang.Object data)

Deprecated.

This will initialize a TemplateLink object that was constructed with the default constructor (ApplicationTool method).

Specified by:

init in interface ApplicationTool

Parameters:

data - assumed to be a RunData object

refresh

public void refresh()

Deprecated.

Refresh method - does nothing

Specified by:

refresh in interface ApplicationTool

setEncodeURLOff

public TemplateLink setEncodeURLOff()

Deprecated.

This will turn off the execution of res.encodeURL() by making res == null. This is a hack for cases where you don't want to see the session information

Returns:

instance of TemplateLink

setPage

public TemplateLink setPage(java.lang.String template)

Deprecated.

Sets the template variable used by the Template Service.

Parameters:

template - A String with the template name.

Returns:

A TemplateLink.

getPage

public java.lang.String getPage()

Deprecated.

Gets the template variable used by the Template Service. It is only available after setPage() has been called.

Returns:

The template name.

toString

public java.lang.String toString()

Deprecated.

Returns the URI. After rendering the URI, it clears the pathInfo and QueryString portions of the DynamicURI.

Overrides:

toString in class DynamicURI

Returns:

A String with the URI in the form http://foo.com/Turbine/template/index.wm/hello/world

getURI

public java.lang.String getURI()

Deprecated.

Returns the URI leaving the source intact. Wraps directly to the DynamicURI.toString method of the superclass (avoiding the local toString implementation).

Returns:

A String with the URI in the form http://foo.com/Turbine/template/index.wm/hello/world