Top Description Constructors Methods
uk.ac.ed.ph.snuggletex.dombuilding

public abstract Class AbstractCustomXMLElementHandler

extends Object
implements EnvironmentHandler, CommandHandler
Class Inheritance
All Implemented Interfaces
uk.ac.ed.ph.snuggletex.dombuilding.CommandHandler, uk.ac.ed.ph.snuggletex.dombuilding.EnvironmentHandler
Known Direct Subclasses
uk.ac.ed.ph.snuggletex.dombuilding.XMLBlockElementHandler, uk.ac.ed.ph.snuggletex.dombuilding.XMLInlineElementHandler
Imports
uk.ac.ed.ph.snuggletex.definitions.CoreErrorCode, .CorePackageDefinitions, uk.ac.ed.ph.snuggletex.internal.DOMBuilder, .SnuggleParseException, uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken, .CommandToken, .EnvironmentToken, .FlowToken, .SimpleToken, .TokenType, org.w3c.dom.DOMException, .Element
Provides base functionality for the commands and environments that build custom XML elements.
Author
David McKain
Version
$Revision$

Constructor Summary

AccessConstructor and Description
public
AbstractCustomXMLElementHandler()

Method Summary

Modifier and TypeMethod and Description
protected void
buildCustomElement(final DOMBuilder builder, final Element parentElement, final ArgumentContainerToken attrsToken, final ArgumentContainerToken namespaceToken, final ArgumentContainerToken qNameToken, final ArgumentContainerToken contentToken)

private void
extractAttributes(final DOMBuilder builder, final Element parentElement, final Element resultElement, final ArgumentContainerToken attrsToken)

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

Implements uk.ac.ed.ph.snuggletex.dombuilding.CommandHandler.handleCommand.

Called when a CommandToken is being handled by the DOMBuilder.

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

Implements uk.ac.ed.ph.snuggletex.dombuilding.EnvironmentHandler.handleEnvironment.

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.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AbstractCustomXMLElementHandlerback to summary
public AbstractCustomXMLElementHandler()

Method Detail

buildCustomElementback to summary
protected void buildCustomElement(final DOMBuilder builder, final Element parentElement, final ArgumentContainerToken attrsToken, final ArgumentContainerToken namespaceToken, final ArgumentContainerToken qNameToken, final ArgumentContainerToken contentToken) throws SnuggleParseException
extractAttributesback to summary
private void extractAttributes(final DOMBuilder builder, final Element parentElement, final Element resultElement, final ArgumentContainerToken attrsToken) throws SnuggleParseException
handleCommandback to summary
public void handleCommand(final DOMBuilder builder, final Element parentElement, final CommandToken token) throws SnuggleParseException

Implements uk.ac.ed.ph.snuggletex.dombuilding.CommandHandler.handleCommand.

Doc from uk.ac.ed.ph.snuggletex.dombuilding.CommandHandler.handleCommand.

Called when a CommandToken is being handled by the DOMBuilder.

Exceptions
SnuggleParseException:
to indicate a client error
handleEnvironmentback to summary
public void handleEnvironment(final DOMBuilder builder, final Element parentElement, final EnvironmentToken token) throws SnuggleParseException

Implements uk.ac.ed.ph.snuggletex.dombuilding.EnvironmentHandler.handleEnvironment.

Doc from uk.ac.ed.ph.snuggletex.dombuilding.EnvironmentHandler.handleEnvironment.

Called when a CommandToken is being handled by the DOMBuilder.

isBlockback to summary
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.