public abstract class BasePortletDisplayTemplateHandler extends BaseTemplateHandler
| Constructor and Description |
|---|
BasePortletDisplayTemplateHandler() |
| Modifier and Type | Method and Description |
|---|---|
Map<String,TemplateVariableGroup> |
getTemplateVariableGroups(long classPK,
String language,
Locale locale)
Returns the template's map of script variable groups for which hints are
displayed in the template editor palette.
|
boolean |
isDisplayTemplateHandler() |
getCustomContextObjects, getDefaultTemplateElements, getDefaultTemplateKey, getRestrictedVariables, getTemplatesConfigPath, getTemplatesHelpContent, getTemplatesHelpPath, getTemplatesHelpPropertyKeyclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetClassName, getName, getResourceNamepublic Map<String,TemplateVariableGroup> getTemplateVariableGroups(long classPK, String language, Locale locale) throws Exception
TemplateHandler
Script variables can be grouped arbitrarily. As examples, a group of
entity fields could be mapped to the keyword Fields, or a
group of general variables portal variables could be mapped to the phrase
General Variables, etc.
classPK - the primary key of the entity that defines the variable
groups for the template. For example, consider specifying the
primary key of the structure associated to the template.language - 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.locale - the locale of the variable groups to getException - if an exception occurred retrieving the template
variable groupspublic boolean isDisplayTemplateHandler()