View Javadoc

1   /*
2    * $Id: TemplateEngine.java 418521 2006-07-01 23:36:50Z mrdon $
3    *
4    * Copyright 2006 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *      http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.struts2.components.template;
19  
20  import java.util.Map;
21  
22  /***
23   * Any template language which wants to support UI tag templating needs to provide an implementation of this interface
24   * to handle rendering the template
25   */
26  public interface TemplateEngine {
27  
28      /***
29       * Renders the template
30       * @param templateContext  context for the given template.
31       * @throws Exception is thrown if there is a failure when rendering.
32       */
33      void renderTemplate(TemplateRenderingContext templateContext) throws Exception;
34  
35      /***
36       * Get's the properties for the given template.
37       *
38       * @param template   the template.
39       * @return  the properties as key value pairs.
40       */
41      Map getThemeProps(Template template);
42      
43  }