Interface PhasedNodeRenderer

All Superinterfaces:

NodeRenderer

All Known Implementing Classes:

AdmonitionNodeRenderer, EnumeratedReferenceNodeRenderer, FootnoteNodeRenderer, MacrosNodeRenderer, ZzzzzzNodeRenderer

public interface PhasedNodeRenderer
extends NodeRenderer

A renderer for a document node for a specific rendering phase

Method Summary

Modifier and Type	Method	Description
@Nullable Set<RenderingPhase>	getRenderingPhases()
void	renderDocument(@NotNull NodeRendererContext context, @NotNull HtmlWriter html, @NotNull Document document, @NotNull RenderingPhase phase)	Render the specified node.

Methods inherited from interface NodeRenderer

getNodeRenderingHandlers

Method Details

getRenderingPhases

@Nullable
@Nullable Set<RenderingPhase> getRenderingPhases()

renderDocument

void renderDocument(@NotNull
 @NotNull NodeRendererContext context,
 @NotNull
 @NotNull HtmlWriter html,
 @NotNull
 @NotNull Document document,
 @NotNull
 @NotNull RenderingPhase phase)

Render the specified node.

Parameters:

context - node renderer context instance

html - html writer instance

document - the document node to render

phase - rendering phase for which to generate the output. Will be any of RenderingPhase no rendering should be done if phase is RenderingPhase.BODY because this phase is used for the non-phased node rendering. For body phase this method is called before the node renderer calls are made so it is a good place to reset internal structures for start of each phase.