com.atlassian.renderer.v2.components.block
Interface BlockRenderer

All Known Implementing Classes:

BlankLineBlockRenderer, BlockquoteBlockRenderer, HeadingBlockRenderer, HorizontalRuleBlockRenderer, ListBlockRenderer, TableBlockRenderer

public interface BlockRenderer

Method Summary

String

renderNextBlock(String thisLine, LineWalker nextLines, RenderContext context, SubRenderer subRenderer) Render the next block in a document.

Method Detail

renderNextBlock

String renderNextBlock(String thisLine,
                       LineWalker nextLines,
                       RenderContext context,
                       SubRenderer subRenderer)

Render the next block in a document.

Returning anything from this method will indicate this renderer could handle the given line, and no further processing should be performed on it. Return null to let the other block renderers have a go on the same line.

Parameters:

thisLine - the line that will form the start of the block

nextLines - a LineWalker positioned at the line in the document after thisLine, in case the renderer needs to consume multiple lines. If the walker is used, implementors should ensure that at the end of the renderNextBlock call, it is positioned at the start of the first line that does not form part of the block.

context - The current rendercontext

subRenderer - A subrenderer that can be used to render the contents of the block

Returns:

the block rendered as HTML, or null if this renderer can not handle the line