| java.lang.Object
 org.apache.velocity.runtime.directive.Directive
org.apache.velocity.runtime.directive.InputBase
org.apache.velocity.runtime.directive.Include
| Include | | public class Include extends InputBase (Code) | | Pluggable directive that handles the #include() statement in VTL.
This #include() can take multiple arguments of either
StringLiteral or Reference.
Notes:
- For security reasons, the included source material can only come
from somewhere within the template root tree. If you want to include
content from elsewhere on your disk, add extra template roots, or use
a link from somwhere under template root to that content.
- By default, there is no output to the render stream in the event of
a problem. You can override this behavior with two property values :
include.output.errormsg.start
include.output.errormsg.end
If both are defined in velocity.properties, they will be used to
in the render output to bracket the arg string that caused the
problem.
Ex. : if you are working in html then
include.output.errormsg.start=<!-- #include error :
include.output.errormsg.end= -->
might be an excellent way to start...
- As noted above, #include() can take multiple arguments.
Ex : #include('foo.vm' 'bar.vm' $foo)
will include all three if valid to output without any
special separator.
author:
Geir Magnusson Jr.
author:
Jason van Zyl
author:
Kasper Nielsen
version:
$Id: Include.java 471381 2006-11-05 08:56:58Z wglass $ |
| getName | | public String getName()(Code) | | Return name of this directive.
The name of this directive. |
| getType | | public int getType()(Code) | | Return type of this directive.
The type of this directive. |
|
|