com.liferay.portal.kernel.portletdisplaytemplate

Class BasePortletDisplayTemplateHandler

Object

com.liferay.portal.kernel.template.BaseTemplateHandler

com.liferay.portal.kernel.portletdisplaytemplate.BasePortletDisplayTemplateHandler

All Implemented Interfaces:

TemplateHandler

public abstract class BasePortletDisplayTemplateHandler
extends BaseTemplateHandler

Author:

Eduardo Garcia

Constructor Summary

Constructors

Constructor and Description
BasePortletDisplayTemplateHandler()

Method Summary

Modifier and Type	Method and Description
Map<String,TemplateVariableGroup>	getTemplateVariableGroups(long classPK, String language, Locale locale) Returns the template's map of script variable groups for which hints are displayed in the template editor palette.
boolean	isDisplayTemplateHandler()

Methods inherited from class com.liferay.portal.kernel.template.BaseTemplateHandler

getCustomContextObjects, getDefaultTemplateElements, getDefaultTemplateKey, getRestrictedVariables, getTemplatesConfigPath, getTemplatesHelpContent, getTemplatesHelpPath, getTemplatesHelpPropertyKey

Methods inherited from class 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

Constructor Detail

BasePortletDisplayTemplateHandler

public BasePortletDisplayTemplateHandler()

Method Detail

getTemplateVariableGroups

public Map<String,TemplateVariableGroup> getTemplateVariableGroups(long classPK,
                                                                   String language,
                                                                   Locale locale)
                                                            throws Exception

Description copied from interface: TemplateHandler

Returns the template's map of script variable groups for which hints are displayed in the template editor palette.

Script variables can be grouped arbitrarily. As examples, a group of entity fields could be mapped to the keyword Fields, or a group of general variables portal variables could be mapped to the phrase General Variables, etc.

Parameters:

classPK - the primary key of the entity that defines the variable groups for the template. For example, consider specifying the primary key of the structure associated to the template.

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.

locale - the locale of the variable groups to get

Returns:

the template's map of script variable groups for which hints are displayed in the template editor palette

Throws:

Exception - if an exception occurred retrieving the template variable groups

isDisplayTemplateHandler

public boolean isDisplayTemplateHandler()