org.apache.jetspeed.util.template
Class JetspeedTemplateLink

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

All Implemented Interfaces:

org.apache.turbine.services.pull.ApplicationTool

Direct Known Subclasses:

PortletTemplateLink

Deprecated. Use JetspeedBaseLink

public class JetspeedTemplateLink

extends org.apache.turbine.util.template.TemplateLink

implements org.apache.turbine.services.pull.ApplicationTool

A customized version of the TemplateLink which can handle portlet references.

It is inserted into the template context by Turbine, via request tools.

Each portlet must call setPortlet(this) on it before entering the template rendering code. This is done currently in VelocityPortlet.

Version:

$Id: JetspeedTemplateLink.java,v 1.15 2005/03/21 18:21:45 sgala Exp $

Author:

Raphaël Luta, Santiago Gala

Field Summary

static java.lang.String	ACTION_KEY Deprecated.
protected Portlet	activePortlet Deprecated. The portlet that will be used to build the reference.
static java.lang.String	PANEL_KEY Deprecated.
static java.lang.String	PORTLET_KEY Deprecated.
static java.lang.String	SCREEN_KEY Deprecated.
static java.lang.String	TEMPLATE_KEY Deprecated.

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

hasPathInfo, hasQueryData, HTTP, HTTPS, PATH_INFO, pathInfo, QUERY_DATA, queryData, redirect, reference, res, scriptName, sd, serverName, serverPort, serverScheme

Constructor Summary

JetspeedTemplateLink()
Deprecated. Empty constructor.for introspection

JetspeedTemplateLink(org.apache.turbine.util.RunData data)
Deprecated. Constructor.

Method Summary

void	clear() Deprecated.
org.apache.turbine.util.DynamicURI	forPortlet(java.lang.String portlet) Deprecated. Return a URI that refers to the named portlet.
java.lang.String	getActionKey() Deprecated.
java.lang.String	getPageKey() Deprecated.
java.lang.String	getPanelKey() Deprecated. Use the activePortlet to get the current Panel name (key).
java.lang.String	getPortlet() Deprecated.
org.apache.turbine.util.DynamicURI	getPortletByName(java.lang.String portletName) Deprecated.
java.lang.String	getPortletKey() Deprecated.
java.lang.String	getScreenKey() Deprecated.
void	init(java.lang.Object data) Deprecated. This will initialise a JetspeedTool object that was constructed with the default constructor (ApplicationTool method).
void	refresh() Deprecated. Refresh method - does nothing
org.apache.turbine.util.DynamicURI	setPanel(java.lang.String panel) Deprecated. Add a select-panel reference in the link
void	setPortlet(Portlet portlet) Deprecated. Set the portlet giving context to this Link object.
org.apache.turbine.util.DynamicURI	setPortlet(java.lang.String portlet) Deprecated. the name is confusing. Use @see(#forPortlet()) instead.
java.lang.String	toString() Deprecated.

Methods inherited from class org.apache.turbine.util.template.TemplateLink

getPage, getURI, setEncodeURLOff, setPage

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

add, add, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addQueryData, addQueryData, addQueryData, addQueryData, addQueryData, addQueryData, getA, getReference, getScriptName, getServerData, getServerName, getServerPort, getServerScheme, init, init, init, remove, removePathInfo, removePathInfo, removeQueryData, removeQueryData, renderPathInfo, renderQueryString, setAction, 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

Field Detail

PORTLET_KEY

public static final java.lang.String PORTLET_KEY

Deprecated.

See Also:

Constant Field Values

ACTION_KEY

public static final java.lang.String ACTION_KEY

Deprecated.

See Also:

Constant Field Values

SCREEN_KEY

public static final java.lang.String SCREEN_KEY

Deprecated.

See Also:

Constant Field Values

TEMPLATE_KEY

public static final java.lang.String TEMPLATE_KEY

Deprecated.

See Also:

Constant Field Values

PANEL_KEY

public static final java.lang.String PANEL_KEY

Deprecated.

See Also:

Constant Field Values

activePortlet

protected Portlet activePortlet

Deprecated.

The portlet that will be used to build the reference.

Constructor Detail

JetspeedTemplateLink

public JetspeedTemplateLink()

Deprecated.

Empty constructor.for introspection

JetspeedTemplateLink

public JetspeedTemplateLink(org.apache.turbine.util.RunData data)

Deprecated.

Constructor.

Parameters:

data - A Jetspeed RunData object.

Method Detail

init

public void init(java.lang.Object data)

Deprecated.

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

Specified by:

init in interface org.apache.turbine.services.pull.ApplicationTool

Parameters:

data - assumed to be a RunData object

setPortlet

public void setPortlet(Portlet portlet)

Deprecated.

Set the portlet giving context to this Link object.

refresh

public void refresh()

Deprecated.

Refresh method - does nothing

Specified by:

refresh in interface org.apache.turbine.services.pull.ApplicationTool

forPortlet

public org.apache.turbine.util.DynamicURI forPortlet(java.lang.String portlet)

Deprecated.

Return a URI that refers to the named portlet.

Parameters:

portlet - the name of the portlet to link to

Returns:

a DynamicURI referencing the named portlet for easy link construction in template

setPortlet

public org.apache.turbine.util.DynamicURI setPortlet(java.lang.String portlet)

Deprecated. the name is confusing. Use @see(#forPortlet()) instead.

Add a portlet reference in the link.

Parameters:

portlet - the name of the portlet to link to

Returns:

a DynamicURI referencing the named portlet for easy link construction in template

getPortlet

public java.lang.String getPortlet()

Deprecated.

Returns:

the portlet parameter value

getPortletKey

public java.lang.String getPortletKey()

Deprecated.

Returns:

the portlet parameter name

getActionKey

public java.lang.String getActionKey()

Deprecated.

Returns:

the action parameter name

getScreenKey

public java.lang.String getScreenKey()

Deprecated.

Returns:

the screen parameter name

getPageKey

public java.lang.String getPageKey()

Deprecated.

Returns:

the template parameter name

setPanel

public org.apache.turbine.util.DynamicURI setPanel(java.lang.String panel)

Deprecated.

Add a select-panel reference in the link

Returns:

a self reference for easy link construction in template

getPanelKey

public java.lang.String getPanelKey()

Deprecated.

Use the activePortlet to get the current Panel name (key).

Returns:

the panel parameter name

toString

public java.lang.String toString()

Deprecated.

getPortletByName

public org.apache.turbine.util.DynamicURI getPortletByName(java.lang.String portletName)

Deprecated.

clear

public void clear()

Deprecated.