com.atlassian.renderer.v2.components.list

Class ListBlockRenderer

java.lang.Object

com.atlassian.renderer.v2.components.list.ListBlockRenderer

All Implemented Interfaces:

BlockRenderer

public class ListBlockRenderer
extends Object
implements BlockRenderer

Field Summary

Fields

Modifier and Type	Field and Description
static com.atlassian.renderer.v2.components.list.ListType	BULLET_LIST
static com.atlassian.renderer.v2.components.list.ListType	DASHED_LIST
static Map	LIST_TYPES
static com.atlassian.renderer.v2.components.list.ListType	NUMBERED_LIST

Constructor Summary

Constructors

Constructor and Description
ListBlockRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
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

Field Detail

BULLET_LIST

public static final com.atlassian.renderer.v2.components.list.ListType BULLET_LIST

DASHED_LIST

public static final com.atlassian.renderer.v2.components.list.ListType DASHED_LIST

NUMBERED_LIST

public static final com.atlassian.renderer.v2.components.list.ListType NUMBERED_LIST

LIST_TYPES

public static final Map LIST_TYPES

Constructor Detail

ListBlockRenderer

public ListBlockRenderer()

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