@ProviderType public abstract class BaseTemplateHandler extends Object implements TemplateHandler
| Constructor and Description |
|---|
BaseTemplateHandler() |
| Modifier and Type | Method and Description |
|---|---|
Map<String,Object> |
getCustomContextObjects()
Returns the map of name/value pairs of the objects that should be
injected into the context.
|
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. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetClassName, getName, getResourceName, getTemplateVariableGroups, isDisplayTemplateHandlerpublic Map<String,Object> getCustomContextObjects()
TemplateHandlergetCustomContextObjects in interface TemplateHandlerpublic List<Element> getDefaultTemplateElements() throws Exception
TemplateHandlergetDefaultTemplateElements in interface TemplateHandlerException - if an exception occurred assembling the default
template elementspublic String getDefaultTemplateKey()
TemplateHandlergetDefaultTemplateKey in interface TemplateHandlerpublic String[] getRestrictedVariables(String language)
TemplateHandlergetRestrictedVariables in interface TemplateHandlerlanguage - the template's scripting language. Acceptable values for
the FreeMarker or Velocity languages are TemplateConstants.LANG_TYPE_FTL, or TemplateConstants.LANG_TYPE_VM, respectively.public String getTemplatesHelpContent(String language)
TemplateHandlergetTemplatesHelpContent in interface TemplateHandlerlanguage - the template's scripting language. Acceptable values for
the FreeMarker or Velocity languages are TemplateConstants.LANG_TYPE_FTL, or TemplateConstants.LANG_TYPE_VM, respectively.public String getTemplatesHelpPath(String language)
TemplateHandlergetTemplatesHelpPath in interface TemplateHandlerlanguage - the template's scripting language. Acceptable values for
the FreeMarker or Velocity languages are TemplateConstants.LANG_TYPE_FTL, or TemplateConstants.LANG_TYPE_VM, 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()