de.vandermeer.asciitable.v2.render

Class V2_AsciiTableRenderer

Object

V2_AsciiTableRenderer

All Implemented Interfaces:

V2_TableRenderer

public class V2_AsciiTableRenderer
extends Object
implements V2_TableRenderer

Renders a table. Using the renderer is very simple. First, create and fill a table:

	V2_AsciiTable at = new V2_AsciiTable();
	at.addRule();
	at.addRow("1-1", "1-2", "1-3");
	at.addRule();
	at.addRow("2-1", "2-2", "2-3");
	at.addRule();
 

Then create a renderer and set the table width, set the theme to be used (if other than the default theme V2_E_TableThemes.PLAIN_7BIT) and set the padding character to be used (if other than the default padding character ' '):

	V2_AsciiTableRenderer rend = new V2_AsciiTableRenderer();
	rend.setTheme(V2_E_TableThemes.UTF_LIGHT.get());
	rend.setWidth(new V2_WidthAbsoluteEven().setWidth(25));
	rend.setPaddingChar('_');
 

Finally render the created table, resulting in a rendered table ready to be printed or written to a file:

	RenderedTable rt = rend.render(at);
	System.out.println(rt);
 

The example above will result in this table printed to standard out:

        ┌───────┬───────┬───────┐
        │_1-1___│_1-2___│_1-3___│
        ├───────┼───────┼───────┤
        │_2-1___│_2-2___│_2-3___│
        └───────┴───────┴───────┘
 

Since:

v0.0.5

Version:

v0.2.3 build 150910 (10-Sep-15) for Java 1.7

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Constructor Summary

Constructors

Constructor and Description
V2_AsciiTableRenderer() Returns a new table row renderer.

Method Summary

Modifier and Type	Method and Description
RenderedTable	render(V2_AsciiTable table) Renders the given table and returns a list of string builders with the rendered rows.
protected StrBuilder	renderContentRow(ProcessedRow row, int[] cols) Renders a content row.
protected StrBuilder	renderRuleRow(ProcessedRow row, int[] cols, RuleRowType assumeType) Renders a rule row.
V2_AsciiTableRenderer	setPaddingChar(char pChar) Sets the padding character.
V2_AsciiTableRenderer	setTheme(V2_TableTheme theme) Sets and tests the theme for the table.
V2_AsciiTableRenderer	setWidth(V2_Width width) Sets the width for the rendered.

Methods inherited from class Object

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

Constructor Detail

V2_AsciiTableRenderer

public V2_AsciiTableRenderer()

Returns a new table row renderer. Default values are:

• Padding character: blank (' ')
• Theme: plain 7 bit ASCII theme

Method Detail

setWidth

public V2_AsciiTableRenderer setWidth(V2_Width width)

Description copied from interface: V2_TableRenderer

Sets the width for the rendered.

Specified by:

setWidth in interface V2_TableRenderer

Parameters:

width - new width

Returns:

self to allow for chaining

render

public RenderedTable render(V2_AsciiTable table)

Description copied from interface: V2_TableRenderer

Renders the given table and returns a list of string builders with the rendered rows.

Specified by:

render in interface V2_TableRenderer

Parameters:

table - table to be rendered

Returns:

linked list of string builders with rendered rows

renderContentRow

protected final StrBuilder renderContentRow(ProcessedRow row,
                                            int[] cols)

Renders a content row.

Parameters:

row - processed row to render

cols - columns calculated by V2_Width

Returns:

a string builder with the rendered strings (if lines are wrapped) of the rendered row

renderRuleRow

protected final StrBuilder renderRuleRow(ProcessedRow row,
                                         int[] cols,
                                         RuleRowType assumeType)

Renders a rule row.

Parameters:

row - processed row to render

cols - columns calculated by V2_Width

assumeType - is a rule row type the methods has to assume, regardless of the actual set type in the original row

Returns:

a string builder with the rendered string of the rendered row

setPaddingChar

public V2_AsciiTableRenderer setPaddingChar(char pChar)

Description copied from interface: V2_TableRenderer

Sets the padding character.

Specified by:

setPaddingChar in interface V2_TableRenderer

Parameters:

pChar - new padding character

Returns:

self to allow for chaining

setTheme

public V2_AsciiTableRenderer setTheme(V2_TableTheme theme)

Description copied from interface: V2_TableRenderer

Sets and tests the theme for the table.

Specified by:

setTheme in interface V2_TableRenderer

Parameters:

theme - new theme for the table

Returns:

self to allow for chaining