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

Class XmlImage

java.lang.Object

com.aquima.interactions.framework.renderer.XmlElement

com.aquima.interactions.framework.renderer.document.XmlDocumentRendererBase

com.aquima.interactions.framework.renderer.document.XmlImage

All Implemented Interfaces:

IElementRenderer, IXmlElementRenderer

public class XmlImage
extends XmlDocumentRendererBase

This class converts an IImage implementation to an XML node for document xml generation.

For example rendering an image with a height and width will result in:

 <IMAGE name="imageName" height="20" width="10"/>
 

Note that the binary image data is not rendered to xml.

Since:

7.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlImage(boolean tagsToUpperCase)

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.document.XmlDocumentRendererBase

createTagName

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

XmlImage

protected XmlImage(boolean tagsToUpperCase)

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.