Package com.aquima.interactions.framework.renderer.document

Class XmlIgnoreElement

java.lang.Object

com.aquima.interactions.framework.renderer.XmlElement

com.aquima.interactions.framework.renderer.document.XmlIgnoreElement

All Implemented Interfaces:

IElementRenderer, IXmlElementRenderer

public class XmlIgnoreElement
extends XmlElement

This class can be used to render elements that should be ignored.

Ignored elements will be rendered to xml comment, for example:

 <!--Ignoring element 'elementName'-->
 

Since:

7.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Constructor	Description
XmlIgnoreElement()

Method Summary

Modifier and Type	Method	Description
IXmlElement	toXml(IXmlRendererContext ctx, IElement element)	This function allows one to convert an IElement instance to an XML element.

Methods inherited from class com.aquima.interactions.framework.renderer.XmlElement

formatKey, getKeyPrefix, setIncludePresentationStyleElements, setKeyPrefix, setOptionalFormat, setOptionalPresentationStyle

Methods inherited from class java.lang.Object

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

Constructor Details

XmlIgnoreElement

public XmlIgnoreElement()

Method Details

toXml

public IXmlElement toXml(IXmlRendererContext ctx,
 IElement element)

Description copied from interface: IXmlElementRenderer

This function allows one to convert an IElement instance to an XML element. The implementor of this function should only convert the element itself and not it's children as the caller will process these. (Unless ctx.setContinueChildProcessing( false ) has been called)

Parameters:

ctx - The context which contains some information and control options.

element - The element which should be converted.

Returns:

an XMLElement class or null indicating this element should not be included in the resulting xml.