|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.kernel.template.BaseTemplateHandler
@ProviderType public abstract class BaseTemplateHandler
| Constructor Summary | |
|---|---|
BaseTemplateHandler()
|
|
| Method Summary | |
|---|---|
Map<String,Object> |
getCustomContextObjects()
|
List<Element> |
getDefaultTemplateElements()
Returns the elements containing the information of the portlet display templates to be installed by default. |
String |
getDefaultTemplateKey()
Returns the key of the template handler's default template. |
String[] |
getRestrictedVariables(String language)
Returns the restricted variables that are excluded from the template's context. |
protected String |
getTemplatesConfigPath()
|
String |
getTemplatesHelpContent(String language)
Returns initial template content for helping the user create a new template. |
String |
getTemplatesHelpPath(String language)
Returns the path to the template's help content. |
String |
getTemplatesHelpPropertyKey()
Returns the name of the property in portal.properties that
defines the path to the template's help content. |
| 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, getTemplateVariableGroups, isDisplayTemplateHandler |
| Constructor Detail |
|---|
public BaseTemplateHandler()
| Method Detail |
|---|
public Map<String,Object> getCustomContextObjects()
getCustomContextObjects in interface TemplateHandler
public List<Element> getDefaultTemplateElements()
throws Exception
TemplateHandler
getDefaultTemplateElements in interface TemplateHandlerException - if an exception occurred assembling the default
template elementspublic String getDefaultTemplateKey()
TemplateHandler
getDefaultTemplateKey in interface TemplateHandlerpublic String[] getRestrictedVariables(String language)
TemplateHandler
getRestrictedVariables in interface TemplateHandlerlanguage - 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.
public String getTemplatesHelpContent(String language)
TemplateHandler
getTemplatesHelpContent in interface TemplateHandlerlanguage - 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.
public String getTemplatesHelpPath(String language)
TemplateHandler
getTemplatesHelpPath in interface TemplateHandlerlanguage - 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.
public String getTemplatesHelpPropertyKey()
TemplateHandlerportal.properties that
defines the path to the template's help content.
getTemplatesHelpPropertyKey in interface TemplateHandlerportal.properties that
defines the path to the template's help contentprotected String getTemplatesConfigPath()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||