com.partnersoft.formats.xml

Class HtmlBuilder

java.lang.Object

com.partnersoft.formats.xml.XmlBuilder

com.partnersoft.formats.xml.HtmlBuilder

Direct Known Subclasses:

GoogleMapWriter

public class HtmlBuilder
extends XmlBuilder

Builds an XHTML file via convenience functions.

Inherits from XmlBuilder, so don't forget that you can use the functions defined in XmlBuilder, too.

Copyright 2003-2006 Partner Software, Inc.

Author:

Paul Reavis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	embeddedcss

Fields inherited from class com.partnersoft.formats.xml.XmlBuilder

droppingElementsWithoutContent, emptyingElementsWithoutContent, indention, indentSpace, outie, stack

Constructor Summary

Constructors

Constructor and Description
HtmlBuilder(java.io.File outputFile)
HtmlBuilder(VfsFile outputFile)
HtmlBuilder(java.io.Writer writer)

Method Summary

Methods

Modifier and Type	Method and Description
void	endBulletedList()
void	endDocument() Closes out body and html
void	endListItem()
void	endNumberedList()
void	endTable()
void	endTableData()
void	endTableRow()
void	h1(java.lang.Object title)
void	h2(java.lang.Object title)
void	h3(java.lang.Object title)
void	h4(java.lang.Object title)
void	h5(java.lang.Object title)
void	hr()
void	p(java.lang.Object contents)
void	startBulletedList()
void	startDocument(java.lang.Object documentName) Gives you a standard header, with same text for the title and for an h1 tag.
void	startListItem()
void	startNumberedList()
void	startTable()
void	startTableData()
void	startTableRow()
void	tableContents(java.lang.Object contents)
void	tableHeader(java.lang.Object columnName)
void	writeBulletedList(java.util.Collection contents)
void	writeLink(java.lang.String url, java.lang.Object contents)
void	writeListItem(java.lang.Object contents)
void	writeMapAsTable(java.util.Map contents, java.lang.String keyLabel, java.lang.String valueLabel)
void	writeParagraph(java.lang.Object contents)
void	writeStackTrace(java.lang.Throwable whatHappened)

Methods inherited from class com.partnersoft.formats.xml.XmlBuilder

beginStartTag, close, endElement, endElement, endElement, endElement, endStartTag, indent, isDroppingElementsWithoutContent, isEmptyingElementsWithoutContent, newLine, setDroppingElementsWithoutContent, setEmptyingElementsWithoutContent, startElement, startElement, startElement, startElement, undent, writeAttribute, writeContent, writeContent, writeElement, writeElement, writeElement, writeEmptyElement, writeEmptyElement, writeIterableContent, writeRaw

Methods inherited from class java.lang.Object

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

Field Detail

embeddedcss

public static java.lang.String embeddedcss

Constructor Detail

HtmlBuilder

public HtmlBuilder(java.io.File outputFile)
            throws java.io.IOException

Throws:

java.io.IOException

HtmlBuilder

public HtmlBuilder(VfsFile outputFile)
            throws java.io.IOException

Throws:

java.io.IOException

HtmlBuilder

public HtmlBuilder(java.io.Writer writer)
            throws java.io.IOException

Throws:

java.io.IOException

Method Detail

writeParagraph

public void writeParagraph(java.lang.Object contents)
                    throws java.io.IOException

Throws:

java.io.IOException

startBulletedList

public void startBulletedList()
                       throws java.io.IOException

Throws:

java.io.IOException

endBulletedList

public void endBulletedList()
                     throws java.io.IOException

Throws:

java.io.IOException

startNumberedList

public void startNumberedList()
                       throws java.io.IOException

Throws:

java.io.IOException

endNumberedList

public void endNumberedList()
                     throws java.io.IOException

Throws:

java.io.IOException

writeListItem

public void writeListItem(java.lang.Object contents)
                   throws java.io.IOException

Throws:

java.io.IOException

startListItem

public void startListItem()
                   throws java.io.IOException

Throws:

java.io.IOException

endListItem

public void endListItem()
                 throws java.io.IOException

Throws:

java.io.IOException

startTable

public void startTable()
                throws java.io.IOException

Throws:

java.io.IOException

endTable

public void endTable()
              throws java.io.IOException

Throws:

java.io.IOException

startTableRow

public void startTableRow()
                   throws java.io.IOException

Throws:

java.io.IOException

endTableRow

public void endTableRow()
                 throws java.io.IOException

Throws:

java.io.IOException

startTableData

public void startTableData()
                    throws java.io.IOException

Throws:

java.io.IOException

endTableData

public void endTableData()
                  throws java.io.IOException

Throws:

java.io.IOException

tableHeader

public void tableHeader(java.lang.Object columnName)
                 throws java.io.IOException

Throws:

java.io.IOException

tableContents

public void tableContents(java.lang.Object contents)
                   throws java.io.IOException

Throws:

java.io.IOException

writeLink

public void writeLink(java.lang.String url,
             java.lang.Object contents)
               throws java.io.IOException

Throws:

java.io.IOException

hr

public void hr()
        throws java.io.IOException

Throws:

java.io.IOException

h1

public void h1(java.lang.Object title)
        throws java.io.IOException

Throws:

java.io.IOException

h2

public void h2(java.lang.Object title)
        throws java.io.IOException

Throws:

java.io.IOException

h3

public void h3(java.lang.Object title)
        throws java.io.IOException

Throws:

java.io.IOException

h4

public void h4(java.lang.Object title)
        throws java.io.IOException

Throws:

java.io.IOException

h5

public void h5(java.lang.Object title)
        throws java.io.IOException

Throws:

java.io.IOException

p

public void p(java.lang.Object contents)
       throws java.io.IOException

Throws:

java.io.IOException

startDocument

public void startDocument(java.lang.Object documentName)
                   throws java.io.IOException

Gives you a standard header, with same text for the title and for an h1 tag.

Throws:

java.io.IOException

endDocument

public void endDocument()
                 throws java.io.IOException

Closes out body and html

Throws:

java.io.IOException

writeBulletedList

public void writeBulletedList(java.util.Collection contents)
                       throws java.io.IOException

Throws:

java.io.IOException

writeMapAsTable

public void writeMapAsTable(java.util.Map contents,
                   java.lang.String keyLabel,
                   java.lang.String valueLabel)
                     throws java.io.IOException

Throws:

java.io.IOException

writeStackTrace

public void writeStackTrace(java.lang.Throwable whatHappened)
                     throws java.io.IOException

Throws:

java.io.IOException