BasicIO

Class ReportPrinter

java.lang.Object

BasicIO.ReportPrinter

All Implemented Interfaces:

java.awt.print.Printable

public class ReportPrinter
extends java.lang.Object
implements java.awt.print.Printable

This class allows for text output to a printer in a report style.

Titles
A report may have a title. The title will appear centered at the top of the first page and every page created with the newPage method. A title can be multiple lines by passing a var args of Strings to the setTitle method.

Fields
Lines of the report are separated into fields. This produces a columnar organization when mutliple lines are written. Fields are displayed in the order of their creation. When adding a field there are the following optional parameters.

name - the name of the field. Used for skipping to a specific field to perform a write operation. If a name is not specified then the field cannot be written to by specifying a name and can only be written to by sequence of writes.
label - a label for the field. The labels are centered on the column for the field and printed on each page following the titles.
format - the default format for data written to the field. If a format is not specified, then the data will not be formatted unless a format object is provided when writing data. If a format object is provided when adding a field and when writing data, then the format passed in the write method will be used.
width - the size of the field. The size is the number of characters which may fit into the field. If a size is not specified, then the size is the length of the label. If neither a label nor a size is specified then the default size is 12 characters wide.

Writing to a field:
Write operations are performed from left to right, line by line. If a series of writes are performed without specifying a name for the field, the fields will be written to in the sequence of their creation. After the last field is written to, the next write will be performed on the first field created, on a new line. If a name is specified, spaces will be written to each field, until the field with the specified name is reached at which point the data will be written to the field. If the name of the field comes before the current field then the write will happen on a new line. Numbers are right justified and text is left justified.

Version:

1.0 July 2008, 2.0 (09/05/04), 3.0 (09/06/30), 4.0 (14/06/13)

Author:

Andrew Cheesman, David Hughes, David Hughes, David Hughes

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
ReportPrinter() Construct a report printer for printing in portrait orientation.
ReportPrinter(boolean portrait) Construct a report printer for printing in portrait (true) or landscape (false) orientation.

Method Summary

Modifier and Type	Method and Description
void	addField()
void	addField(java.text.Format fmt)
void	addField(java.text.Format fmt, int width)
void	addField(int width)
void	addField(java.lang.String name)
void	addField(java.lang.String name, java.text.Format fmt)
void	addField(java.lang.String name, java.text.Format fmt, int width)
void	addField(java.lang.String name, int width)
void	addField(java.lang.String name, java.lang.String label)
void	addField(java.lang.String name, java.lang.String label, java.text.Format fmt)
void	addField(java.lang.String name, java.lang.String label, java.text.Format fmt, int width) Adds a field to the report with specified name, label, default format and field width.
void	addField(java.lang.String name, java.lang.String label, int width)
void	close() Prints the report by prompting user with a print dialogue box, and closes the ReportPrinter.
int	getLineNumber() Returns the current line number on the current page.
int	getPageNumber() Returns the current page number of the current page.
void	newLine() Ends the current line and the next write is done to the first field on the next line on the page.
void	newPage() Ends the current page and creates a new page with titles and field labels.
int	print(java.awt.Graphics g, java.awt.print.PageFormat pf, int page) This method is used by Java for printing.
void	setTitle(java.lang.String... lines) Set the title on the report by passing a var args of strings to this method.
void	writeBoolean(boolean b)
void	writeBoolean(boolean b, java.text.Format fmt)
void	writeBoolean(java.lang.String name, boolean b)
void	writeBoolean(java.lang.String name, boolean b, java.text.Format fmt) Writes the boolean value to the field with the specified name and left justifying the output.
void	writeByte(byte b)
void	writeByte(byte b, java.text.Format fmt)
void	writeByte(java.lang.String name, byte b)
void	writeByte(java.lang.String name, byte b, java.text.Format fmt) Writes the byte value to the field with the specified name and right justifying the output.
void	writeChar(char c)
void	writeChar(char c, java.text.Format fmt)
void	writeChar(java.lang.String name, char c)
void	writeChar(java.lang.String name, char c, java.text.Format fmt) Writes the char value to the field with the specified name and left justifying the output.
void	writeDouble(double d)
void	writeDouble(double d, java.text.Format fmt)
void	writeDouble(java.lang.String name, double d)
void	writeDouble(java.lang.String name, double d, java.text.Format fmt) Writes the double value to the field with the specified name and right justifying the output.
void	writeFloat(float f)
void	writeFloat(float f, java.text.Format fmt)
void	writeFloat(java.lang.String name, float f)
void	writeFloat(java.lang.String name, float f, java.text.Format fmt) Writes the float value to the field with the specified name and right justifying the output.
void	writeInt(int i)
void	writeInt(int i, java.text.Format fmt)
void	writeInt(java.lang.String name, int i)
void	writeInt(java.lang.String name, int i, java.text.Format fmt) Writes the int value to the field with the specified name and right justifying the output.
void	writeLine(java.lang.String s)
void	writeLine(java.lang.String s, java.text.Format fmt) Writes a string to the report immediately following the previous field and ending the line.
void	writeLong(long l)
void	writeLong(long l, java.text.Format fmt)
void	writeLong(java.lang.String name, long l)
void	writeLong(java.lang.String name, long l, java.text.Format fmt) Writes the long value to the field with the specified name and right justifying the output.
void	writeShort(short s)
void	writeShort(short s, java.text.Format fmt)
void	writeShort(java.lang.String name, short s)
void	writeShort(java.lang.String name, short s, java.text.Format fmt) Writes the short value to the field with the specified name and right justifying the output.
void	writeString(java.lang.String s)
void	writeString(java.lang.String s, java.text.Format fmt)
void	writeString(java.lang.String name, java.lang.String s)
void	writeString(java.lang.String name, java.lang.String s, java.text.Format fmt) Writes the String value to the field with the specified name and left justifying the output.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportPrinter

