| org.apache.velocity.app.event.IncludeEventHandler
All known Subclasses: org.apache.velocity.test.eventhandler.Handler1, org.apache.velocity.test.misc.ExceptionGeneratingEventHandler, org.apache.velocity.test.eventhandler.Handler2, org.apache.velocity.app.event.implement.IncludeNotFound, org.apache.velocity.test.IncludeEventHandlingTestCase, org.apache.velocity.app.event.implement.IncludeRelativePath,
| IncludeEventHandler | | public interface IncludeEventHandler extends EventHandler(Code) | | Event handler for include type directives (e.g. #include(), #parse())
Allows the developer to modify the path of the resource returned.
author:
Will Glass-Husain
version:
$Id: IncludeEventHandler.java 463298 2006-10-12 16:10:32Z henning $ |
| Method Summary | |
| public String | includeEvent(String includeResourcePath, String currentResourcePath, String directiveName)
Called when an include-type directive is encountered (
#include or #parse). |
| includeEvent | | public String includeEvent(String includeResourcePath, String currentResourcePath, String directiveName)(Code) | | 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.
Parameters:
includeResourcePath - the path as given in the include directive.
Parameters:
currentResourcePath - the path of the currently rendering template that includes theinclude directive.
Parameters:
directiveName - name of the directive used to include the resource. (With thestandard directives this is either "parse" or "include"). a new resource path for the directive, or null to block theinclude from occurring. |
|
|