@ProviderType public abstract class BaseTemplateHandler extends java.lang.Object implements TemplateHandler
| Constructor and Description |
|---|
BaseTemplateHandler() |
| Modifier and Type | Method and Description |
|---|---|
java.util.Map<java.lang.String,java.lang.Object> |
getCustomContextObjects() |
java.util.List<Element> |
getDefaultTemplateElements()
Returns the elements containing the information of the portlet display
templates to be installed by default.
|
java.lang.String |
getDefaultTemplateKey()
Returns the key of the template handler's default template.
|
java.lang.String[] |
getRestrictedVariables(java.lang.String language)
Returns the restricted variables that are excluded from the template's
context.
|
protected java.lang.String |
getTemplatesConfigPath() |
java.lang.String |
getTemplatesHelpContent(java.lang.String language)
Returns initial template content for helping the user create a new
template.
|
java.lang.String |
getTemplatesHelpPath(java.lang.String language)
Returns the path to the template's help content.
|
java.lang.String |
getTemplatesHelpPropertyKey()
Returns the name of the property in
portal.properties that
defines the path to the template's help content. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetClassName, getName, getResourceName, getTemplateVariableGroups, isDisplayTemplateHandlerpublic java.util.Map<java.lang.String,java.lang.Object> getCustomContextObjects()
getCustomContextObjects in interface TemplateHandlerpublic java.util.List<Element> getDefaultTemplateElements() throws java.lang.Exception
TemplateHandlergetDefaultTemplateElements in interface TemplateHandlerjava.lang.Exception - if an exception occurred assembling the default
template elementspublic java.lang.String getDefaultTemplateKey()
TemplateHandlergetDefaultTemplateKey in interface TemplateHandlerpublic java.lang.String[] getRestrictedVariables(java.lang.String language)
TemplateHandlergetRestrictedVariables 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 java.lang.String getTemplatesHelpContent(java.lang.String language)
TemplateHandlergetTemplatesHelpContent 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 java.lang.String getTemplatesHelpPath(java.lang.String language)
TemplateHandlergetTemplatesHelpPath 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 java.lang.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 java.lang.String getTemplatesConfigPath()