bboss.org.apache.velocity.runtime.directive

类 Include

java.lang.Object

bboss.org.apache.velocity.runtime.directive.Directive

bboss.org.apache.velocity.runtime.directive.InputBase

bboss.org.apache.velocity.runtime.directive.Include

所有已实现的接口:

DirectiveConstants, java.lang.Cloneable

public class Include
extends InputBase

Pluggable directive that handles the #include() statement in VTL. This #include() can take multiple arguments of either StringLiteral or Reference.

Notes:

1. 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.
2. 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...
3. 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.

字段概要

从类继承的字段 bboss.org.apache.velocity.runtime.directive.Directive

rsvc

从接口继承的字段 bboss.org.apache.velocity.runtime.directive.DirectiveConstants

BLOCK, LINE

构造器概要

构造器

构造器和说明
Include()

方法概要

限定符和类型	方法和说明
java.lang.String	getName() Return name of this directive.
int	getType() Return type of this directive.
void	init(RuntimeServices rs, InternalContextAdapter context, Node node) simple init - init the tree and get the elementKey from the AST
boolean	isScopeProvided() Since there is no processing of content, there is never a need for an internal scope.
boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node) iterates through the argument list and renders every argument that is appropriate.

从类继承的方法 bboss.org.apache.velocity.runtime.directive.InputBase

getInputEncoding

从类继承的方法 bboss.org.apache.velocity.runtime.directive.Directive

getColumn, getLine, getScopeName, getTemplateName, makeScope, postRender, preRender, setLocation, setLocation

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Include

public Include()

方法详细资料

getName

public java.lang.String getName()

Return name of this directive.

指定者:

getName 在类中 Directive

返回:

The name of this directive.

getType

public int getType()

Return type of this directive.

指定者:

getType 在类中 Directive

返回:

The type of this directive.

isScopeProvided

public boolean isScopeProvided()

Since there is no processing of content, there is never a need for an internal scope.

覆盖:

isScopeProvided 在类中 Directive

返回:

true if there will be a scope control injected into the context when rendering this directive.

init

public void init(RuntimeServices rs,
                 InternalContextAdapter context,
                 Node node)
          throws TemplateInitException

simple init - init the tree and get the elementKey from the AST

覆盖:

init 在类中 Directive

参数:

rs -

context -

node -

抛出:

TemplateInitException

render

public boolean render(InternalContextAdapter context,
                      java.io.Writer writer,
                      Node node)
               throws java.io.IOException,
                      MethodInvocationException,
                      ResourceNotFoundException

iterates through the argument list and renders every argument that is appropriate. Any non appropriate arguments are logged, but render() continues.

指定者:

render 在类中 Directive

参数:

context -

writer -

node -

返回:

True if the directive rendered successfully.

抛出:

java.io.IOException

MethodInvocationException

ResourceNotFoundException