au.com.codeka.carrot.tag

Class IncludeTag

java.lang.Object

au.com.codeka.carrot.tag.Tag

au.com.codeka.carrot.tag.IncludeTag

public class IncludeTag
extends Tag

The "include" tag is used to include the contents of another template.

Using the include tag is very simple:

 {% include "foo.html" %}
 

Constructor Summary

Constructors

Constructor and Description
IncludeTag()

Method Summary

Modifier and Type	Method and Description
void	parseStatement(StatementParser stmtParser) Parse the statement that appears after the tag in the markup.
void	render(CarrotEngine engine, java.io.Writer writer, TagNode tagNode, Scope scope) Render this Tag to the given Writer.

Methods inherited from class au.com.codeka.carrot.tag.Tag

canChain, isBlockTag

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeTag

public IncludeTag()

Method Detail

parseStatement

public void parseStatement(StatementParser stmtParser)
                    throws CarrotException

Description copied from class: Tag

Parse the statement that appears after the tag in the markup. This is guaranteed to be called before Tag.isBlockTag() or Tag.canChain(Tag).

Overrides:

parseStatement in class Tag

Parameters:

stmtParser - A StatementParser for parsing the statement.

Throws:

CarrotException - if there is an unrecoverable error parsing the statement.

render

public void render(CarrotEngine engine,
                   java.io.Writer writer,
                   TagNode tagNode,
                   Scope scope)
            throws CarrotException,
                   java.io.IOException

Description copied from class: Tag

Render this Tag to the given Writer.

Overrides:

render in class Tag

Parameters:

engine - The current CarrotEngine.

writer - The Writer to render to.

tagNode - The TagNode that we're enclosed in. You can use this to render the children, or query the children or whatever.

scope - The current Scope.

Throws:

CarrotException - if there's an error parsing or rendering the template

java.io.IOException - when there's an error writing to the Writer (basically this is just passed on from whatever errors the Writer might throw..