Liferay 6.2.0-ce-m4

com.liferay.portal.kernel.portletdisplaytemplate
Class BasePortletDisplayTemplateHandler

java.lang.Object
  extended by com.liferay.portal.kernel.portletdisplaytemplate.BasePortletDisplayTemplateHandler
All Implemented Interfaces:
PortletDisplayTemplateHandler
Direct Known Subclasses:
AssetCategoriesNavigationPortletDisplayTemplateHandler, AssetPublisherPortletDisplayTemplateHandler, AssetTagsNavigationPortletDisplayTemplateHandler, BlogsPortletDisplayTemplateHandler, DocumentLibraryPortletDisplayTemplateHandler, SiteMapPortletDisplayTemplateHandler, WikiPortletDisplayTemplateHandler

public abstract class BasePortletDisplayTemplateHandler
extends Object
implements PortletDisplayTemplateHandler


Constructor Summary
BasePortletDisplayTemplateHandler()
           
 
Method Summary
 List<Element> getDefaultTemplateElements()
          Returns a list of elements containing the information of the portlet display templates to be installed by default.
protected  String getTemplatesConfigPath()
           
 String getTemplatesHelpPath(String language)
          Returns the path to the help template of the portlet display.
 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.portletdisplaytemplate.PortletDisplayTemplateHandler
getClassName, getName, getResourceName
 

Constructor Detail

BasePortletDisplayTemplateHandler

public BasePortletDisplayTemplateHandler()
Method Detail

getDefaultTemplateElements

public List<Element> getDefaultTemplateElements()
                                         throws Exception
Description copied from interface: PortletDisplayTemplateHandler
Returns a list of elements containing the information of the portlet display templates to be installed by default.

Specified by:
getDefaultTemplateElements in interface PortletDisplayTemplateHandler
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

getTemplatesHelpPath

public String getTemplatesHelpPath(String language)
Description copied from interface: PortletDisplayTemplateHandler
Returns the path to the help template of the portlet display.

Specified by:
getTemplatesHelpPath in interface PortletDisplayTemplateHandler
Parameters:
language - the language of the template
Returns:
the path to the help template of the portlet display. This template will be shown as a help message when the user creates a new portlet display template.

getTemplatesHelpPropertyKey

public String getTemplatesHelpPropertyKey()
Description copied from interface: PortletDisplayTemplateHandler
Returns the name of the property in portal.properties that defines the path to the help of template.

Specified by:
getTemplatesHelpPropertyKey in interface PortletDisplayTemplateHandler
Returns:
the name of the property in portal.properties that defines the path to the help template of the portlet display.

getTemplatesConfigPath

protected String getTemplatesConfigPath()

Liferay 6.2.0-ce-m4