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

Class XmlContainer

java.lang.Object

com.aquima.interactions.framework.renderer.XmlElement

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

com.aquima.interactions.framework.renderer.document.XmlContainer

All Implemented Interfaces:

IElementRenderer, IXmlElementRenderer

Direct Known Subclasses:

XmlListContainer

public class XmlContainer
extends XmlDocumentRendererBase

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

Since IContainer is a composite element all its children will be renderer to xml as well.

For example rendering a container with a content style "container" will result in:

 <CONTAINER/>
 

For example rendering a container with a content style "row" will result in:

 <ROW/>
 

For example rendering a container with a presentation style will result in:

 <CONTAINER style="style"/>
 

For example rendering a container with a display text will result in:

 <CONTAINER>
   <CONTAINER-DISPLAY-TEXT>
     <TEXT>
       <T>This is the display text</T>
     </TEXT>
   </CONTAINER-DISPLAY-TEXT>
 </CONTAINER>
 

For example rendering a container without a content style and two assets will result in:

 <TEXT>
   <T>asset 1</T>
 </TEXT>
 <TEXT>
   <T>asset 2</T>
 </TEXT>
 

Since:

7.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlContainer(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

XmlContainer

protected XmlContainer(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.