Class XmlDocument
java.lang.Object
com.aquima.interactions.framework.renderer.XmlElement
com.aquima.interactions.framework.renderer.document.XmlDocumentRendererBase
com.aquima.interactions.framework.renderer.document.XmlDocument
- All Implemented Interfaces:
IElementRenderer
,IXmlElementRenderer
This class converts an IDocument implementation to an XML node for document xml generation.
Since IDocument is a composite element all its children will be renderer to xml as well.
For example rendering a document item with a content style "document" will result in:
<DOCUMENT language="nl-NL" portalengine-version="7.1.12 [5100] (Rudy Van Snick)"/>
For example rendering a document item with a presentation style "style" will result in:
<DOCUMENT style="style" language="nl-NL" portalengine-version="7.1.12 [5100] (Rudy Van Snick)"/>
- Since:
- 7.0
- Author:
- Jon van Leuven
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
XmlDocument
(boolean tagsToUpperCase, String rendererName) -
Method Summary
Modifier and TypeMethodDescriptiontoXml
(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
-
Field Details
-
Constructor Details
-
Method Details
-
toXml
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.
-