Liferay 6.2.0-ce-m4

com.liferay.portal.kernel.portletdisplaytemplate
Interface PortletDisplayTemplateHandler

All Known Implementing Classes:
AssetCategoriesNavigationPortletDisplayTemplateHandler, AssetPublisherPortletDisplayTemplateHandler, AssetTagsNavigationPortletDisplayTemplateHandler, BasePortletDisplayTemplateHandler, BlogsPortletDisplayTemplateHandler, DocumentLibraryPortletDisplayTemplateHandler, SiteMapPortletDisplayTemplateHandler, WikiPortletDisplayTemplateHandler

public interface PortletDisplayTemplateHandler


Method Summary
 String getClassName()
          Returns the class name of the portlet display template.
 List<Element> getDefaultTemplateElements()
          Returns a list of elements containing the information of the portlet display templates to be installed by default.
 String getName(Locale locale)
          Returns the name of the portlet display template.
 String getResourceName()
          Returns the name of the resource the portlet display template is associated with.
 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.
 

Method Detail

getClassName

String getClassName()
Returns the class name of the portlet display template.

Returns:
the class name of the portlet display template

getDefaultTemplateElements

List<Element> getDefaultTemplateElements()
                                         throws Exception
Returns a list of elements containing the information of the portlet display templates to be installed by default.

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

getName

String getName(Locale locale)
Returns the name of the portlet display template.

Parameters:
locale - the locale of the portlet display template name to get
Returns:
the name of the portlet display template

getResourceName

String getResourceName()
Returns the name of the resource the portlet display template is associated with. Permissions on the resource are checked when adding a new portlet display template.

Returns:
the name of the resource

getTemplatesHelpPath

String getTemplatesHelpPath(String language)
Returns the path to the help template of the portlet display.

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

String getTemplatesHelpPropertyKey()
Returns the name of the property in portal.properties that defines the path to the help of template.

Returns:
the name of the property in portal.properties that defines the path to the help template of the portlet display.

Liferay 6.2.0-ce-m4