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

Class XmlButton

java.lang.Object

com.aquima.interactions.framework.renderer.XmlElement

com.aquima.interactions.framework.renderer.document.XmlButton

All Implemented Interfaces:

IElementRenderer, IXmlElementRenderer

public class XmlButton
extends XmlElement

This class renders an IButton implementation to an XML node for document xml generation.

Buttons are rendered to an xml comment node, because buttons should not be rendered in a document.

A button will be rendered to: <!-- ignoring button 'button-name' in document xml -->

Since:

7.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Constructor	Description
XmlButton()

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

XmlButton

public XmlButton()

Method Detail

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.