org.orbisgis.commons.printer

Class Html

java.lang.Object

org.orbisgis.commons.printer.CustomPrinter

org.orbisgis.commons.printer.Html

All Implemented Interfaces:

ICustomPrinter

public class Html
extends CustomPrinter

Extension of CustomPrinter for the printing of data in an Html style.

Author:

Erwan Bocher (CNRS), Sylvain PALOMINOS (UBS 2019)

Nested Class Summary

Nested classes/interfaces inherited from interface org.orbisgis.commons.printer.ICustomPrinter

ICustomPrinter.CellPosition

Field Summary

Fields inherited from class org.orbisgis.commons.printer.CustomPrinter

builder, columnCount, columnIndex, columnWidth, isDrawingTable

Constructor Summary

Constructors

Constructor and Description
Html() Main constructor.
Html(StringBuilder builder) Main constructor.

Method Summary

Modifier and Type	Method and Description
void	appendTableHeaderValue(Object value, ICustomPrinter.CellPosition position) Add a header value to the table.
void	appendTableLineSeparator() Append a line separator to the builder.
void	appendTableTitle(Object title) Add a title to the table.
void	appendTableValue(Object value, ICustomPrinter.CellPosition position) Add a single value to the table.
void	appendValue(Object value) Add a simple value.
void	endTable() End the table drawing.
void	startTable(int columnWidth, int columnCount) Start the drawing of a table.

Methods inherited from class org.orbisgis.commons.printer.CustomPrinter

appendTableValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Html

public Html(StringBuilder builder)

Main constructor.

Parameters:

builder - Not null StringBuilder used for building the string.

Html

public Html()

Main constructor.

Method Detail

appendTableLineSeparator

public void appendTableLineSeparator()

Description copied from interface: ICustomPrinter

Append a line separator to the builder.

startTable

public void startTable(int columnWidth,
                       int columnCount)

Description copied from interface: ICustomPrinter

Start the drawing of a table.

Specified by:

startTable in interface ICustomPrinter

Overrides:

startTable in class CustomPrinter

Parameters:

columnWidth - Width in character number of a single column.

columnCount - Count of column.

endTable

public void endTable()

Description copied from interface: ICustomPrinter

End the table drawing.

Specified by:

endTable in interface ICustomPrinter

Overrides:

endTable in class CustomPrinter

appendTableValue

public void appendTableValue(Object value,
                             ICustomPrinter.CellPosition position)

Description copied from interface: ICustomPrinter

Add a single value to the table. Linebreak are automatically generated once the column count is reached.

Parameters:

value - Value to add to the table.

appendTableHeaderValue

public void appendTableHeaderValue(Object value,
                                   ICustomPrinter.CellPosition position)

Description copied from interface: ICustomPrinter

Add a header value to the table. Linebreak are automatically generated once the column count is reached.

Parameters:

value - Header value to add to the table.

appendTableTitle

public void appendTableTitle(Object title)

Description copied from interface: ICustomPrinter

Add a title to the table.

Parameters:

title - Not null title to add to the table.

appendValue

public void appendValue(Object value)

Description copied from interface: ICustomPrinter

Add a simple value. If a table has been started, use ICustomPrinter.appendTableValue(Object).

Parameters:

value - Value to add.