de.must.print

Class ProportionalListReportDirectly

java.lang.Object

java.lang.Thread

de.must.middle.MustThread

de.must.middle.InterruptibleThread

de.must.middle.InterruptibleBatchThread

de.must.print.ProportionalListReportDirectly

All Implemented Interfaces:

BatchControllable, Controllable, CoreRunnable, Exemptible, ExemptibleManager, ProportionalListReport, java.awt.print.Printable, java.lang.Runnable

Direct Known Subclasses:

PrintDirectlySample

public abstract class ProportionalListReportDirectly
extends InterruptibleBatchThread
implements ProportionalListReport, java.awt.print.Printable

Direct print implementation of the report interface for lists with proportional column definition. This is a way of printing by a view lines of code as done in de.must.samples.PrintDirectlySample. Word wrap of continuous text is supported as well as table printing. The paradigm of this sample is - back to the roots: Don't call me, I'll call you. This means e.g., I read some database tables, compute some stuff and put it out in the sequence as I am used to. The result is buffered, at the moment in Vectors. After that the result is provided in a sequence, the renderer (printer) wants to retrieve it (e.g. page 1, page 2, again page 1).

See Also:

PrintDirectlySample

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Font	defaultFont
protected static double	SQUARE_ROOT_OF_TWO

Fields inherited from class de.must.middle.InterruptibleBatchThread

sessionResources

Fields inherited from class de.must.middle.InterruptibleThread

threadController

Fields inherited from class de.must.middle.MustThread

threadDoneListeners

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface de.must.print.ProportionalListReport

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface de.must.middle.BatchControllable

GROUP_TERMINATION_ALLOWED_WITHOUT_CONFIRMATION, GROUP_TERMINATION_NOT_ALLOWED, GROUP_TERMINATION_REQUIRES_CONFIRMATION

Constructor Summary

Constructors

Constructor and Description
ProportionalListReportDirectly(SessionResources sessionResources)

Method Summary

