bboss.org.apache.velocity.app.event

接口 IncludeEventHandler

所有超级接口:

EventHandler

所有已知实现类:

IncludeNotFound, IncludeRelativePath

public interface IncludeEventHandler
extends EventHandler

Event handler for include type directives (e.g. #include(), #parse()) Allows the developer to modify the path of the resource returned.

从以下版本开始:

1.5

嵌套类概要

嵌套类

限定符和类型	接口和说明
static class	IncludeEventHandler.IncludeEventExecutor Defines the execution strategy for includeEvent

方法概要

限定符和类型	方法和说明
java.lang.String	includeEvent(java.lang.String includeResourcePath, java.lang.String currentResourcePath, java.lang.String directiveName) Called when an include-type directive is encountered ( #include or #parse).

方法详细资料

includeEvent

java.lang.String includeEvent(java.lang.String includeResourcePath,
                              java.lang.String currentResourcePath,
                              java.lang.String directiveName)

Called when an include-type directive is encountered ( #include or #parse). May modify the path of the resource to be included or may block the include entirely. All the registered IncludeEventHandlers are called unless null is returned. If none are registered the template at the includeResourcePath is retrieved.

参数:

includeResourcePath - the path as given in the include directive.

currentResourcePath - the path of the currently rendering template that includes the include directive.

directiveName - name of the directive used to include the resource. (With the standard directives this is either "parse" or "include").

返回:

a new resource path for the directive, or null to block the include from occurring.