com.liferay.portal.kernel.template

Class BaseTemplateHandler

java.lang.Object

com.liferay.portal.kernel.template.BaseTemplateHandler

All Implemented Interfaces:

TemplateHandler

Direct Known Subclasses:

BasePortletDisplayTemplateHandler

public abstract class BaseTemplateHandler
extends java.lang.Object
implements TemplateHandler

Author:

Jorge Ferrer

Constructor Summary

Constructors

Constructor and Description
BaseTemplateHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<Element>	getDefaultTemplateElements() Returns a list of elements containing the information of the portlet display templates to be installed by default.
java.lang.String[]	getRestrictedVariables(java.lang.String language)
protected java.lang.String	getTemplatesConfigPath()
java.lang.String	getTemplatesHelpPath(java.lang.String language) Returns the path to the help template.
java.lang.String	getTemplatesHelpPropertyKey() Returns the name of the property in portal.properties that defines the path to the help of template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.portal.kernel.template.TemplateHandler

getClassName, getName, getResourceName, getTemplateVariableGroups

Constructor Detail

BaseTemplateHandler

public BaseTemplateHandler()

Method Detail

getDefaultTemplateElements

public java.util.List<Element> getDefaultTemplateElements()
                                                   throws java.lang.Exception

Description copied from interface: TemplateHandler

Returns a list of elements containing the information of the portlet display templates to be installed by default.

Specified by:

getDefaultTemplateElements in interface TemplateHandler

Returns:

a list of elements containing the information of the portlet display templates to be installed by default. These templates will be installed when registering the portlet

Throws:

java.lang.Exception - if an exception occurred assembling the default template elements

getRestrictedVariables

public java.lang.String[] getRestrictedVariables(java.lang.String language)

Specified by:

getRestrictedVariables in interface TemplateHandler

getTemplatesHelpPath

public java.lang.String getTemplatesHelpPath(java.lang.String language)

Description copied from interface: TemplateHandler

Returns the path to the help template.

Specified by:

getTemplatesHelpPath in interface TemplateHandler

Parameters:

language - the language of the template

Returns:

the path to the help template. This template will be shown as a help message when the user creates a new template.

getTemplatesHelpPropertyKey

public java.lang.String getTemplatesHelpPropertyKey()

Description copied from interface: TemplateHandler

Returns the name of the property in portal.properties that defines the path to the help of template.

Specified by:

getTemplatesHelpPropertyKey in interface TemplateHandler

Returns:

the name of the property in portal.properties that defines the path to the help template.

getTemplatesConfigPath

protected java.lang.String getTemplatesConfigPath()