ilog.views.gantt.print

Class IlvPrintableTimeScale

java.lang.Object

ilog.views.util.print.IlvPrintableObject

ilog.views.util.print.IlvPrintableComponent

ilog.views.gantt.print.IlvPrintableTimeScale

All Implemented Interfaces:

Printable

public class IlvPrintableTimeScale
extends IlvPrintableComponent

A utility class designed to print a portion of the IlvTimeScale.

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
IlvPrintableTimeScale(IlvTimeScale timeScale, IlvUnit.Rectangle area, Date date, IlvDuration duration) Creates a PrintableTimeScale to print a specified portion of a given IlvTimeScale.

Method Summary

Modifier and Type	Method and Description
IlvTimeScale.PaintContext	getPaintContext() Returns the IlvTimeScale.PaintContext used to print the time scale.
int	print(Graphics dst, PageFormat format, int pageIndex) Implements the java.awt.print.Printable.print method.
void	setPrintableArea(IlvUnit.Rectangle area) Sets the area, in page coordinates, defining where the time scale should be printed.

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

getComponent, getPrintableArea, setComponent

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

IlvPrintableTimeScale

public IlvPrintableTimeScale(IlvTimeScale timeScale,
                             IlvUnit.Rectangle area,
                             Date date,
                             IlvDuration duration)

Creates a PrintableTimeScale to print a specified portion of a given IlvTimeScale.

Parameters:

timeScale - The IlvTimeScale to be printed.

area - The rectangular area, in paper coordinates, defining where the time scale is printed.

date - The start of the time interval to print.

duration - The duration of the time interval to print.

Method Detail

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

setPrintableArea

public void setPrintableArea(IlvUnit.Rectangle area)

Sets the area, in page coordinates, defining where the time scale should be printed. This function creates a new IlvTimeScale.PaintContext for the specified print area.

Overrides:

setPrintableArea in class IlvPrintableComponent

Parameters:

area - The print area, defined in page coordinates.

getPaintContext

public IlvTimeScale.PaintContext getPaintContext()

Returns the IlvTimeScale.PaintContext used to print the time scale.