public ReportPrinter()

Construct a report printer for printing in portrait orientation.

ReportPrinter

public ReportPrinter(boolean portrait)

Construct a report printer for printing in portrait (true) or landscape (false) orientation.

Method Detail

getLineNumber

public int getLineNumber()

Returns the current line number on the current page.

Returns:

the line number.

getPageNumber

public int getPageNumber()

Returns the current page number of the current page.

Returns:

the page number.

setTitle

public void setTitle(java.lang.String... lines)

Set the title on the report by passing a var args of strings to this method. Each string will be a seperate line of the title, and the title will show up on the first page of the report and every page created with the newPage() method.

Parameters:

lines - a var args of Strings, each String becomes a line in the title.

addField

public void addField(java.lang.String name,
                     java.lang.String label,
                     java.text.Format fmt,
                     int width)

Adds a field to the report with specified name, label, default format and field width. Write operations are peformed on the fields which creates columns of data.
All of the parameters are optional.(see "Fields" above)

Parameters:

name - The name of the field. The field can be accessed for write operations by providing the name. For details of behaviour of writing by specifying a name and without a name see "Writing to a field" above.

label - The label of the field column to be displayed on the report. The label is centered over the field.

fmt - A default format for writing to the field.

width - The width of the field.

addField

public void addField(java.lang.String name,
                     java.lang.String label,
                     java.text.Format fmt)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(java.lang.String name,
                     java.lang.String label)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(java.lang.String name)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(java.lang.String name,
                     java.text.Format fmt,
                     int width)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(java.lang.String name,
                     java.text.Format fmt)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(java.lang.String name,
                     java.lang.String label,
                     int width)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(java.lang.String name,
                     int width)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(java.text.Format fmt,
                     int width)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(java.text.Format fmt)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField(int width)

See Also:

addField(String name, String label, Format fmt, int width)

addField

public void addField()

See Also:

addField(String name, String label, Format fmt, int width)

close

public void close()

Prints the report by prompting user with a print dialogue box, and closes the ReportPrinter.

newPage

public void newPage()

Ends the current page and creates a new page with titles and field labels.

newLine

public void newLine()

Ends the current line and the next write is done to the first field on the next line on the page.

writeBoolean

public void writeBoolean(java.lang.String name,
                         boolean b,
                         java.text.Format fmt)

Writes the boolean value to the field with the specified name and left justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

b - the value to write

fmt - a format object to format the data with.

writeBoolean

public void writeBoolean(java.lang.String name,
                         boolean b)

See Also:

( String name, boolean b, Format fmt )

writeBoolean

public void writeBoolean(boolean b,
                         java.text.Format fmt)

See Also:

( String name, boolean b, Format fmt )

writeBoolean

public void writeBoolean(boolean b)

See Also:

( String name, boolean b, Format fmt )

writeByte

public void writeByte(java.lang.String name,
                      byte b,
                      java.text.Format fmt)

Writes the byte value to the field with the specified name and right justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

b - the value to write

fmt - a format object to format the data with.

writeByte

public void writeByte(java.lang.String name,
                      byte b)

See Also:

( String name, byte b, Format fmt )

writeByte

public void writeByte(byte b,
                      java.text.Format fmt)

See Also:

( String name, byte b, Format fmt )

writeByte

public void writeByte(byte b)

See Also:

