au.com.codeka.carrot.tmpl

Class TagNode

java.lang.Object

au.com.codeka.carrot.tmpl.Node

au.com.codeka.carrot.tmpl.TagNode

public class TagNode
extends Node

A TagNode represents a node of the form "{% tagname foo %}" where "tagname" is the name of the tag and "foo" is the parameters.

Tags are represented by the Tag class, which is extensible.

Constructor Summary

Constructors

Constructor and Description
TagNode(ResourcePointer ptr, Tag tag)

Method Summary

Modifier and Type	Method and Description
boolean	canChain(Node nextNode) Checks whether this Node can chain to the given node.
static TagNode	create(Token token, Configuration config) Creates a TagNode for the given Token.
static TagNode	createEcho(Token token, Configuration config) Creates a special TagNode for an echo token.
Tag	getTag()
boolean	isEndBlock()
void	render(CarrotEngine engine, java.io.Writer writer, Scope scope) Render this node to the given Writer.

Methods inherited from class au.com.codeka.carrot.tmpl.Node

add, chain, getChildren, getNextNode, getPointer, isBlockNode, renderChildren

Methods inherited from class java.lang.Object

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

Constructor Detail

TagNode

public TagNode(ResourcePointer ptr,
               Tag tag)

Method Detail

createEcho

public static TagNode createEcho(Token token,
                                 Configuration config)
                          throws CarrotException

Creates a special TagNode for an echo token.

Parameters:

token - The Token the echo node is going to created from, must have Token.getType() of TokenType.ECHO.

config - The current Configuration.

Returns:

A new TagNode.

Throws:

CarrotException - if there's a problem parsing the token.

create

public static TagNode create(Token token,
                             Configuration config)
                      throws CarrotException

Creates a TagNode for the given Token.

Parameters:

token - The Token the node is going to created from, must have Token.getType() of TokenType.TAG.

config - The current Configuration.

Returns:

A new TagNode.

Throws:

CarrotException - if there's a problem parsing the token.

canChain

public boolean canChain(Node nextNode)

Description copied from class: Node

Checks whether this Node can chain to the given node.

Overrides:

canChain in class Node

Parameters:

nextNode - The Node we want to check.

Returns:

True if we can chain to the following node, false if we cannot.

isEndBlock

public boolean isEndBlock()

Returns:

True if this is an end block (that is, if it ends it's parent's block).

getTag

public Tag getTag()

Returns:

The Tag for this node.

render

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

Description copied from class: Node

Render this node to the given Writer.

Specified by:

render in class Node

Parameters:

engine - The CarrotEngine we're running inside of.

writer - The Writer to write this node to.

scope - The current Scope, containing all our variables.

Throws:

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

java.io.IOException - if there's an error writing to the Writer.