fr.paris.lutece.portal.service.template

Interface IFreeMarkerTemplateService

All Known Implementing Classes:

AbstractFreeMarkerTemplateService

public interface IFreeMarkerTemplateService

IFreeMarkerTemplateService

Method Summary

Modifier and Type	Method and Description
void	addAutoInclude(String strFile) Add an auto include file
void	addPluginMacros(String strFileName) Adds a macro file (like the main commons.html) brought by a plugin.
String	getAbsolutePathFromRelativePath(String strPath) Get the absolute path from relative path
List<String>	getAutoIncludes() Get the list of auto includes files
String	getDefaultPattern(Locale locale) Get the default date pattern
void	init(String strTemplatePath) Initializes the service with the templates's path
void	init(String strTemplatePath, boolean bAcceptIncompatibleImprovements) Initializes the service with the templates's path
HtmlTemplate	loadTemplate(String strTemplateData, Locale locale, Object rootMap) Load a template from a String and process a model WARNING : This method must not be used in front office (no cache management available).
HtmlTemplate	loadTemplate(String strPath, String strTemplate) Load a template
HtmlTemplate	loadTemplate(String strPath, String strTemplate, Locale locale, Object rootMap) Load a template and process a model
void	removeAutoInclude(String strFile) Remove an auto include file
void	resetCache() Reset the cache
void	resetConfiguration() Clears the configuration cache
void	setSharedVariable(String name, Object obj) Add a shared variable into every template
void	setTemplateUpdateDelay(int nTemplateUpdateDelay) Set the template update delay

Method Detail

getAbsolutePathFromRelativePath

String getAbsolutePathFromRelativePath(String strPath)

Get the absolute path from relative path

Parameters:

strPath - the path

Returns:

the absolute path from relative path

getDefaultPattern

String getDefaultPattern(Locale locale)

Get the default date pattern

Parameters:

locale - the locale

Returns:

the default date pattern

setTemplateUpdateDelay

void setTemplateUpdateDelay(int nTemplateUpdateDelay)

Set the template update delay

Parameters:

nTemplateUpdateDelay - the template update delay

addPluginMacros

void addPluginMacros(String strFileName)

Adds a macro file (like the main commons.html) brought by a plugin. This file will be included for every template (autoinclude).

Parameters:

strFileName - the filename

setSharedVariable

void setSharedVariable(String name,
                       Object obj)

Add a shared variable into every template

Parameters:

name - name of the shared variable

obj - value

init

void init(String strTemplatePath)

Initializes the service with the templates's path

Parameters:

strTemplatePath - The template path

init

void init(String strTemplatePath,
          boolean bAcceptIncompatibleImprovements)

Initializes the service with the templates's path

Parameters:

strTemplatePath - The template path

bAcceptIncompatibleImprovements - Use Freemarker new features or stay backward compatible

loadTemplate

HtmlTemplate loadTemplate(String strPath,
                          String strTemplate)

Load a template

Parameters:

strPath - the root path

strTemplate - the path of the template from the root path

Returns:

the html template

loadTemplate

HtmlTemplate loadTemplate(String strPath,
                          String strTemplate,
                          Locale locale,
                          Object rootMap)

Load a template and process a model

Parameters:

strPath - the root path

strTemplate - the path of the template from the root path

locale - The locale

rootMap - the model root

Returns:

the processed html template

loadTemplate

HtmlTemplate loadTemplate(String strTemplateData,
                          Locale locale,
                          Object rootMap)

Load a template from a String and process a model WARNING : This method must not be used in front office (no cache management available).
Using Freemarker without cache is huge CPU consuming, only sue this method for dynamic templates

Parameters:

strTemplateData - The template as a string

locale - The Locale

rootMap - the model root

Returns:

the processed html template

resetConfiguration

void resetConfiguration()

Clears the configuration cache

resetCache

void resetCache()

Reset the cache

getAutoIncludes

List<String> getAutoIncludes()

Get the list of auto includes files

Returns:

The list or null if no configuration is available

addAutoInclude

void addAutoInclude(String strFile)

Add an auto include file

Parameters:

strFile - The file to add

removeAutoInclude

void removeAutoInclude(String strFile)

Remove an auto include file

Parameters:

strFile - The file to remove