Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright (c) 1997-2013, www.tinygroup.org (tinygroup@126.com). Licensed under the GPL, Version 3.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.gnu.org/licenses/gpl.html Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
 package org.tinygroup.template;
 
 import java.io.Writer;
 import java.util.List;

模板引擎 Created by luoguo on 2014/6/6.
 
 
 public interface TemplateEngine extends TemplateContextOperator {
     String getEngineId();
     void setEngineId(String engineId);
    
设置模板加载器列表

Parameters:
resourceLoaderList
 
     void setResourceLoaderList(List<ResourceLoaderresourceLoaderList);
 
     void setSafeVariable(boolean safeVariable);
 
     boolean isSafeVariable();

    
返回是否是紧凑模式

Returns:
 
     boolean isCompactMode();

    
设置是否是紧凑模式

Parameters:
compactMode
 
     void setCompactMode(boolean compactMode);

    
设置编码

Parameters:
encode
Returns:
 
     TemplateEngine setEncode(String encode);

    
设置

Parameters:
i18nVistor
 
     TemplateEngine setI18nVisitor(I18nVisitor i18nVistor);

    
返回国际化访问接口实现类

Returns:
 
     I18nVisitor getI18nVisitor();

    
添加函数

Parameters:
function
 
返回注册的方法

Parameters:
methodName 注册的方法名
Returns:
 
     TemplateFunction getTemplateFunction(String methodName);

    
返回注册的方法

Parameters:
methodName 注册的方法名
Returns:
 
     TemplateFunction getTemplateFunction(Object objectString methodName);

    
返回编码

Returns:
    String getEncode();

    
添加类型加载器

Parameters:
resourceLoader
    TemplateEngine addResourceLoader(ResourceLoader resourceLoader);

    
返回所有的 Loader

Returns:
渲染宏

Parameters:
macroName 要执行的宏名称
template 调用宏的模板
context 上下文
writer 输出器
    void renderMacro(String macroNameTemplate templateTemplateContext contextWriter writerthrows IOExceptionTemplateException;

    
渲染指定的宏

Parameters:
macro 要执行的宏
template 调用宏的模板
context 上下文
writer 输出器
Throws:
java.io.IOException
TemplateException
    void renderMacro(Macro macroTemplate templateTemplateContext contextWriter writerthrows IOExceptionTemplateException;


    
根据路径渲染一个模板文件,如果有布局会同时渲染布局

Parameters:
path 模板对应的路径
context 上下文
writer 输出器
    void renderTemplate(String pathTemplateContext contextWriter writerthrows TemplateException;

    
根据路径渲染一个模板文件,但不会渲染布局

Parameters:
path
context
writer
Throws:
TemplateException
    void renderTemplateWithOutLayout(String pathTemplateContext contextWriter writerthrows TemplateException;


    
采用没有上下文,控制台输出方式进行渲染,如果有布局会同时渲染布局

Parameters:
path
Throws:
TemplateException
    void renderTemplate(String paththrows TemplateException;

    
采用没有上下文,控制台输出方式进行渲染,主要用于测试

Parameters:
template
Throws:
TemplateException
    void renderTemplate(Template templatethrows TemplateException;

    
直接渲染一个模板,不会应用布局

Parameters:
template 要渲染的模板
context 上下文
writer 输出器
Throws:
TemplateException
    void renderTemplate(Template templateTemplateContext contextWriter writerthrows TemplateException;

    
根据宏名查找要调用的宏

Parameters:
macroName
template
context
Returns:
Throws:
TemplateException
    Macro findMacro(Object macroNameTemplate templateTemplateContext contextthrows TemplateException;

    
根据路径查找宏

Parameters:
path
Returns:
Throws:
TemplateException
    Template findTemplate(String paththrows TemplateException;

    
执行方法

Parameters:
functionName
parameters
Returns:
Throws:
TemplateException
    Object executeFunction(Template templateTemplateContext contextString functionNameObject... parametersthrows TemplateException;

    
获取资源对应的文本

Parameters:
path
Returns:
    String getResourceContent(String pathString encodethrows TemplateException;

    
获取指定路径资源的内容

Parameters:
path
Returns:
Throws:
TemplateException
    String getResourceContent(String paththrows TemplateException;

    
返回是否允许缓冲

Returns:
    boolean isCacheEnabled();

    
设置是否允许缓冲

Parameters:
cacheEnabled
Returns:
    TemplateEngine setCacheEnabled(boolean cacheEnabled);

    
注册库文件中所有的宏

Parameters:
path
    void registerMacroLibrary(String paththrows TemplateException;

    
注册单个宏

Parameters:
macro
Throws:
TemplateException
    void registerMacro(Macro macrothrows TemplateException;

    
注册模板文件中所有的宏

Parameters:
template
Throws:
TemplateException
    void registerMacroLibrary(Template templatethrows TemplateException;
New to GrepCode? Check out our FAQ X