bboss.org.apache.velocity.runtime.directive

类 Directive

java.lang.Object

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

所有已实现的接口:

DirectiveConstants, java.lang.Cloneable

直接已知子类:

Block, Break, Evaluate, Foreach, InputBase, Literal, Macro, RuntimeMacro, Stop, VelocimacroProxy

public abstract class Directive
extends java.lang.Object
implements DirectiveConstants, java.lang.Cloneable

Base class for all directives used in Velocity.

字段概要

字段

限定符和类型	字段和说明
protected RuntimeServices	rsvc

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

BLOCK, LINE

构造器概要

构造器

构造器和说明
Directive()

方法概要

限定符和类型	方法和说明
int	getColumn() for log msg purposes
int	getLine() for log msg purposes
abstract java.lang.String	getName() Return the name of this directive.
java.lang.String	getScopeName()
java.lang.String	getTemplateName()
abstract int	getType() Get the directive type BLOCK/LINE.
void	init(RuntimeServices rs, InternalContextAdapter context, Node node) How this directive is to be initialized.
boolean	isScopeProvided()
protected Scope	makeScope(java.lang.Object prev)
protected void	postRender(InternalContextAdapter context) This cleans up any scope control for this directive after rendering, assuming the scope control was turned on.
protected void	preRender(InternalContextAdapter context) This creates and places the scope control for this directive into the context (if scope provision is turned on).
abstract boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node) How this directive is to be rendered
void	setLocation(int line, int column) Allows the template location to be set.
void	setLocation(int line, int column, java.lang.String templateName) Allows the template location to be set.

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

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

字段详细资料

rsvc

protected RuntimeServices rsvc

构造器详细资料

Directive

public Directive()

方法详细资料

getName

public abstract java.lang.String getName()

Return the name of this directive.

返回:

The name of this directive.

getType

public abstract int getType()

Get the directive type BLOCK/LINE.

返回:

The directive type BLOCK/LINE.

setLocation

public void setLocation(int line,
                        int column)

Allows the template location to be set.

参数:

line -

column -

setLocation

public void setLocation(int line,
                        int column,
                        java.lang.String templateName)

Allows the template location to be set.

参数:

line -

column -

getLine

public int getLine()

for log msg purposes

返回:

The current line for log msg purposes.

getColumn

public int getColumn()

for log msg purposes

返回:

The current column for log msg purposes.

getTemplateName

public java.lang.String getTemplateName()

返回:

The template file name this directive was defined in, or null if not defined in a file.

getScopeName

public java.lang.String getScopeName()

isScopeProvided

public boolean isScopeProvided()

返回:

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

How this directive is to be initialized.

参数:

rs -

context -

node -

抛出:

TemplateInitException

render

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

How this directive is to be rendered

参数:

context -

writer -

node -

返回:

True if the directive rendered successfully.

抛出:

java.io.IOException

ResourceNotFoundException

ParseErrorException

MethodInvocationException

preRender

protected void preRender(InternalContextAdapter context)

This creates and places the scope control for this directive into the context (if scope provision is turned on).

makeScope

protected Scope makeScope(java.lang.Object prev)

postRender

protected void postRender(InternalContextAdapter context)

This cleans up any scope control for this directive after rendering, assuming the scope control was turned on.