Class XmlField
java.lang.Object
com.aquima.interactions.framework.renderer.XmlElement
com.aquima.interactions.framework.renderer.page.r6.XmlField
- All Implemented Interfaces:
IElementRenderer
,IXmlElementRenderer
This class converts an IField implementation to an XML node for page xml generation.
For example rendering a field with a value, question text and explain text will result in:
<field name="Person.Name" basetype="text"> <value>Jon</value> <explain>This is some explanation for this field</explain> <question>The name of the person</question> </field>
For example rendering a multivalued field with values will result in:
<field name="Person.Names" multivalue="true" basetype="text"> <value>Klaas</value> <value>Jan</value> </field>
For example rendering a field with domain values will result in:
<field name="Person.Name" domain="true" basetype="text"> <value display="Jon van Leuven">01</value> <domain> <domainValue value="01" valid="true" selected="true"> Jon van Leuven</domainValue> <domainValue value="02" valid="true">Ocker Kerpershoek</domainValue> </domain> </field>
For example rendering a field with a display value will result in:
<field name="Inkomen.Bedrag" basetype="currency"> <value display="twee duizend vijfhonderd en tachtig euro">2580,00</value> </field>
- Since:
- 6.0
- Author:
- F. van der Meer
-
Constructor Summary
Constructors -
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.XmlElement
formatKey, getKeyPrefix, setIncludePresentationStyleElements, setKeyPrefix, setOptionalFormat, setOptionalPresentationStyle
-
Constructor Details
-
XmlField
protected XmlField(boolean sortDomainValues)
-
-
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.
-