OpenSymphony - TemplateEngineManager (WebWork API

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.opensymphony.webwork.components.template
Class TemplateEngineManager

java.lang.Object
  com.opensymphony.webwork.components.template.TemplateEngineManager

public class TemplateEngineManager
extends Object
extends Object

The TemplateEngineManager will return a template engine for the template

Author:: jcarreira

Field Summary

static String DEFAULT_TEMPLATE_TYPE
          The default template extenstion is ftl.

static String DEFAULT_TEMPLATE_TYPE_CONFIG_KEY


Method Summary

static TemplateEngine getTemplateEngine(Template template, String templateTypeOverride)
          Gets the TemplateEngine for the template name.

static void registerTemplateEngine(String templateExtension, TemplateEngine templateEngine)
          Registers the given template engine.

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 String DEFAULT_TEMPLATE_TYPE_CONFIG_KEY

See Also:: Constant Field Values

DEFAULT_TEMPLATE_TYPE

public static final String DEFAULT_TEMPLATE_TYPE

The default template extenstion is ftl.

See Also:: Constant Field Values

Method Detail

registerTemplateEngine

public static void registerTemplateEngine(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 static TemplateEngine getTemplateEngine(Template template,
                                               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 "webwork.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.