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

Class XmlPage

java.lang.Object

com.aquima.interactions.framework.renderer.XmlElement

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

All Implemented Interfaces:

IElementRenderer, IXmlElementRenderer

@Deprecated(since="17.5",
            forRemoval=true)
public class XmlPage
extends XmlElement

Deprecated, for removal: This API element is subject to removal in a future version.

XML rendering of pages is no longer used by Blueriq and is subject to be removed in a future version.

This class converts a page element to an XML node.

Since:

6.0

Author:

F. van der Meer

Constructor Summary

Constructors

Constructor	Description
XmlPage(boolean includeChildMessages)	Deprecated, for removal: This API element is subject to removal in a future version. Constructs the Page XML renderer with the required arguments.

Method Summary

Modifier and Type	Method	Description
IXmlElement	toXml(IXmlRendererContext ctx, IElement element)	Deprecated, for removal: This API element is subject to removal in a future version. 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

XmlPage

public XmlPage(boolean includeChildMessages)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructs the Page XML renderer with the required arguments.

Parameters:

includeChildMessages - boolean indicating if error/warning messages of child elements should also be shown at the page level.

Method Details

toXml

public IXmlElement toXml(IXmlRendererContext ctx,
 IElement element)

Deprecated, for removal: This API element is subject to removal in a future version.

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.