de.must.io

Class HtmlFile

java.lang.Object

de.must.io.MarkupFile

de.must.io.HtmlFile

Direct Known Subclasses:

ProportionalHtmlFile

public class HtmlFile
extends MarkupFile

Text file for HTML output.

Field Summary

Fields

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

Fields inherited from class de.must.io.MarkupFile

fileExtension, fileName, generator, mode, MODE_HTML, MODE_XML_XSL, title

Constructor Summary

Constructors

Constructor and Description
HtmlFile(java.lang.String fileName, java.lang.String title, java.lang.String generator) Constructs a new text file for HTML output
HtmlFile(java.lang.String fileName, java.lang.String title, java.lang.String generator, StandardHtmlSettings settings) Constructs a new text file for HTML output
HtmlFile(java.io.Writer writer, java.lang.String fileName, java.lang.String title, java.lang.String generator) Constructs a new text file or output stream for HTML output
HtmlFile(java.io.Writer writer, java.lang.String fileName, java.lang.String title, java.lang.String generator, StandardHtmlSettings settings) Constructs a new text file or output stream for HTML output

Method Summary

Modifier and Type	Method and Description
void	beginRow()
void	beginTable()
void	endRow()
void	endTable()
protected java.lang.String	getConvertedString(char charToConvert) Returns the HTML compliant char, e.g.
protected java.lang.String	getConvertedStringForContent(java.lang.String content) Returns the converted string for content like e.g. database field value.
void	outputFooter() Outputs the file's footer.
void	outputHeader() Outputs the file's header.
void	outputHeader(boolean printOnLoad) Outputs the file's header.
void	outputHeader(boolean printOnLoad, java.lang.String[] additionalLines)
void	outputHeader(java.lang.String[] additionalLines)
protected void	outputItem(DataObject dataObjectToList, java.lang.String[] columns) Outputs the specified columns of the current row of the data object to list
void	outTD(int cellValue)
void	outTD(java.lang.String cellValue)
void	outTD(java.lang.String cellValue, int colspan)
void	outTDb(java.lang.String cellValue)
void	outTDForContent(java.lang.String cellValue) Outputs a cell value after basically converting it, e.g. '<' is replace by '<';
void	outTDr(int cellValue)
void	outTDr(java.lang.String cellValue)
void	outTDrb(java.lang.String cellValue)
void	pageBreak()
void	println(java.lang.String line) Writes a new line into the HTML file which is ending by " ".
void	printlnNonConverted(java.lang.String line)
void	writeTableHeader(java.lang.String[] columnNames) Writes column names as header (bold).
void	writeTableRow(java.lang.String[] columnValues) Writes column values.
void	writeTableRowNumeric(int firstRight, java.lang.String[] columnValues) Writes column values with column right aligned as specified.
void	writeTableRowNumeric(java.lang.String[] columnValues) Writes column values with column 2..n right aligned.

Methods inherited from class de.must.io.MarkupFile

close, finalize, flush, list, list, openOutputFile, openOutputWriter, presentInBrowser, startTableIfNecessary, stopTableIfNecessary, write, writeln, writelnNonConverted, writeNonConverted

Methods inherited from class java.lang.Object

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

Field Detail

HTML_FILE_EXTENSION

public static java.lang.String HTML_FILE_EXTENSION

Constructor Detail

HtmlFile

public HtmlFile(java.lang.String fileName,
                java.lang.String title,
                java.lang.String generator)
         throws java.io.IOException

Constructs a new text file for HTML output

Parameters:

fileName - the name / path of the file without extension

title - the title of the HTML file

generator - the generator

Throws:

java.io.IOException

HtmlFile

public HtmlFile(java.lang.String fileName,
                java.lang.String title,
                java.lang.String generator,
                StandardHtmlSettings settings)
         throws java.io.IOException

Constructs a new text file for HTML output

Parameters:

fileName - the name / path of the file without extension

title - the title of the HTML file

generator - the generator

settings - the standard HTML settings

