ilog.views.gantt.print

Class IlvPrintableGanttSheet

java.lang.Object

ilog.views.util.print.IlvPrintableObject

ilog.views.util.print.IlvPrintableComponent

ilog.views.gantt.print.IlvPrintableGanttSheet

All Implemented Interfaces:

Printable

public class IlvPrintableGanttSheet
extends IlvPrintableComponent

A utility class designed to print a portion of an IlvGanttSheet. Users of the class can specify the time interval and the vertical interval. The class automatically calculates the transformation required to print the specified portion.

Since:

JViews 5.5

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
IlvPrintableGanttSheet(IlvGanttSheet sheet, IlvUnit.Rectangle area, Date start, IlvDuration duration, double yStart, double yEnd) Creates a PrintableGanttSheet that is used to print a portion of the Gantt sheet.
IlvPrintableGanttSheet(IlvGanttSheet sheet, IlvUnit.Rectangle area, Date start, IlvDuration duration, int row, double scale) Creates a PrintableGanttSheet that is used to print a portion of the Gantt sheet.
IlvPrintableGanttSheet(IlvGanttSheet sheet, IlvUnit.Rectangle area, Date start, IlvDuration duration, int fromRow, int toRow) Creates a PrintableGanttSheet that is used to print a portion of the Gantt sheet.

Method Summary

Modifier and Type	Method and Description
boolean	isPrintingWithBackground() Returns whether the background is painted when printing.
int	print(Graphics dst, PageFormat format, int pageIndex) Implements the java.awt.print.Printable.print method.
void	setPrintingWithBackground(boolean includeBackground) Sets whether the background is painted when printing.

Methods inherited from class ilog.views.util.print.IlvPrintableComponent

getComponent, getPrintableArea, setComponent, setPrintableArea

Methods inherited from class ilog.views.util.print.IlvPrintableObject

getPage

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPrintableGanttSheet

public IlvPrintableGanttSheet(IlvGanttSheet sheet,
                              IlvUnit.Rectangle area,
                              Date start,
                              IlvDuration duration,
                              int fromRow,
                              int toRow)

Creates a PrintableGanttSheet that is used to print a portion of the Gantt sheet.

Parameters:

sheet - The Gantt sheet to be printed.

area - The rectangular area, in paper coordinates, indicating the position where the Gantt sheet should be printed.

start - The start date of the time interval to be printed.

duration - The duration of the time interval to be printed.

fromRow - The top row of the vertical interval to be printed.

toRow - The bottom row of the vertical interval to be printed.

IlvPrintableGanttSheet

public IlvPrintableGanttSheet(IlvGanttSheet sheet,
                              IlvUnit.Rectangle area,
                              Date start,
                              IlvDuration duration,
                              int row,
                              double scale)

Creates a PrintableGanttSheet that is used to print a portion of the Gantt sheet.

Parameters:

sheet - The Gantt sheet to be printed.

area - The rectangular area, in paper coordinates, indicating the position where the Gantt sheet should be printed.

start - The start date of the time interval to be printed.

duration - The duration of the time interval to be printed.

row - The top row of the vertical interval to be printed.

scale - The vertical zoom scale used to print.

IlvPrintableGanttSheet

public IlvPrintableGanttSheet(IlvGanttSheet sheet,
                              IlvUnit.Rectangle area,
                              Date start,
                              IlvDuration duration,
                              double yStart,
                              double yEnd)

Creates a PrintableGanttSheet that is used to print a portion of the Gantt sheet.

Parameters:

sheet - The Gantt sheet to be printed.

area - The rectangular area, in paper coordinates, indicating the position where the Gantt sheet should be printed.

start - The start date of the time interval to be printed.

duration - The duration of the time interval to be printed.

yStart - The top of the vertical interval to be printed.

yEnd - The bottom of the vertical interval to be printed.

Method Detail

isPrintingWithBackground

public boolean isPrintingWithBackground()

Returns whether the background is painted when printing.

Returns:

true if the background is painted when printing

Since:

JViews 8.8

See Also:

setPrintingWithBackground(boolean)

setPrintingWithBackground

public void setPrintingWithBackground(boolean includeBackground)

Sets whether the background is painted when printing. The default value is false: By default, no background is printed.

Parameters:

includeBackground - true if the background shall be painted when printing

Since:

JViews 8.8

See Also:

isPrintingWithBackground(), IlvManagerView.setBackground(Color), IlvManagerView.setBackgroundPatternLocation(URL)

print

public int print(Graphics dst,
                 PageFormat format,
                 int pageIndex)
          throws PrinterException

Implements the java.awt.print.Printable.print method. This method is called to print the object.

Parameters:

dst - The output device, which must be a Graphics2D object.

format - The format of the page.

pageIndex - The index of the page.

Throws:

PrinterException