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

java.lang.Object
  extended by fr.paris.lutece.portal.service.template.AppTemplateService

public final class AppTemplateService
extends java.lang.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
static fr.paris.lutece.util.html.HtmlTemplate getTemplate(java.lang.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(java.lang.String strTemplate, java.util.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(java.lang.String strTemplate, java.util.Locale locale, java.lang.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(java.lang.String strTemplate, java.lang.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(java.lang.String strTemplate, java.lang.String strPath, java.util.Locale locale, java.lang.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(java.lang.String strFreemarkerTemplateData, java.util.Locale locale, java.lang.Object model)
          Deprecated. 
static void init(java.lang.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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

init

public static void init(java.lang.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(java.lang.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(java.lang.String strTemplate,
                                                                 java.lang.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(java.lang.String strTemplate,
                                                                 java.util.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(java.lang.String strTemplate,
                                                                 java.util.Locale locale,
                                                                 java.lang.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(java.lang.String strTemplate,
                                                                 java.lang.String strPath,
                                                                 java.util.Locale locale,
                                                                 java.lang.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

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

Returns a reference on a template object
Deprecated Using Freemarker without cache is huge CPU consuming

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


Copyright © 2012 Mairie de Paris. All Rights Reserved.