Interface Renderer
-
- All Known Implementing Classes:
AbstractRenderer
,DiagnosticJsonRenderer
,JsonRenderer
,XmlRenderer
,XmlRendererANF
public interface Renderer
This interface represents the contract between a Block and a class that is responsible for generating its representation.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description MarkupOutput
generateMarkup(BlockContext bContext, Block block)
Generate the markup representation of the specified Block.void
setEncoderChain(ContentEncoderChain contentEncoders)
Set up the encoder chain for the renderer.
-
-
-
Method Detail
-
generateMarkup
MarkupOutput generateMarkup(BlockContext bContext, Block block) throws java.lang.Exception
Generate the markup representation of the specified Block.- Parameters:
bContext
- TheBlockContext
object that controls how BlockProperty values are expanded and Blocks are serialized.block
- TheBlock
to generate markup for.- Returns:
- A new
MarkupOutput
object that contains the generated markup. - Throws:
java.lang.Exception
- If an error occurs in the process of generating the markup.
-
setEncoderChain
void setEncoderChain(ContentEncoderChain contentEncoders)
Set up the encoder chain for the renderer.- Parameters:
contentEncoders
- - The contentEncoderChain object containing the list of encoders.- Since:
- MicroStrategy Web 9.0.1
-
-