fr.paris.lutece.portal.service.template

Class AppTemplateService

java.lang.Object

fr.paris.lutece.portal.service.template.AppTemplateService

public final class AppTemplateService
extends Object

This Service is used to retreive HTML templates, stored as files in the WEB-INF/templates directory of the webapp, to build the user interface. It provides a cache feature to prevent from loading file each time it is asked.

Method Summary

Modifier and Type	Method and Description
static fr.paris.lutece.util.html.HtmlTemplate	getTemplate(String strTemplate) Returns a reference on a template object (load the template or get it from the cache if present.)
static fr.paris.lutece.util.html.HtmlTemplate	getTemplate(String strTemplate, Locale locale) Returns a reference on a template object (load the template or get it from the cache if present.)
static fr.paris.lutece.util.html.HtmlTemplate	getTemplate(String strTemplate, Locale locale, Object model) Returns a reference on a template object (load the template or get it from the cache if present.)
static fr.paris.lutece.util.html.HtmlTemplate	getTemplate(String strTemplate, String strPath) Returns a reference on a template object (load the template or get it from the cache if present.)
static fr.paris.lutece.util.html.HtmlTemplate	getTemplate(String strTemplate, String strPath, Locale locale, Object model) Returns a reference on a template object (load the template or get it from the cache if present.)
static fr.paris.lutece.util.html.HtmlTemplate	getTemplateFromStringFtl(String strFreemarkerTemplateData, Locale locale, Object model) Returns a reference on a template object Using Freemarker without cache is huge CPU consuming, , only user this method for dynamic templates
static void	init(String strTemplatePath) Initializes the service with the templates's path
static void	initAutoIncludes() Initializes autoincludes for plugins.
static void	resetCache() Reset the cache
static void	resetConfiguration() Resets the configuration cache

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

init

public static void init(String strTemplatePath)

Initializes the service with the templates's path

Parameters:

strTemplatePath - The template path

initAutoIncludes

public static void initAutoIncludes()

Initializes autoincludes for plugins.

resetCache

public static void resetCache()

Reset the cache

resetConfiguration

public static void resetConfiguration()

Resets the configuration cache

getTemplate

public static fr.paris.lutece.util.html.HtmlTemplate getTemplate(String strTemplate)

Returns a reference on a template object (load the template or get it from the cache if present.)

Parameters:

strTemplate - The name of the template

Returns:

The template object.

getTemplate

public static fr.paris.lutece.util.html.HtmlTemplate getTemplate(String strTemplate,
                                                                 String strPath)

Returns a reference on a template object (load the template or get it from the cache if present.)

Parameters:

strTemplate - The name of the template

strPath - The specific path to load the template

Returns:

The template object.

Since:

1.3.1

getTemplate

public static fr.paris.lutece.util.html.HtmlTemplate getTemplate(String strTemplate,
                                                                 Locale locale)

Returns a reference on a template object (load the template or get it from the cache if present.)

Parameters:

strTemplate - The name of the template

locale - The current locale to localize the template

Returns:

The template object.

Since:

1.5

getTemplate

public static fr.paris.lutece.util.html.HtmlTemplate getTemplate(String strTemplate,
                                                                 Locale locale,
                                                                 Object model)

Returns a reference on a template object (load the template or get it from the cache if present.)

Parameters:

strTemplate - The name of the template

locale - The current locale to localize the template

model - the model to use for loading

Returns:

The template object.

Since:

1.5

getTemplate

public static fr.paris.lutece.util.html.HtmlTemplate getTemplate(String strTemplate,
                                                                 String strPath,
                                                                 Locale locale,
                                                                 Object model)

Returns a reference on a template object (load the template or get it from the cache if present.)

Parameters:

strTemplate - The name of the template

strPath - The specific path to load the template

locale - The current locale to localize the template

model - the model to use for loading

Returns:

The template object.

Since:

1.5

getTemplateFromStringFtl

public static fr.paris.lutece.util.html.HtmlTemplate getTemplateFromStringFtl(String strFreemarkerTemplateData,
                                                                              Locale locale,
                                                                              Object model)

Returns a reference on a template object
Using Freemarker without cache is huge CPU consuming, , only user this method for dynamic templates

Parameters:

strFreemarkerTemplateData - The content of the template

locale - The current Locale to localize the template

model - The model

Returns:

The template object

Since:

1.5