Throws:

java.io.IOException

HtmlFile

public HtmlFile(java.io.Writer writer,
                java.lang.String fileName,
                java.lang.String title,
                java.lang.String generator)
         throws java.io.IOException

Constructs a new text file or output stream for HTML output

Parameters:

writer - the writer to stream output to - may be null for file output

fileName - the name / path of the file without extension

title - the title of the HTML file

generator - the generator

Throws:

java.io.IOException

HtmlFile

public HtmlFile(java.io.Writer writer,
                java.lang.String fileName,
                java.lang.String title,
                java.lang.String generator,
                StandardHtmlSettings settings)
         throws java.io.IOException

Constructs a new text file or output stream for HTML output

Parameters:

writer - the writer to stream output to - may be null for file output

fileName - the name / path of the file without extension

title - the title of the HTML file

generator - the generator

settings - the standard HTML settings

Throws:

java.io.IOException

Method Detail

outputHeader

public void outputHeader()

Outputs the file's header.

Specified by:

outputHeader in class MarkupFile

outputHeader

public void outputHeader(java.lang.String[] additionalLines)

outputHeader

public void outputHeader(boolean printOnLoad)

Outputs the file's header.

Parameters:

printOnLoad - whether body tag should include onLoad="print()"

outputHeader

public void outputHeader(boolean printOnLoad,
                         java.lang.String[] additionalLines)

beginTable

public void beginTable()

endTable

public void endTable()

beginRow

public void beginRow()

endRow

public void endRow()

outTDb

public void outTDb(java.lang.String cellValue)

outTDrb

public void outTDrb(java.lang.String cellValue)

outTD

public void outTD(int cellValue)

outTD

public void outTD(java.lang.String cellValue)

outTDForContent

public void outTDForContent(java.lang.String cellValue)

Outputs a cell value after basically converting it, e.g. '<' is replace by '<';

Parameters:

cellValue - the cellValue to output

outTD

public void outTD(java.lang.String cellValue,
                  int colspan)

outTDr

public void outTDr(int cellValue)

outTDr

public void outTDr(java.lang.String cellValue)

writeTableHeader

public void writeTableHeader(java.lang.String[] columnNames)

Writes column names as header (bold).

Parameters:

columnNames - the column names to use

writeTableRow

public void writeTableRow(java.lang.String[] columnValues)

Writes column values.

Parameters:

columnValues - the column values to write

writeTableRowNumeric

public void writeTableRowNumeric(java.lang.String[] columnValues)

Writes column values with column 2..n right aligned.

Parameters:

columnValues - the column values to write

writeTableRowNumeric

public void writeTableRowNumeric(int firstRight,
                                 java.lang.String[] columnValues)

Writes column values with column right aligned as specified.

Parameters:

columnValues - the column values to write

firstRight - the index of column where the right alignment starts

outputItem

protected void outputItem(DataObject dataObjectToList,
                          java.lang.String[] columns)

Outputs the specified columns of the current row of the data object to list

Specified by:

outputItem in class MarkupFile

Parameters:

dataObjectToList - the data object to list

columns - the columns to list

pageBreak

public void pageBreak()

outputFooter

public void outputFooter()

Outputs the file's footer.

Specified by:

outputFooter in class MarkupFile

getConvertedString

protected java.lang.String getConvertedString(char charToConvert)

Returns the HTML compliant char, e.g. & for &.

Specified by:

getConvertedString in class MarkupFile

Parameters:

charToConvert - the char to convert

Returns:

the HTML compliant char

getConvertedStringForContent

protected java.lang.String getConvertedStringForContent(java.lang.String content)

Returns the converted string for content like e.g. database field value.

Parameters:

content - the content to convert

Returns:

the converted content

println

public void println(java.lang.String line)

Writes a new line into the HTML file which is ending by "
". Thus, the line is a line in an editor and in a browser, too.

Parameters:

line -

printlnNonConverted

public void printlnNonConverted(java.lang.String line)