org.apache.struts2.components.template
Class TemplateEngineManager

java.lang.Object
  extended by org.apache.struts2.components.template.TemplateEngineManager

public class TemplateEngineManager
extends java.lang.Object

The TemplateEngineManager will return a template engine for the template


Field Summary
static java.lang.String DEFAULT_TEMPLATE_TYPE
          The default template extenstion is ftl.
static java.lang.String DEFAULT_TEMPLATE_TYPE_CONFIG_KEY
           
 
Constructor Summary
TemplateEngineManager()
           
 
Method Summary
 TemplateEngine getTemplateEngine(Template template, java.lang.String templateTypeOverride)
          Gets the TemplateEngine for the template name.
 void registerTemplateEngine(java.lang.String templateExtension, TemplateEngine templateEngine)
          Registers the given template engine.
 void setContainer(Container container)
           
 void setDefaultTemplateType(java.lang.String type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_TEMPLATE_TYPE_CONFIG_KEY

public static final java.lang.String DEFAULT_TEMPLATE_TYPE_CONFIG_KEY
See Also:
Constant Field Values

DEFAULT_TEMPLATE_TYPE

public static final java.lang.String DEFAULT_TEMPLATE_TYPE
The default template extenstion is ftl.

See Also:
Constant Field Values
Constructor Detail

TemplateEngineManager

public TemplateEngineManager()
Method Detail

setDefaultTemplateType

public void setDefaultTemplateType(java.lang.String type)

setContainer

public void setContainer(Container container)

registerTemplateEngine

public void registerTemplateEngine(java.lang.String templateExtension,
                                   TemplateEngine templateEngine)
Registers the given template engine.

Will add the engine to the existing list of known engines.

Parameters:
templateExtension - filename extension (eg. .jsp, .ftl, .vm).
templateEngine - the engine.

getTemplateEngine

public TemplateEngine getTemplateEngine(Template template,
                                        java.lang.String templateTypeOverride)
Gets the TemplateEngine for the template name. If the template name has an extension (for instance foo.jsp), then this extension will be used to look up the appropriate TemplateEngine. If it does not have an extension, it will look for a Configuration setting "struts.ui.templateSuffix" for the extension, and if that is not set, it will fall back to "ftl" as the default.

Parameters:
template - Template used to determine which TemplateEngine to return
templateTypeOverride - Overrides the default template type
Returns:
the engine.


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.