com.atlassian.renderer.v2.components.block

Class HeadingBlockRenderer

java.lang.Object

com.atlassian.renderer.v2.components.block.HeadingBlockRenderer

All Implemented Interfaces:

BlockRenderer

public class HeadingBlockRenderer
extends Object
implements BlockRenderer

Constructor Summary

Constructors

Constructor and Description
HeadingBlockRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getAnchor(RenderContext context, String body) Default implementation that gets a simple anchor text.
protected String	renderHeading(String headingLevel, String body, RenderContext context, SubRenderer subRenderer) Render a heading using the default HTML format
protected String	renderHeading(String headingLevel, String body, RenderContext context, SubRenderer subRenderer, String renderFormat) Render a heading using a provided message format.
String	renderNextBlock(String thisLine, LineWalker nextLines, RenderContext context, SubRenderer subRenderer) Render the next block in a document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeadingBlockRenderer

public HeadingBlockRenderer()

Method Detail

renderNextBlock

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

Description copied from interface: BlockRenderer

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.

Specified by:

renderNextBlock in interface BlockRenderer

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

renderHeading

protected String renderHeading(String headingLevel,
                   String body,
                   RenderContext context,
                   SubRenderer subRenderer)

Render a heading using the default HTML format

Returns:

rendered heading

renderHeading

protected String renderHeading(String headingLevel,
                   String body,
                   RenderContext context,
                   SubRenderer subRenderer,
                   String renderFormat)

Render a heading using a provided message format.

There are three arguments provided to the format:

1. Heading level
2. Anchor name/id value
3. Heading content

Parameters:

headingLevel - heading level

body - heading body

context - context heading is being rendered in

subRenderer - subrenderer for further rendering of content

renderFormat - MessageFormat string to use for rendering.

Returns:

rendered heading

getAnchor

protected String getAnchor(RenderContext context,
               String body)

Default implementation that gets a simple anchor text.