org.fulib.tables

Class HtmlRenderer

java.lang.Object

org.fulib.tables.HtmlRenderer

All Implemented Interfaces:

Renderer

public class HtmlRenderer
extends java.lang.Object
implements Renderer

Allows rendering Table instances as HTML <table> elements.

Since:

1.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_INDENT The default value for setIndent(String) (4 spaces)

Constructor Summary

Constructors

Constructor and Description
HtmlRenderer()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCaption()
java.lang.String	getIndent()
void	render(Table<?> table, java.lang.Appendable out) Renders the given table into the given appendable.
HtmlRenderer	setCaption(java.lang.String caption)
HtmlRenderer	setIndent(java.lang.String indent)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fulib.tables.Renderer

render

Field Detail

DEFAULT_INDENT

public static final java.lang.String DEFAULT_INDENT

The default value for setIndent(String) (4 spaces)

See Also:

Constant Field Values

Constructor Detail

HtmlRenderer

public HtmlRenderer()

Method Detail

getCaption

public java.lang.String getCaption()

Returns:

the caption, or null if unset

See Also:

setCaption(String)

setCaption

public HtmlRenderer setCaption(java.lang.String caption)

Parameters:

caption - the caption to use within <caption>...</caption>, which is required in JavaDoc; can be null to omit the element

Returns:

this instance, to allow method chaining

getIndent

public java.lang.String getIndent()

Returns:

the indent string

See Also:

setIndent(String)

setIndent

public HtmlRenderer setIndent(java.lang.String indent)

Parameters:

indent - the string to indent nested tags; defaults to DEFAULT_INDENT

Returns:

this instance, to allow method chaining

render

public void render(Table<?> table,
                   java.lang.Appendable out)
            throws java.io.IOException

Description copied from interface: Renderer

Renders the given table into the given appendable.

Specified by:

render in interface Renderer

Parameters:

table - the table to render

out - the Appendable to which the rendered result should be appended

Throws:

java.io.IOException - if one occurs when appending to the output