Package com.aquima.interactions.framework.renderer.page.r6

Class XmlImage

java.lang.Object

com.aquima.interactions.framework.renderer.XmlElement

com.aquima.interactions.framework.renderer.page.r6.XmlImage

All Implemented Interfaces:

IElementRenderer, IXmlElementRenderer

public class XmlImage
extends XmlElement

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

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

 <image-item name="imageName" height="10" width="10"/>
 

Since:

7.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Constructor	Description
XmlImage()

Method Summary

Modifier and Type	Method	Description
protected void	handleImageData(IImage image, IXmlElement xmlElement)	Method that is before returning the created xml element.
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

XmlImage

public XmlImage()

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.

handleImageData

protected void handleImageData(IImage image,
 IXmlElement xmlElement)

Method that is before returning the created xml element.

Override this method to overrule the default behaviour, for example when the image data should be renderer to xml.

Parameters:

image - The image containing the data.

xmlElement - The "image-item" xml element.