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

Class XmlContainer

java.lang.Object
com.aquima.interactions.framework.renderer.XmlElement
com.aquima.interactions.framework.renderer.page.r6.XmlContainer
All Implemented Interfaces:
IElementRenderer, IXmlElementRenderer
public class XmlContainer extends XmlElement

This class converts an IContainer implementation to an XML node for page 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 name="container"/>

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

 <row name="container"/>

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

 <container style="style" name="container" format="style"/>

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

 <container name="container">
   <containerDisplayName>This is the display text</containerDisplayName>
   <button name="buttonName"/>
 </container>

For example rendering a container without a content style and with a button will result in: 

 <button name="buttonName"/>
Since:
6.0
Author:
F. van der Meer

  • Constructor Details

    • XmlContainer

      public XmlContainer(boolean enableContainerMessages, boolean includeProperties)
      Constructs the container XML renderer with the required arguments.
      Parameters:
      enableContainerMessages - Boolean indicating if error messages should be shown at the container level.
      includeProperties - Boolean indicating if the properties of a container should be included in the XML.

  • 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.