me.jaimegarza.syntax.util

Class HtmlWriter

java.lang.Object

me.jaimegarza.syntax.util.HtmlWriter

public class HtmlWriter
extends Object

Class used to write HTML out for the report.

It allows the constructions of tables and other reporting structures

Author:

jgarza

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HtmlWriter.HtmlValue Class utilized to hold a value with a CSS class

Constructor Summary

Constructors

Constructor and Description
HtmlWriter(FormattingPrintStream out, Environment environment) Construct a writer to output to the out stream

Method Summary

Modifier and Type	Method and Description
void	epilogue() Write the report header
void	heading(String text) Add a heading block
void	item(String text) Add an entry of text.
void	item(String text, String subtext) Add an entry with a small subtitle to the report
static HtmlWriter.HtmlValue	left(Object o) Create an element aligned left, for output in a table
void	preface() Write the report header
static HtmlWriter.HtmlValue	right(Object o) Create an element aligned right, for output in a table
void	subHeading(String text) Add a subheading block
void	subTitle(String text) Add a subtitle block
void	tableEnd() Terminate one table
void	tableHead(String type, HtmlWriter.HtmlValue... columnHeadersAndClasses) Write the heading of a column to HTML
void	tableOneCellRow(String value, String className) Produce a row in a table with one cell
void	tableRow(HtmlWriter.HtmlValue... valuesAndClasses) Write the contents of one row of data as per the values
void	title(String text) Add a title block

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlWriter

public HtmlWriter(FormattingPrintStream out,
                  Environment environment)

Construct a writer to output to the out stream

Parameters:

out - is the stream to write to

environment - is the environment, used for the report template

Method Detail

preface

public void preface()

Write the report header

epilogue

public void epilogue()

Write the report header

tableHead

public void tableHead(String type,
                      HtmlWriter.HtmlValue... columnHeadersAndClasses)

Write the heading of a column to HTML

Parameters:

type - is the CSS classname of the table

columnHeadersAndClasses - is the column descriptors

tableRow

public void tableRow(HtmlWriter.HtmlValue... valuesAndClasses)

Write the contents of one row of data as per the values

Parameters:

valuesAndClasses - is the array of values with their CSS classes

tableOneCellRow

public void tableOneCellRow(String value,
                            String className)

Produce a row in a table with one cell

Parameters:

value - the text of the cell

className - the CSS class name of the cell

tableEnd

public void tableEnd()

Terminate one table

heading

public void heading(String text)

Add a heading block

Parameters:

text - is the text in the block

subHeading

public void subHeading(String text)

Add a subheading block

Parameters:

text - is the text in the block

title

public void title(String text)

Add a title block

Parameters:

text - is the text in the block

subTitle

public void subTitle(String text)

Add a subtitle block

Parameters:

text - is the text in the block

item

public void item(String text)

Add an entry of text. An item is a single div

Parameters:

text - is the text in the block

item

public void item(String text,
                 String subtext)

Add an entry with a small subtitle to the report

Parameters:

text - the text of the item

subtext - the little subtitle

left

public static HtmlWriter.HtmlValue left(Object o)

Create an element aligned left, for output in a table

Parameters:

o - is the object to emit

Returns:

right

public static HtmlWriter.HtmlValue right(Object o)

Create an element aligned right, for output in a table

Parameters:

o - is the object to emit

Returns: