org.apache.struts2.components.template

## Interface TemplateEngine

- All Known Implementing Classes:
    BaseTemplateEngine, FreemarkerTemplateEngine, JspTemplateEngine

      public interface TemplateEngine

  Any template language which wants to support UI tag templating needs to provide an implementation of this interface to handle rendering the template

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Map` | `getThemeProps(Template template)` Get's the properties for the given template.
    `void` | `renderTemplate(TemplateRenderingContext templateContext)` Renders the template

- - ### Method Detail

    - #### renderTemplate

          void renderTemplate(TemplateRenderingContext templateContext)
                       throws Exception

      Renders the template
      Parameters:
        `templateContext` - context for the given template.
      Throws:
        `Exception` - is thrown if there is a failure when rendering.

    - #### getThemeProps

          Map getThemeProps(Template template)

      Get's the properties for the given template.
      Parameters:
        `template` - the template.
      Returns:
        the properties as key value pairs.

Copyright © 2000–2024 Apache Software Foundation. All rights reserved.