com.atlassian.renderer.v2.components.table

Class TableBlockRenderer

java.lang.Object

com.atlassian.renderer.v2.components.table.TableBlockRenderer

All Implemented Interfaces:

BlockRenderer

public class TableBlockRenderer
extends Object
implements BlockRenderer

Responsible for parsing wiki table markup and rendering it.

This class parses the wiki table markup into a table model (see Table).

To customize the rendering of the table, you can override renderTable(Table, com.atlassian.renderer.v2.SubRenderer, com.atlassian.renderer.RenderContext).

Constructor Summary

Constructors

Constructor and Description
TableBlockRenderer()

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.
protected String	renderTable(Table table, SubRenderer subRenderer, RenderContext renderContext) Encapsulates the logic for rendering the table model Table.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableBlockRenderer

public TableBlockRenderer()

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

renderTable

protected String renderTable(Table table,
                 SubRenderer subRenderer,
                 RenderContext renderContext)

Encapsulates the logic for rendering the table model Table.

Clients can override this method to customize table rendering.

Parameters:

table - the table model

subRenderer - sub renderer

renderContext - render context

Returns:

a rendering of the table