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 Object
- implements TemplateHandler
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BaseTemplateHandler
public BaseTemplateHandler()
getDefaultTemplateElements
public List<Element> getDefaultTemplateElements()
throws 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:
Exception
- if an exception occurred assembling the default
template elements
getRestrictedVariables
public String[] getRestrictedVariables(String language)
- Specified by:
getRestrictedVariables
in interface TemplateHandler
getTemplatesHelpPath
public String getTemplatesHelpPath(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 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 String getTemplatesConfigPath()