au.com.codeka.carrot.tag

Class BlockTag

java.lang.Object

au.com.codeka.carrot.tag.Tag

au.com.codeka.carrot.tag.BlockTag

public class BlockTag
extends Tag

The {% block %} tag is used in conjunction with {% extends %}. See ExtendsTag for details.

Constructor Summary

Constructors

Constructor and Description
BlockTag()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBlockName(CarrotEngine carrotEngine, Scope scope)
boolean	isBlockTag()
void	parseStatement(StatementParser statementParser) 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

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockTag

public BlockTag()

Method Detail

isBlockTag

public boolean isBlockTag()

Overrides:

isBlockTag in class Tag

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

parseStatement

public void parseStatement(StatementParser statementParser)
                    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:

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

getBlockName

public java.lang.String getBlockName(CarrotEngine carrotEngine,
                                     Scope scope)
                              throws CarrotException

Throws:

CarrotException