bboss.org.apache.velocity.runtime.directive

类 BlockMacro

java.lang.Object

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

bboss.org.apache.velocity.runtime.directive.Block

bboss.org.apache.velocity.runtime.directive.BlockMacro

所有已实现的接口:

DirectiveConstants, java.lang.Cloneable

public class BlockMacro
extends Block

BlockMacro directive is used to invoke Velocity macros with normal parameters and a macro body.

The macro can then refer to the passed body AST. This directive can be used as a "decorator". Body AST can contain any valid Velocity syntax. An example:

 #set($foobar = "yeah!")
 
 #macro(strong $txt)
 <strong>$bodyContent</strong> $txt
 #end

 #@strong($foobar)
 <u>This text is underlined and bold</u>
 #end
 

Will print:

 <strong><u>This text is underlined and bold<u></strong> yeah!
 

bodyContent reference name is configurable (see velocity.properties).

从以下版本开始:

1.7

嵌套类概要

从类继承的嵌套类/接口 bboss.org.apache.velocity.runtime.directive.Block

Block.Reference

字段概要

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

block, key, log, maxDepth

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

rsvc

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

BLOCK, LINE

构造器概要

构造器

构造器和说明
BlockMacro(java.lang.String name)

方法概要

限定符和类型	方法和说明
java.lang.String	getName() Return the name of this directive.
java.lang.String	getScopeName() Override to use the macro name, since it is within an #@myMacro() ...
void	init(RuntimeServices rs, InternalContextAdapter context, Node node) Initializes the directive.
boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node) Renders content using the selected macro and the passed AST body.

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

getType, id, render

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

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

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

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

构造器详细资料

BlockMacro

public BlockMacro(java.lang.String name)

方法详细资料

getName

public java.lang.String getName()

从类复制的说明: Directive

Return the name of this directive.

指定者:

getName 在类中 Directive

返回:

The name of this directive.

getScopeName

public java.lang.String getScopeName()

Override to use the macro name, since it is within an #@myMacro() ... #end block that the scope in question would be used.

覆盖:

getScopeName 在类中 Directive

init

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

Initializes the directive.

覆盖:

init 在类中 Block

参数:

rs -

context -

node -

抛出:

TemplateInitException

render

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

Renders content using the selected macro and the passed AST body.

指定者:

render 在类中 Directive

参数:

context -

writer -

node -

返回:

True if the directive rendered successfully.

抛出:

java.io.IOException