Package org.silverpeas.core.template
Interface SilverpeasTemplate
-
- All Known Implementing Classes:
SilverpeasStringTemplate
public interface SilverpeasTemplate
-
-
Field Summary
Fields Modifier and Type Field Description static String
TEMPLATE_CUSTOM_DIR
static String
TEMPLATE_ROOT_DIR
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
applyFileTemplate(String fileName)
String
applyFileTemplateOnComponent(String componentName, String fileName)
String
applyStringTemplate(String label)
Map<String,Object>
getAttributes()
boolean
isCustomTemplateExists(String componentName, String fileName)
SilverpeasTemplate
mergeRootWithCustom()
When the result of string template processing is built from a combination of several template files, this method MUST be called BEFORE callingapplyFileTemplate(String)
.void
setAttribute(String name, Object value)
-
-
-
Field Detail
-
TEMPLATE_ROOT_DIR
static final String TEMPLATE_ROOT_DIR
- See Also:
- Constant Field Values
-
TEMPLATE_CUSTOM_DIR
static final String TEMPLATE_CUSTOM_DIR
- See Also:
- Constant Field Values
-
-
Method Detail
-
mergeRootWithCustom
SilverpeasTemplate mergeRootWithCustom()
When the result of string template processing is built from a combination of several template files, this method MUST be called BEFORE callingapplyFileTemplate(String)
.It is in charge of merging the templates given by the product and the one modified by the customer. By this way, the customer modifies only the necessary templates in case of customization.
- Returns:
- itself.
-
applyFileTemplateOnComponent
String applyFileTemplateOnComponent(String componentName, String fileName)
-
-