Modifier and Type	Method and Description
protected PrintablePage.PrintPosition	add(java.lang.String paragraph) Adds a paragraph.
PrintablePage.PrintPosition	add(java.lang.String[] columnValues) Adds a table row to the current page.
protected PrintablePage.PrintPosition	add(java.lang.String[] columnValues, int numberOfFollowingLinesToKeepTogether) Adds a table row to the current page.
PrintablePage.PrintPosition	add(java.util.Vector<java.lang.String> columnValues) Adds a table row to the current page.
protected PrintablePage.PrintPosition	addEmptyLine() Adds an empty line to the page.
PrintablePage.PrintPosition	addEmptyLine(double factor) Adds an empty line to the page.
protected void	addHLine() Adds a horizontal line.
protected PrintablePage.PrintPosition	addTableHeader(java.lang.String[] headerValues) Adds a row of values with meaning table header.
PrintablePage.PrintPosition	addTableHeader(java.util.Vector<java.lang.String> headerValues) Adds a row of values with meaning table header.
void	addTitle(java.lang.String title) Adds a title (with special font.
protected void	changeFontIfNew(PrintablePage.PrintableItem printableItem, java.awt.Graphics graphics)
protected abstract void	fillList() Called when print is called the first time, therefore Graphics is known.
protected void	fillPageHeader() Fills the header of each page.
java.lang.String	format(double doubleValue)
protected PrintablePage.PrintPosition	getCurrentPrintPosition()
protected java.awt.Font	getDefaultFont()
protected java.awt.print.PageFormat	getPageFormat(java.awt.print.PrinterJob printerJob) Returns the page format to use.
abstract java.lang.String	getPrinterJobName()
protected void	pageFeed()
int	print(java.awt.Graphics graphics, java.awt.print.PageFormat pageFormat, int pageIndex)
protected void	printFixStuff(java.awt.Graphics graphics, java.awt.print.PageFormat pageFormat, int pageIndex) Prints fix stuff for each page.
protected void	resetFont() Resets the current font and its current font specification to default
void	runCore(DataObjectConstructionDetails docd) Runs the core of the runnable With opportunity to use e.g. a different DB connection.
void	setAlignment(int columnIndex, int alignType) Sets the alignment of a specific column.
void	setConstantItems(boolean constantItems) Determines whether or not the following items should be printed on each page.
protected void	setCopies(int copies)
void	setDefaultProportion(int[] columnProportion) Sets the column default proportion to influence column width.
void	setDefaultProportion(java.util.Vector<java.lang.Integer> columnProportion) Sets the column default proportion to influence column width.
protected void	setFont(java.awt.Font newFont) Sets the current font and its associated current font specification
protected void	setMainTray()
void	setOnPageInfo() Activates automatic printing of page information at the standard place.
protected void	setOrientationLandscape()
void	setPageInfoPosition(java.awt.Point pageInfoPosition) Sets the position where page number information is to be placed.
void	setPreviewer(Previewer previewer) Sets a previewer.
void	setPrinter(java.lang.String printerName) Sets the print service by the name as specified.
void	setPrinter(java.lang.String printerName, java.lang.String trayName) Sets the print service by the name as specified.
void	setPrinterJob(java.awt.print.PrinterJob printerJob)
protected void	setTray(javax.print.attribute.standard.MediaTray mediaTray)
void	setYStartPosition(int yStartPosition) Sets the vertical position from where on the page print sequence starts.

Methods inherited from class de.must.middle.InterruptibleBatchThread

getSessionResources, isTerminationRequested, isToRun, requiresUserConfirmationToTerminate, runCore, setTerminationRequiresUserConfirmation, start, terminate

Methods inherited from class de.must.middle.InterruptibleThread

free, register, register, run, runPartAfterCore, setStatusInformation, setThreadController

Methods inherited from class de.must.middle.MustThread

addThreadDoneListener, fireThreadDone, fireThreadDone, getEventMessage, getFinalState, idle, logDebug, logError, logError, logInfo, setEventErrorMessage, setEventMessage, setFinalState

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.must.middle.Controllable

addThreadDoneListener, runCore, setThreadController, start

Methods inherited from interface de.must.middle.BatchControllable

getName

Field Detail

SQUARE_ROOT_OF_TWO

protected static final double SQUARE_ROOT_OF_TWO

See Also:

Constant Field Values

defaultFont

protected java.awt.Font defaultFont

Constructor Detail

ProportionalListReportDirectly

public ProportionalListReportDirectly(SessionResources sessionResources)

Method Detail

format

public java.lang.String format(double doubleValue)

setOrientationLandscape

protected void setOrientationLandscape()

setCopies

protected void setCopies(int copies)

setMainTray

protected void setMainTray()

setTray

protected void setTray(javax.print.attribute.standard.MediaTray mediaTray)

setYStartPosition

public void setYStartPosition(int yStartPosition)

Sets the vertical position from where on the page print sequence starts. Suitable to reserve room for headers / logos.

Parameters:

yStartPosition -

setPrinterJob

public void setPrinterJob(java.awt.print.PrinterJob printerJob)

getPrinterJobName

public abstract java.lang.String getPrinterJobName()

setPreviewer

public void setPreviewer(Previewer previewer)

Sets a previewer. Optional.

Parameters:

previewer - the previewer to be used to preview printout.

setConstantItems

public void setConstantItems(boolean constantItems)

Determines whether or not the following items should be printed on each page. Useful for headers and table headers. If page header contains variable data (e.g. group fields), override fillPageHeader instead of switching on constant items.

Parameters:

constantItems - whether or not the following items should be printed on each page

setOnPageInfo

public void setOnPageInfo()

Activates automatic printing of page information at the standard place.

setPageInfoPosition

public void setPageInfoPosition(java.awt.Point pageInfoPosition)

Sets the position where page number information is to be placed.

Parameters:

pageInfoPosition - the ending position of the page information

setDefaultProportion

public void setDefaultProportion(java.util.Vector<java.lang.Integer> columnProportion)

Sets the column default proportion to influence column width.

Parameters:

columnProportion - the proportion usually to be used

setDefaultProportion

public void setDefaultProportion(int[] columnProportion)

Sets the column default proportion to influence column width.

Specified by:

setDefaultProportion in interface ProportionalListReport

Parameters:

columnProportion - the proportion usually to be used

setAlignment

public void setAlignment(int columnIndex,
                         int alignType)

Sets the alignment of a specific column.

Parameters:

columnIndex - the index of the regarded column

alignType - the align type of the specified column

See Also:

ProportionalListReport.ALIGN_LEFT, ProportionalListReport.ALIGN_CENTER, ProportionalListReport.ALIGN_RIGHT

setFont

protected void setFont(java.awt.Font newFont)

Sets the current font and its associated current font specification

Parameters:

newFont - the new font to become current font

resetFont

protected void resetFont()

Resets the current font and its current font specification to default

getDefaultFont

protected java.awt.Font getDefaultFont()

add

protected PrintablePage.PrintPosition add(java.lang.String paragraph)

Adds a paragraph. Word wrap is automatically done.

Parameters:

paragraph - the paragraph to be printed

Returns:

the print position of the last line

addTitle

public void addTitle(java.lang.String title)

Adds a title (with special font.

Parameters:

title - the title to be added

addTableHeader

public PrintablePage.PrintPosition addTableHeader(java.util.Vector<java.lang.String> headerValues)

Adds a row of values with meaning table header.

Parameters:

headerValues - the table header values

Returns:

the current print position

addTableHeader

protected PrintablePage.PrintPosition addTableHeader(java.lang.String[] headerValues)

Adds a row of values with meaning table header.

Parameters:

headerValues - the table header values

Returns:

the current print position

addHLine

protected void addHLine()

Adds a horizontal line.

add

public PrintablePage.PrintPosition add(java.util.Vector<java.lang.String> columnValues)

Adds a table row to the current page.

Parameters:

columnValues - values of the current row.

Returns:

the current print position

add

public PrintablePage.PrintPosition add(java.lang.String[] columnValues)

Adds a table row to the current page.

Parameters:

columnValues - values of the current row.

Returns:

the current print position

add

protected PrintablePage.PrintPosition add(java.lang.String[] columnValues,
                                          int numberOfFollowingLinesToKeepTogether)

Adds a table row to the current page.

Parameters:

columnValues - values of the current row.

numberOfFollowingLinesToKeepTogether - the number of following lines to keep together

Returns:

the current print position

addEmptyLine

protected PrintablePage.PrintPosition addEmptyLine()

Adds an empty line to the page.

Returns:

the current print position

addEmptyLine

public PrintablePage.PrintPosition addEmptyLine(double factor)

Adds an empty line to the page.

Parameters:

factor - may be 2 lines or 1/2 line ...

Returns:

the current print position

getCurrentPrintPosition

protected PrintablePage.PrintPosition getCurrentPrintPosition()

pageFeed

protected void pageFeed()

fillPageHeader

protected void fillPageHeader()

Fills the header of each page. Useful if header contains variable data like e.g. group fields. Override it to build page header with variable data. Will be called automatically each time a new page is build.

setPrinter

public void setPrinter(java.lang.String printerName)

Sets the print service by the name as specified. If no print service with the specified name is found, the print service will not be changed.

Parameters:

printerName -

setPrinter

public void setPrinter(java.lang.String printerName,
                       java.lang.String trayName)

Sets the print service by the name as specified. If no print service with the specified name is found, the print service will not be changed.

Parameters:

printerName -

runCore

public void runCore(DataObjectConstructionDetails docd)
             throws java.lang.Exception

Description copied from interface: CoreRunnable

Runs the core of the runnable With opportunity to use e.g. a different DB connection.

Specified by:

runCore in interface CoreRunnable

Parameters:

docd - the DataObjectConstructionDetails to use - that may differ from session data details.

Throws:

java.lang.Exception

getPageFormat

protected java.awt.print.PageFormat getPageFormat(java.awt.print.PrinterJob printerJob)

Returns the page format to use. Override method to change standard behavior.

Parameters:

printerJob - the given PrinterJob

Returns:

the page format to use

print

public int print(java.awt.Graphics graphics,
                 java.awt.print.PageFormat pageFormat,
                 int pageIndex)
          throws java.awt.print.PrinterException

Specified by:

print in interface java.awt.print.Printable

Throws:

java.awt.print.PrinterException

printFixStuff

protected void printFixStuff(java.awt.Graphics graphics,
                             java.awt.print.PageFormat pageFormat,
                             int pageIndex)

Prints fix stuff for each page. Override this method to use it, it is called each time a page should be rendered.

Parameters:

graphics - the context into which the page is drawn

pageFormat - the size and orientation of the page being drawn

pageIndex - the zero based index of the page to be drawn

fillList

protected abstract void fillList()

Called when print is called the first time, therefore Graphics is known. Thus, all positions may be computed. Put all your instructions to print (like add...) inside this method. Call start() to start thread in order to trigger fillList() to be called.

changeFontIfNew

protected void changeFontIfNew(PrintablePage.PrintableItem printableItem,
                               java.awt.Graphics graphics)