uk.ac.ed.ph.snuggletex.dombuilding

Class AbstractCustomXMLElementHandler

java.lang.Object

uk.ac.ed.ph.snuggletex.dombuilding.AbstractCustomXMLElementHandler

All Implemented Interfaces:

CommandHandler, EnvironmentHandler

Direct Known Subclasses:

XMLBlockElementHandler, XMLInlineElementHandler

public abstract class AbstractCustomXMLElementHandler
extends Object
implements EnvironmentHandler, CommandHandler

Provides base functionality for the commands and environments that build custom XML elements.

Version:

$Revision$

Author:

David McKain

Constructor Summary

Constructors

Constructor and Description
AbstractCustomXMLElementHandler()

Method Summary

Modifier and Type	Method and Description
protected void	buildCustomElement(DOMBuilder builder, Element parentElement, ArgumentContainerToken attrsToken, ArgumentContainerToken namespaceToken, ArgumentContainerToken qNameToken, ArgumentContainerToken contentToken)
void	handleCommand(DOMBuilder builder, Element parentElement, CommandToken token) Called when a CommandToken is being handled by the DOMBuilder.
void	handleEnvironment(DOMBuilder builder, Element parentElement, EnvironmentToken token) Called when a CommandToken is being handled by the DOMBuilder.
protected abstract boolean	isBlock() Subclasses should fill in to return true if they are building a block element or false if they are building an inline element.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCustomXMLElementHandler

public AbstractCustomXMLElementHandler()

Method Detail

isBlock

protected abstract boolean isBlock()

Subclasses should fill in to return true if they are building a block element or false if they are building an inline element.

handleEnvironment

public void handleEnvironment(DOMBuilder builder,
                              Element parentElement,
                              EnvironmentToken token)
                       throws SnuggleParseException

Description copied from interface: EnvironmentHandler

Called when a CommandToken is being handled by the DOMBuilder.

Specified by:

handleEnvironment in interface EnvironmentHandler

Parameters:

builder - DOMBuilder running this process, which provides access to convenience method for appending Nodes to the DOM

parentElement - parent Element that the resulting Nodes should (can) be added to

token - Token representing the environment being processed.

Throws:

SnuggleParseException

handleCommand

public void handleCommand(DOMBuilder builder,
                          Element parentElement,
                          CommandToken token)
                   throws SnuggleParseException

Description copied from interface: CommandHandler

Called when a CommandToken is being handled by the DOMBuilder.

Specified by:

handleCommand in interface CommandHandler

Parameters:

builder - DOMBuilder running this process, which provides access to convenience method for appending Nodes to the DOM

parentElement - parent Element that the resulting Nodes should (can) be added to

token - Token representing the command being processed.

Throws:

SnuggleParseException - to indicate a client error

buildCustomElement

protected void buildCustomElement(DOMBuilder builder,
                                  Element parentElement,
                                  ArgumentContainerToken attrsToken,
                                  ArgumentContainerToken namespaceToken,
                                  ArgumentContainerToken qNameToken,
                                  ArgumentContainerToken contentToken)
                           throws SnuggleParseException

Throws:

SnuggleParseException