com.liferay.portal.kernel.template

Class BaseTemplateHandler

java.lang.Object

com.liferay.portal.kernel.template.BaseTemplateHandler

All Implemented Interfaces:

TemplateHandler

Direct Known Subclasses:

BasePortletDisplayTemplateHandler

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

Author:

Jorge Ferrer

Constructor Summary

Constructors

Constructor and Description
BaseTemplateHandler()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getCustomContextObjects() Returns the map of name/value pairs of the objects that should be injected into the context.
java.util.List<Element>	getDefaultTemplateElements() Returns the elements containing the information of the portlet display templates to be installed by default.
java.lang.String	getDefaultTemplateKey() Returns the key of the template handler's default template.
java.lang.String[]	getRestrictedVariables(java.lang.String language) Returns the restricted variables that are excluded from the template's context.
protected java.lang.String	getTemplatesConfigPath()
java.lang.String	getTemplatesHelpContent(java.lang.String language) Returns initial template content for helping the user create a new template.
java.lang.String	getTemplatesHelpPath(java.lang.String language) Returns the path to the template's help content.
java.lang.String	getTemplatesHelpPropertyKey() Returns the name of the property in portal.properties that defines the path to the template's help content.

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, isDisplayTemplateHandler

Constructor Detail

BaseTemplateHandler

public BaseTemplateHandler()

Method Detail

getCustomContextObjects

public java.util.Map<java.lang.String,java.lang.Object> getCustomContextObjects()

Description copied from interface: TemplateHandler

Returns the map of name/value pairs of the objects that should be injected into the context.

Specified by:

getCustomContextObjects in interface TemplateHandler

Returns:

the objects that should be injected into the context

getDefaultTemplateElements

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

Description copied from interface: TemplateHandler

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

Specified by:

getDefaultTemplateElements in interface TemplateHandler

Returns:

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

Throws:

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

getDefaultTemplateKey

public java.lang.String getDefaultTemplateKey()

Description copied from interface: TemplateHandler

Returns the key of the template handler's default template.

Specified by:

getDefaultTemplateKey in interface TemplateHandler

Returns:

the key of the template handler's default template

getRestrictedVariables

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

Description copied from interface: TemplateHandler

Returns the restricted variables that are excluded from the template's context.

Specified by:

getRestrictedVariables in interface TemplateHandler

Parameters:

language - the template's scripting language. Acceptable values for the FreeMarker, Velocity, or XSL languages are TemplateConstants.LANG_TYPE_FTL, TemplateConstants.LANG_TYPE_VM, or TemplateConstants.LANG_TYPE_XSL, respectively.

Returns:

the restricted variables that are excluded from the template's context

getTemplatesHelpContent

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

Description copied from interface: TemplateHandler

Returns initial template content for helping the user create a new template.

Specified by:

getTemplatesHelpContent in interface TemplateHandler

Parameters:

language - the template's scripting language. Acceptable values for the FreeMarker, Velocity, or XSL languages are TemplateConstants.LANG_TYPE_FTL, TemplateConstants.LANG_TYPE_VM, or TemplateConstants.LANG_TYPE_XSL, respectively.

Returns:

initial template content for helping the user create a new template

getTemplatesHelpPath

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

Description copied from interface: TemplateHandler

Returns the path to the template's help content.

Specified by:

getTemplatesHelpPath in interface TemplateHandler

Parameters:

language - the template's scripting language. Acceptable values for the FreeMarker, Velocity, or XSL languages are TemplateConstants.LANG_TYPE_FTL, TemplateConstants.LANG_TYPE_VM, or TemplateConstants.LANG_TYPE_XSL, respectively.

Returns:

the path to the template's help content

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 template's help content.

Specified by:

getTemplatesHelpPropertyKey in interface TemplateHandler

Returns:

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

getTemplatesConfigPath

protected java.lang.String getTemplatesConfigPath()