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