PhasedNodeFormatter

All Superinterfaces:: NodeFormatter

All Known Implementing Classes:: AbbreviationNodeFormatter, AttributesNodeFormatter, CoreNodeFormatter, EnumeratedReferenceNodeFormatter, FootnoteNodeFormatter, JekyllFrontMatterNodeFormatter, JekyllTagNodeFormatter, MacrosNodeFormatter, NodeRepositoryFormatter, WikiLinkNodeFormatter, YamlFrontMatterNodeFormatter

public interface PhasedNodeFormatter extends NodeFormatter

A renderer for a document node for a specific rendering phase

Method Summary

Modifier and Type

Method

Description

@Nullable Set<FormattingPhase>

getFormattingPhases()

void

renderDocument(@NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown, @NotNull Document document, @NotNull FormattingPhase phase)

Render the specified node.

Methods inherited from interface NodeFormatter
getBlockQuoteLikePrefixChar, getNodeClasses, getNodeFormattingHandlers

Method Details
- getFormattingPhases
  
  @Nullable @Nullable Set<FormattingPhase> getFormattingPhases()
- renderDocument
  
  void renderDocument(@NotNull @NotNull NodeFormatterContext context, @NotNull @NotNull MarkdownWriter markdown, @NotNull @NotNull Document document, @NotNull @NotNull FormattingPhase phase)
  
  Render the specified node.
  
  Parameters:
  
  context - node renderer context instance
  
  markdown - markdown writer instance
  
  document - the document node to render
  
  phase - rendering phase for which to generate the output. Will be any of FormattingPhase except FormattingPhase.DOCUMENT because this phase is used for the non-phased node rendering