au.com.codeka.carrot.tag

Class Tag

java.lang.Object

au.com.codeka.carrot.tag.Tag

Direct Known Subclasses:

BlockTag, EchoTag, ElseTag, EndTag, ExtendsTag, ForTag, IfTag, IncludeTag, SetTag

public abstract class Tag
extends java.lang.Object

Interface that tags must implement.

A tag is a keyword that appears at the beginning of a {% %} block. The tag must have a single-word, lower-case name. If the tag can itself contain content, it must specify the name of the end-tag which ends the tag.

Constructor Summary

Constructors

Constructor and Description
Tag()

Method Summary

Modifier and Type	Method and Description
boolean	canChain(Tag nextTag) Return true if we can chain to the given next Tag.
boolean	isBlockTag()
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 java.lang.Object

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

Constructor Detail

Tag

public Tag()

Method Detail

parseStatement

public void parseStatement(StatementParser stmtParser)
                    throws CarrotException

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

Parameters:

stmtParser - A StatementParser for parsing the statement.

Throws:

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

isBlockTag

public boolean isBlockTag()

Returns:

True if this is a "block" tag, meaning it contains child content (in the form of a list of Nodes) and false if this is not a block tag (e.g. it's just a single inline element or something).

canChain

public boolean canChain(Tag nextTag)

Return true if we can chain to the given next Tag.

Parameters:

nextTag - The next Tag that we want to check whether we can chain to.

Returns:

True if we can chain to the next tag.

render

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

Render this Tag to the given Writer.

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..