bboss.org.apache.velocity.runtime.directive

Class Define

java.lang.Object

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

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

bboss.org.apache.velocity.runtime.directive.Define

All Implemented Interfaces:

DirectiveConstants, java.lang.Cloneable

public class Define
extends Block

Directive that puts an unrendered AST block in the context under the specified key, postponing rendering until the reference is used and rendered.

Nested Class Summary

Nested classes/interfaces inherited from class bboss.org.apache.velocity.runtime.directive.Block

Block.Reference

Field Summary

Fields inherited from class bboss.org.apache.velocity.runtime.directive.Block

block, key, log, maxDepth

Fields inherited from class bboss.org.apache.velocity.runtime.directive.Directive

rsvc

Fields inherited from interface bboss.org.apache.velocity.runtime.directive.DirectiveConstants

BLOCK, LINE

Constructor Summary

Constructors

Constructor and Description
Define()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Return name of this directive.
void	init(RuntimeServices rs, InternalContextAdapter context, Node node) simple init - get the key
boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node) directive.render() simply makes an instance of the Block inner class and places it into the context as indicated.

Methods inherited from class bboss.org.apache.velocity.runtime.directive.Block

getType, id, render

Methods inherited from class bboss.org.apache.velocity.runtime.directive.Directive

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Define

public Define()

Method Detail

getName

public java.lang.String getName()

Return name of this directive.

Specified by:

getName in class Directive

Returns:

The name of this directive.

init

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

simple init - get the key

Overrides:

init in class Block

Throws:

TemplateInitException

render

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

directive.render() simply makes an instance of the Block inner class and places it into the context as indicated.

Specified by:

render in class Directive

Returns:

True if the directive rendered successfully.