com.tridion.tcdl

Interface TCDLParserEventListener

All Known Implementing Classes:

TagDispatcher

public interface TCDLParserEventListener

Callbacks to be used with the TCDLParser to get notified of encountered tags and (tag) content.

Method Summary

Modifier and Type	Method and Description
boolean	afterBody(Tag tag) Called by the TCDLParser if body of a Tag require reevaluation.
void	elementData(String data, boolean directlyAfterTag) Called for elementData occurring between tags (or before and after tcdl tags) The boolean directlyAfterTag indicates if this elementData occured immediately after a tag (that was accepted by startTag) to help with whitespace issues, e.g.
void	endDocument() Called by the TCDLParser just after finishing the parsing process.
boolean	endTag(Tag tag) Called by the TCDLParser as soon as it encounters a tcdl closing tag.It also gets called if the tag uses short notation (e.g.
void	startDocument() Called by the TCDLParser just before starting the parsing process.
boolean	startTag(Tag tag) Called by the TCDLParser as soon as it encounters a tcdl opening tag.

Method Detail

startTag

boolean startTag(Tag tag)
          throws TCDLTransformerException

Called by the TCDLParser as soon as it encounters a tcdl opening tag. It also gets called if the tag uses short notation (e.g. )

Parameters:

tag - Tag that was encountered by the TCDLParser

Returns:

false if the tag should re-appear in the content

Throws:

TCDLTransformerException - if there was a problem processing the tag

TCDLTransformerException

endTag

boolean endTag(Tag tag)
        throws TCDLTransformerException

Called by the TCDLParser as soon as it encounters a tcdl closing tag.It also gets called if the tag uses short notation (e.g. ). Note that the Tag does not contain attributes that were set on the opening tag if the tag is not using short notation.

Parameters:

tag - Tag that was encountered by the TCDLParser

Returns:

false if the tag should re-appear in the content

Throws:

TCDLTransformerException - if there was a problem processing the tag

TCDLTransformerException

elementData

void elementData(String data,
                 boolean directlyAfterTag)
          throws TCDLTransformerException

Called for elementData occurring between tags (or before and after tcdl tags) The boolean directlyAfterTag indicates if this elementData occured immediately after a tag (that was accepted by startTag) to help with whitespace issues, e.g. whitespace filtering when desired should only be done if this flag is true.

Parameters:

data - the element data occurring between tags

directlyAfterTag - indicates if the data occurred immediately after a valid tag, to help decide about whitespace.

Throws:

TCDLTransformerException - in case of errors.

TCDLTransformerException

startDocument

void startDocument()
            throws TCDLTransformerException

Called by the TCDLParser just before starting the parsing process.

Throws:

TCDLTransformerException - if the processing cannot continue for some reason.

TCDLTransformerException

endDocument

void endDocument()
          throws TCDLTransformerException

Called by the TCDLParser just after finishing the parsing process.

Throws:

TCDLTransformerException - if the processing should not continue for some reason.

TCDLTransformerException

afterBody

boolean afterBody(Tag tag)
           throws TCDLTransformerException

Called by the TCDLParser if body of a Tag require reevaluation. It is specially applicable in the context where a TagHandler supports iteration, that is, it implements IterationTagSupport. If reevaluation is not needed, then just return false.

Throws:

TCDLTransformerException - if the processing should not continue for some reason.

TCDLTransformerException