( String name, byte b, Format fmt )

writeChar

public void writeChar(java.lang.String name,
                      char c,
                      java.text.Format fmt)

Writes the char value to the field with the specified name and left justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

c - the value to write

fmt - a format object to format the data with.

writeChar

public void writeChar(java.lang.String name,
                      char c)

See Also:

( String name, char c, Format fmt )

writeChar

public void writeChar(char c,
                      java.text.Format fmt)

See Also:

( String name, char c, Format fmt )

writeChar

public void writeChar(char c)

See Also:

( String name, char c, Format fmt )

writeDouble

public void writeDouble(java.lang.String name,
                        double d,
                        java.text.Format fmt)

Writes the double value to the field with the specified name and right justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

d - the value to write

fmt - a format object to format the data with.

writeDouble

public void writeDouble(java.lang.String name,
                        double d)

See Also:

( String name, double d, Format fmt )

writeDouble

public void writeDouble(double d,
                        java.text.Format fmt)

See Also:

( String name, double d, Format fmt )

writeDouble

public void writeDouble(double d)

See Also:

( String name, double d, Format fmt )

writeFloat

public void writeFloat(java.lang.String name,
                       float f,
                       java.text.Format fmt)

Writes the float value to the field with the specified name and right justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

f - the value to write

fmt - a format object to format the data with.

writeFloat

public void writeFloat(java.lang.String name,
                       float f)

See Also:

( String name, float fmt, Format fmt )

writeFloat

public void writeFloat(float f,
                       java.text.Format fmt)

See Also:

( String name, float fmt, Format fmt )

writeFloat

public void writeFloat(float f)

See Also:

( String name, float fmt, Format fmt )

writeInt

public void writeInt(java.lang.String name,
                     int i,
                     java.text.Format fmt)

Writes the int value to the field with the specified name and right justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

i - the value to write

fmt - a format object to format the data with.

writeInt

public void writeInt(java.lang.String name,
                     int i)

See Also:

( String name, int i, Format fmt )

writeInt

public void writeInt(int i,
                     java.text.Format fmt)

See Also:

( String name, int i, Format fmt )

writeInt

public void writeInt(int i)

See Also:

( String name, int i, Format fmt )

writeLong

public void writeLong(java.lang.String name,
                      long l,
                      java.text.Format fmt)

Writes the long value to the field with the specified name and right justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

l - the value to write

fmt - a format object to format the data with.

writeLong

public void writeLong(java.lang.String name,
                      long l)

See Also:

( String name, long l, Format fmt )

writeLong

public void writeLong(long l,
                      java.text.Format fmt)

See Also:

( String name, long l, Format fmt )

writeLong

public void writeLong(long l)

See Also:

( String name, long l, Format fmt )

writeShort

public void writeShort(java.lang.String name,
                       short s,
                       java.text.Format fmt)

Writes the short value to the field with the specified name and right justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

s - the value to write

fmt - a format object to format the data with.

writeShort

public void writeShort(java.lang.String name,
                       short s)

See Also:

( String name, short s)

writeShort

public void writeShort(short s,
                       java.text.Format fmt)

See Also:

( String name, short s)

writeShort

public void writeShort(short s)

See Also:

( String name, short s)

writeString

public void writeString(java.lang.String name,
                        java.lang.String s,
                        java.text.Format fmt)

Writes the String value to the field with the specified name and left justifying the output. If the field with the specified name is not the next field, then blank data will be written to each field until the specified field is next.
If a name is not specified the data is written to the next field. All parameters except the boolean are optional (see Fields above)

Parameters:

name - the name of the field.

s - the value to write

fmt - a format object to format the data with.

writeString

public void writeString(java.lang.String name,
                        java.lang.String s)

See Also:

( String name, String s, Format fmt )

writeString

public void writeString(java.lang.String s,
                        java.text.Format fmt)

See Also:

( String name, String s, Format fmt )

writeString

public void writeString(java.lang.String s)

See Also:

( String name, String s, Format fmt )

writeLine

public void writeLine(java.lang.String s,
                      java.text.Format fmt)

Writes a string to the report immediately following the previous field and ending the line.

Parameters:

s - the String to write to the report.

fmt - an optional format object to format the string.

writeLine

public void writeLine(java.lang.String s)

See Also:

writeLine( String s, Format fmt )

print

public int print(java.awt.Graphics g,
                 java.awt.print.PageFormat pf,
                 int page)
          throws java.awt.print.PrinterException

This method is used by Java for printing.
This method is called by the system. It should not be called directly by the program.

Specified by:

print in interface java.awt.print.Printable

Throws:

java.awt.print.PrinterException