com.liferay.dynamic.data.mapping.template

Class BaseDDMTemplateHandler

java.lang.Object

com.liferay.portal.kernel.template.BaseTemplateHandler

com.liferay.dynamic.data.mapping.template.BaseDDMTemplateHandler

All Implemented Interfaces:

TemplateHandler

public abstract class BaseDDMTemplateHandler
extends BaseTemplateHandler

Constructor Summary

Constructors

Constructor and Description
BaseDDMTemplateHandler()

Method Summary

Modifier and Type	Method and Description
protected void	addTemplateVariableGroup(java.util.Map<java.lang.String,TemplateVariableGroup> templateVariableGroups, TemplateVariableGroup templateVariableGroup)
protected void	collectNestedFieldNameVariableName(DDMFormField parentDDMFormField, java.util.Map<java.lang.String,java.lang.String> fieldNameVariableNameMap)
protected java.lang.Class<?>	getFieldVariableClass()
protected TemplateVariableGroup	getGeneralVariablesTemplateVariableGroup()
protected TemplateVariableGroup	getStructureFieldsTemplateVariableGroup(long ddmStructureId, java.util.Locale locale)
protected abstract TemplateVariableCodeHandler	getTemplateVariableCodeHandler()
java.util.Map<java.lang.String,TemplateVariableGroup>	getTemplateVariableGroups(long classPK, java.lang.String language, java.util.Locale locale) Returns the template's map of script variable groups for which hints are displayed in the template editor palette.
protected TemplateVariableGroup	getUtilTemplateVariableGroup()
boolean	isDisplayTemplateHandler() Returns true if the entity is a display template handler.

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

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

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

Constructor Detail

BaseDDMTemplateHandler

public BaseDDMTemplateHandler()

Method Detail

getTemplateVariableGroups

public java.util.Map<java.lang.String,TemplateVariableGroup> getTemplateVariableGroups(long classPK,
                                                                                       java.lang.String language,
                                                                                       java.util.Locale locale)
                                                                                throws java.lang.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:

java.lang.Exception - if an exception occurred retrieving the template variable groups

isDisplayTemplateHandler

public boolean isDisplayTemplateHandler()

Description copied from interface: TemplateHandler

Returns true if the entity is a display template handler.

Returns:

true if the entity is a display template handler; false otherwise

addTemplateVariableGroup

protected void addTemplateVariableGroup(java.util.Map<java.lang.String,TemplateVariableGroup> templateVariableGroups,
                                        TemplateVariableGroup templateVariableGroup)

collectNestedFieldNameVariableName

protected void collectNestedFieldNameVariableName(DDMFormField parentDDMFormField,
                                                  java.util.Map<java.lang.String,java.lang.String> fieldNameVariableNameMap)
                                           throws PortalException

Throws:

PortalException

getFieldVariableClass

protected java.lang.Class<?> getFieldVariableClass()

getGeneralVariablesTemplateVariableGroup

protected TemplateVariableGroup getGeneralVariablesTemplateVariableGroup()

getStructureFieldsTemplateVariableGroup

protected TemplateVariableGroup getStructureFieldsTemplateVariableGroup(long ddmStructureId,
                                                                        java.util.Locale locale)
                                                                 throws PortalException

Throws:

PortalException

getTemplateVariableCodeHandler

protected abstract TemplateVariableCodeHandler getTemplateVariableCodeHandler()

getUtilTemplateVariableGroup

protected TemplateVariableGroup getUtilTemplateVariableGroup()