public class

XmlRenderer

extends AbstractRenderer
java.lang.Object
   ↳ com.microstrategy.web.blocks.renderers.AbstractRenderer
     ↳ com.microstrategy.web.blocks.renderers.XmlRenderer
Known Direct Subclasses

Class Overview

This class is the renderer that converts a Block tree into XML Element Normal Form. It uses the XmlRendererBlockVisitorENF class to perform the actual traversal of the Block tree.

Summary

[Expand]
Inherited Fields
From class com.microstrategy.web.blocks.renderers.AbstractRenderer
Public Constructors
XmlRenderer()
Public Methods
MarkupOutput generateMarkup(BlockContext context, Block block)
Protected Methods
Comparator<BlockProperty> getBlockPropertyComparator()
Returns a comparator used to sort the block properties.
XmlRendererBlockVisitor getBlockVisitor(BlockContext context)
By default the XMLRenderer will return a block visitor of ENF type.
[Expand]
Inherited Methods
From class com.microstrategy.web.blocks.renderers.AbstractRenderer
From class java.lang.Object
From interface com.microstrategy.web.blocks.renderers.Renderer

Public Constructors

public XmlRenderer ()

Public Methods

public MarkupOutput generateMarkup (BlockContext context, Block block)

Throws
Exception

Protected Methods

protected Comparator<BlockProperty> getBlockPropertyComparator ()

Returns a comparator used to sort the block properties. Since by default the XMLRenderer outputs the XML in ENF form it doesn't need to sort the block properties therefore it returns null.

Returns
  • null

protected XmlRendererBlockVisitor getBlockVisitor (BlockContext context)

By default the XMLRenderer will return a block visitor of ENF type. The ENF type block visitor will output the XML in Element Normal Form.

Parameters
context the BlockContext object.
Returns