* This method implements HTML entity conversion to ensure that all * characters can be properly rendered. The following subset are * converted: *
* & * " * < * > * ' * * @param out * The output destination. * @param title * The preformatted title text. */ public void writeSimpleHeader(IndentingWriter out, String title) { write(out, HtmlHelper.startHtml()); out.increment(); write(out, HtmlHelper.startHead()); out.increment(); write(out, HtmlHelper.getEncoding()); write(out, HtmlHelper.title(title)); write(out, HtmlHelper.writeWrapStyle()); out.decrement(); write(out, HtmlHelper.endHead()); write(out, HtmlHelper.startBody(WHITE)); out.increment(); } /** * Write the common end of an HTML file. * * @param out * The output destination. */ public void writeSimpleFooter(IndentingWriter out) { // output the standard end of the file out.decrement(); write(out, HtmlHelper.endBody()); out.decrement(); write(out, HtmlHelper.endHtml()); } /** * Write the standard opening tags for a table. * * @param out * The output destination. */ public void writeTableOpen(IndentingWriter out) { writeTableOpen(out, 100, 1); } /** * Write the standard opening tags for a table. * * @param out * The output destination. * @param width * Percent of the page width the table should occupy. * @param border * The border thickness (0 for an invisible border). */ public void writeTableOpen(IndentingWriter out, int width, int border) { write(out, HtmlHelper.startTable(width, border)); out.increment(); } /** * Write the standard closing tags for a table. * * @param out * The output destination. */ public void writeTableClose(IndentingWriter out) { out.decrement(); write(out, HtmlHelper.endTable()); write(out, HtmlHelper.br()); } /** * Write the opening row tag with optional background color support. *
* After opening the row, the indent level will be incremented.
*
* @param out
* The output destination.
* @param bgcolor
* If true, the background of this row will not
* use the table or document background color.
* @param rgb
* A string starting with a '#' character and followed by 6
* hexidecimal digits specifying an RGB color. If
* null this class' public constant GOLD will
* be used (which is RGB 255,204,102 or a light yellow).
*/
public void writeRowStart(IndentingWriter out,
boolean bgcolor,
String rgb)
{
String contents = null;
if (bgcolor)
{
contents = HtmlHelper.startRow(rgb == null ? GOLD : rgb);
}
else
{
contents = HtmlHelper.startRow();
}
write(out, contents);
out.increment();
}
/**
* Write the closing row tag and decrement the indent level.
*
* @param out
* The output destination.
*/
public void writeRowEnd(IndentingWriter out)
{
out.decrement();
write(out, HtmlHelper.endRow());
}
/**
* Write a single cell of text into the current row. Alignment is
* specified using one of the following:
*
*
* VALIGN_TOP
* VALIGN_MIDDLE
* VALIGN_BOTTOM
* HALIGN_LEFT
* HALIGN_CENTER
* HALIGN_RIGHT
*
* * This method forces HTML entity conversion to ensure that all * characters can be properly rendered. The following subset are * converted at this time: *
* &
* "
* <
* >
* '
*
* @param out
* The output destination.
* @param text
* Contents of the cell.
* @param vAlign
* Vertical alignment of the cell.
* @param hAlign
* Horizontal alignment of the cell.
* @param type
* Normal, Bold or Preformatted text if the type is set to
* NORMAL, BOLD or PREFORMAT respectively.
*/
public void writeField(IndentingWriter out,
String text,
String vAlign,
String hAlign,
int type)
{
writeField(out, text, vAlign, hAlign, type, false);
}
/**
* Write a single cell of text into the current row. Alignment is
* specified using one of the following:
*
*
* VALIGN_TOP
* VALIGN_MIDDLE
* VALIGN_BOTTOM
* HALIGN_LEFT
* HALIGN_CENTER
* HALIGN_RIGHT
*
* * At the user's request, this method will implement HTML entity * conversion to ensure that all characters can be properly rendered. * The following subset are converted at this time: *
* &
* "
* <
* >
* '
*
* @param out
* The output destination.
* @param text
* Contents of the cell.
* @param vAlign
* Vertical alignment of the cell.
* @param hAlign
* Horizontal alignment of the cell.
* @param type
* Normal, Bold or Preformatted text if the type is set to
* NORMAL, BOLD or PREFORMAT respectively.
* @param noFilter
* If true AND if the type is
* NORMAL or PREFORMAT, NO
* FILTERING of the text will be done.
*/
public void writeField(IndentingWriter out,
String text,
String vAlign,
String hAlign,
int type,
boolean noFilter)
{
if (type == NORMAL)
{
// fast path
write(out, HtmlHelper.field(hAlign, vAlign, text, !noFilter));
}
else
{
String start = HtmlHelper.startField(hAlign, vAlign);
String end = HtmlHelper.endField();
if (type == BOLD)
{
write(out, start);
out.increment();
StringBuilder sb = new StringBuilder();
sb.append(HtmlHelper.strong(text)).append("\n");
write(out, sb.toString());
out.decrement();
write(out, end);
}
else if (type == PREFORMAT || type == PREFORMAT_WRAP)
{
int level = out.getIndent();
write(out, start);
out.setIndent(0);
text = noFilter ? text : HtmlHelper.filter(text);
write(out, type == PREFORMAT ? HtmlHelper.pre(text) : HtmlHelper.preWrap(text));
out.setIndent(level);
write(out, end);
}
else
{
String err = String.format("Unknown content type '%d'!", type);
throw new RuntimeException(err);
}
}
}
/**
* Creates a file-backed printable writer for storing report output.
* As long as the filename is not a directory, it is deleted if it
* exists and a new writer is created and returned. The path to the file
* must already exist.
*
* @param fname
* Input file name.
*
* @return An open writer.
*/
public IndentingWriter createStream(String fname)
throws IllegalArgumentException
{
IndentingWriter out = null;
// build a file
File file = new File(fname);
// if this filename exists as a directory, we can't save results
if (file.isDirectory())
{
throw new IllegalArgumentException(fname + " is a directory!");
}
// remove the target file if it exists
if (file.exists())
{
file.delete();
}
try
{
FileOutputStream fos = new FileOutputStream(file);
OutputStreamWriter osw = new OutputStreamWriter(fos, "UTF-8");
BufferedWriter bw = new BufferedWriter(osw);
out = new IndentingWriter(bw);
}
catch (Exception exc)
{
throw new IllegalArgumentException("Cannot create stream for " +
fname + "(" + exc.toString() +
")!");
}
return out;
}
/**
* Handle output processing in a consistent manner by writing the
* text to the given stream. Any failures will be transformed into
* runtime exceptions.
*
* @param out
* The output destination.
* @param text
* The content to write.
*
* @throws RuntimeException
* On any failure.
*/
public void write(Writer out, String text)
{
try
{
byte[] encoded = text.getBytes("UTF-8");
String utf8 = new String(encoded, "UTF-8");
out.write(utf8);
}
catch (IOException ioe)
{
throw new RuntimeException("I/O Failure on WRITE!", ioe);
}
}
/**
* Safely close the given writer.
*
* @param out
* The output destination.
*/
public void close(Writer out)
{
try
{
if (out != null)
out.close();
}
catch (IOException ioe)
{
// ignore
}
}
/**
* Convert any newlines in the input string to HTML break tags.
*
* @param input
* Data to check.
*
* @return The data with HTML line breaks.
*/
public String honorNewLine(String input)
{
return input.replaceAll("\n", "
");
}
/**
* Return the input string if it is not null and not empty,
* otherwise return a safe string that will display in a table as a blank
* table cell.
*
* @param input
* Data to check.
*
* @return Safe version of the data.
*/
public String makeNonEmpty(String input)
{
return (input == null || input.length() == 0) ? "
" : input;
}
}