ilog.views.chart.print

Class IlvChartPrintableDocument

java.lang.Object

ilog.views.util.print.IlvPrintableDocument

ilog.views.chart.print.IlvChartPrintableDocument

All Implemented Interfaces:

Pageable, Printable

Direct Known Subclasses:

IlvResourceDataChartPrintableDocument

public class IlvChartPrintableDocument
extends IlvPrintableDocument

The IlvChartPrintableDocument allows you to print an IlvChart in multiple pages. The printing is executed according to several configuration parameters listed below:

• The resizing mode. This parameter defines how a printed chart will fill the printable area. Two modes are supported. The FIT_TO_DIMENSION mode resizes the chart so that it fits entirely the printable area independently of the chart current aspect ratio. The SCALE_TO_DIMENSION mode resizes the chart so that it fits the printable area taking into account the chart current aspect ratio.
• The number of pages.
• The chart component to print (the chart itself, or the chart area).
• The data window to print.
• Whether the y-scales are drawn on each page.

A document is composed of a set of pages containing printable graphic objects. Pages are created in the createPages() method.

Note that an IlvChartPrintableDocument does not handle the printing by itself and requires to be associated with an IlvChartPrintingController in order to be printed.

Since:

JViews 5.5

See Also:

IlvChartPrintingController

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIT_TO_DIMENSION The resize mode value to resize the chart to fit the printable page.
static float	HIGH_RESOLUTION The high resolution scale factor.
static float	IDENTITY_RESOLUTION The identity resolution scale factor.
static float	MEDIUM_RESOLUTION The medium resolution scale factor.
static int	SCALE_TO_DIMENSION The resize mode value to scale the chart to fit the printable page.
static int	XMAX_YMAX The XMAX_YMAX scaling alignment value.
static int	XMAX_YMID The XMAX_YMID scaling alignment value.
static int	XMAX_YMIN The XMAX_YMIN scaling alignment value.
static int	XMID_YMAX The XMID_YMAX scaling alignment value.
static int	XMID_YMID The XMID_YMID scaling alignment value.
static int	XMID_YMIN The XMID_YMIN scaling alignment value.
static int	XMIN_YMAX The YMIN_YMAX scaling alignment value.
static int	XMIN_YMID The XMIN_YMID scaling alignment value.
static int	XMIN_YMIN The XMIN_YMIN scaling alignment value.

Fields inherited from class ilog.views.util.print.IlvPrintableDocument

ORDERED_BY_COLUMNS, ORDERED_BY_ROWS

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Constructor Summary

Constructors

Constructor and Description
IlvChartPrintableDocument(String name, IlvChart chart, boolean repeatYScales, int pages, boolean printChart, IlvDataWindow window, int orientation, Paper paperFormat) Creates a IlvChartPrintableDocument for the specified IlvChart using the specified parameters.
IlvChartPrintableDocument(String name, IlvChart chart, boolean repeatYScales, int pages, boolean printChart, IlvDataWindow window, PageFormat pageFormat) Creates a IlvChartPrintableDocument for the specified IlvChart using the specified parameters.
IlvChartPrintableDocument(String name, IlvChart chart, int orientation, Paper paperFormat) Creates a IlvChartPrintableDocument for the specified IlvChart using the specified parameters.
IlvChartPrintableDocument(String name, IlvChart chart, PageFormat pageFormat) Creates a IlvChartPrintableDocument for the specified IlvChart using the specified parameters.

Method Summary

Modifier and Type	Method and Description
protected IlvDataWindow	computeDataWindow(int pageIdx, int coordSysIdx) Returns the data window to print in the specified page for the specified coordinate system.
protected IlvPage[]	createPages() Creates the pages and populates this document.
protected IlvPrintableChart	createPrintableChart(IlvPage page, int pageIdx, IlvUnit.Rectangle pageArea) Returns a new IlvPrintableChart instance to print the document chart in the specified page.
Color	getBackground() Returns the background color override.
IlvChart	getChart() Returns the IlvChart that is printed.
IlvDataWindow	getDataWindow() Returns the data window printed in this document.
IlvFlow	getFlow() Overwrite the method to disable the usage of the flow in this type of document.
int	getMultiPageCount() Returns the number of pages on which the chart is printed.
boolean	getRepeatTitle() Returns whether the x-scale title should be printed on every pages.
boolean	getRepeatYScales() Returns whether the Y-Scales should be printed on every pages.
int	getResizeMode() Returns the resize mode.
float	getResolutionScaleFactor() Returns the resolution scale factor.
int	getScalingAlignment() Returns the scaling alignment.
boolean	isPrintingChart() Returns which of the chart or chart area is printed.
void	setBackground(Color bgColor) Sets the background color override.
void	setChart(IlvChart chart) Sets the chart to be printed.
void	setDataWindow(IlvDataWindow window) Sets the data window printed in this document.
void	setMultiPageCount(int pages) Sets the number of pages on which the chart is printed..
void	setPrintingChart(boolean printChart) Sets which of the chart or chart area is printed.
void	setRepeatTitle(boolean repeat) Sets whether the x-scales title should be printed on every pages.
void	setRepeatYScales(boolean repeat) Sets whether the Y-Scales should be printed on every pages.
void	setResizeMode(int mode) Sets the resize mode.
void	setResolutionScaleFactor(float factor) Sets the resolution scale factor.
void	setScalingAlignment(int align) Sets the scaling alignment.

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

addPage, addPropertyChangeListener, addPropertyChangeListener, enablePrintStyle, firePropertyChange, getAuthor, getColumnCount, getDate, getFooter, getHeader, getImageableBounds, getName, getNumberOfPages, getOrientation, getPage, getPageFormat, getPageFormat, getPageIndex, getPageOrder, getPaperFormat, getPrintable, getSides, getTemplatePage, invalidateFlowLayout, invalidatePages, isFlowLayoutValid, maybeInvalidatePages, prepareDocument, print, removeAll, removePage, removePropertyChangeListener, removePropertyChangeListener, setAuthor, setColumnCount, setDate, setFooter, setHeader, setName, setOrientation, setPageFormat, setPageOrder, setPages, setPaperFormat, setSides, setTemplatePage

Methods inherited from class java.lang.Object

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

Field Detail

FIT_TO_DIMENSION

public static final int FIT_TO_DIMENSION

The resize mode value to resize the chart to fit the printable page.

See Also:

Constant Field Values

SCALE_TO_DIMENSION

public static final int SCALE_TO_DIMENSION

The resize mode value to scale the chart to fit the printable page.

See Also:

Constant Field Values

XMIN_YMIN

public static final int XMIN_YMIN

The XMIN_YMIN scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

XMID_YMIN

public static final int XMID_YMIN

The XMID_YMIN scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

XMAX_YMIN

public static final int XMAX_YMIN

The XMAX_YMIN scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

XMIN_YMID

public static final int XMIN_YMID

The XMIN_YMID scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

XMID_YMID

public static final int XMID_YMID

The XMID_YMID scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

XMAX_YMID

public static final int XMAX_YMID

The XMAX_YMID scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

XMIN_YMAX

public static final int XMIN_YMAX

The YMIN_YMAX scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

XMID_YMAX

public static final int XMID_YMAX

The XMID_YMAX scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

XMAX_YMAX

public static final int XMAX_YMAX

The XMAX_YMAX scaling alignment value.

See Also:

setScalingAlignment(int), Constant Field Values

HIGH_RESOLUTION

public static final float HIGH_RESOLUTION

The high resolution scale factor.

See Also:

Constant Field Values

MEDIUM_RESOLUTION

public static final float MEDIUM_RESOLUTION

The medium resolution scale factor.

See Also:

Constant Field Values

IDENTITY_RESOLUTION

public static final float IDENTITY_RESOLUTION

The identity resolution scale factor.

See Also:

Constant Field Values

Constructor Detail

IlvChartPrintableDocument

public IlvChartPrintableDocument(String name,
                                 IlvChart chart,
                                 PageFormat pageFormat)

Creates a IlvChartPrintableDocument for the specified IlvChart using the specified parameters. The document creates pages used to print the specified chart. The printed data window is equal to the data ranges of the default coordinate system axis.

Parameters:

name - The document name.

chart - The chart to print.

pageFormat - The default page format used for pages of the document. Because a fixed page format is not apppropriate for all printers and all locales, it is recommended that this argument be constructed from IlvPrintingController.getDefaultPageFormat() or IlvPrintingController.getDefaultPaperFormat().

IlvChartPrintableDocument

public IlvChartPrintableDocument(String name,
                                 IlvChart chart,
                                 boolean repeatYScales,
                                 int pages,
                                 boolean printChart,
                                 IlvDataWindow window,
                                 PageFormat pageFormat)

Creates a IlvChartPrintableDocument for the specified IlvChart using the specified parameters. The document creates pages used to print the specified chart. To print multiple pages, you can use the parameter pages.

Parameters:

name - The document name.

chart - The chart to print.

repeatYScales - Indicates whether the y-scales are printed repeatedly on every page.

pages - The number of pages.

printChart - true to print the chart, false to print the chart area.

window - The printed data window.

pageFormat - The default page format used for pages of the document. Because a fixed page format is not apppropriate for all printers and all locales, it is recommended that this argument be constructed from IlvPrintingController.getDefaultPageFormat() or IlvPrintingController.getDefaultPaperFormat().

IlvChartPrintableDocument

public IlvChartPrintableDocument(String name,
                                 IlvChart chart,
                                 int orientation,
                                 Paper paperFormat)

Creates a IlvChartPrintableDocument for the specified IlvChart using the specified parameters. The document creates pages used to print the specified chart. The printed data window is equal to the data ranges of the default coordinate system axis.

Parameters:

name - The document name.

chart - The chart to print.

orientation - One of PageFormat.PORTRAIT, PageFormat.LANDSCAPE, PageFormat.REVERSE_LANDSCAPE.

paperFormat - A paper format object, or null if the paper format shall be provided by the IlvPrintingController, depending on the default printer or - if no printer is available - depending on the current locale. Because a fixed page format is not apppropriate for all printers and all locales, it is recommended that this argument be null or constructed from IlvPrintingController.getDefaultPaperFormat().

Since:

JViews 8.8

IlvChartPrintableDocument

public IlvChartPrintableDocument(String name,
                                 IlvChart chart,
                                 boolean repeatYScales,
                                 int pages,
                                 boolean printChart,
                                 IlvDataWindow window,
                                 int orientation,
                                 Paper paperFormat)

Creates a IlvChartPrintableDocument for the specified IlvChart using the specified parameters. The document creates pages used to print the specified chart. To print multiple pages, you can use the parameter pages.

Parameters:

name - The document name.

chart - The chart to print.

repeatYScales - Indicates whether the y-scales are printed repeatedly on every page.

pages - The number of pages.

printChart - true to print the chart, false to print the chart area.

window - The printed data window.

orientation - One of PageFormat.PORTRAIT, PageFormat.LANDSCAPE, PageFormat.REVERSE_LANDSCAPE.

paperFormat - A paper format object, or null if the paper format shall be provided by the IlvPrintingController, depending on the default printer or - if no printer is available - depending on the current locale. Because a fixed page format is not apppropriate for all printers and all locales, it is recommended that this argument be null or constructed from IlvPrintingController.getDefaultPaperFormat().

Since:

JViews 8.8

Method Detail

getChart

public IlvChart getChart()

Returns the IlvChart that is printed.

See Also:

setChart(IlvChart)

setChart

public void setChart(IlvChart chart)

Sets the chart to be printed.

Parameters:

chart - The new chart.

Since:

JViews 8.8

See Also:

getChart()

getRepeatYScales

public boolean getRepeatYScales()

Returns whether the Y-Scales should be printed on every pages.

See Also:

setRepeatYScales(boolean)

setRepeatYScales

public void setRepeatYScales(boolean repeat)

Sets whether the Y-Scales should be printed on every pages.

getRepeatTitle

public boolean getRepeatTitle()

Returns whether the x-scale title should be printed on every pages.

See Also:

setRepeatTitle(boolean)

setRepeatTitle

public void setRepeatTitle(boolean repeat)

Sets whether the x-scales title should be printed on every pages.

getMultiPageCount

public int getMultiPageCount()

Returns the number of pages on which the chart is printed.

See Also:

setMultiPageCount(int)

setMultiPageCount

public void setMultiPageCount(int pages)

Sets the number of pages on which the chart is printed..

isPrintingChart

public final boolean isPrintingChart()

Returns which of the chart or chart area is printed.

Returns:

true to print the chart, false to print the chart area.

setPrintingChart

public void setPrintingChart(boolean printChart)

Sets which of the chart or chart area is printed.

Parameters:

printChart - true to print the chart, false to print the chart area.

getDataWindow

public IlvDataWindow getDataWindow()

Returns the data window printed in this document.

See Also:

setDataWindow(ilog.views.chart.IlvDataWindow)

setDataWindow

public void setDataWindow(IlvDataWindow window)

Sets the data window printed in this document.

getResizeMode

public int getResizeMode()

Returns the resize mode.

See Also:

setResizeMode(int)

setResizeMode

public void setResizeMode(int mode)

Sets the resize mode.

See Also:

FIT_TO_DIMENSION, SCALE_TO_DIMENSION

getScalingAlignment

public int getScalingAlignment()

Returns the scaling alignment.

See Also:

This property is meaningful only when the resize mode is set to {@link #SCALE_TO_DIMENSION}.

setScalingAlignment

public void setScalingAlignment(int align)

Sets the scaling alignment. This property is used to specify the location of the chart within the printable area when the chart aspect ratio does not match the printable area aspect ratio.

Parameters:

align - The scaling alignment. One of the XMIN_YMIN,XMID_YMIN, XMAX_YMIN,XMIN_YMID,XMID_YMID,XMAX_YMID, XMIN_YMAX,XMID_YMAX,XMAX_YMAX. This property is meaningful only when the resize mode is set to SCALE_TO_DIMENSION.

getResolutionScaleFactor

public float getResolutionScaleFactor()

Returns the resolution scale factor.

See Also:

setResolutionScaleFactor(float)

setResolutionScaleFactor

public void setResolutionScaleFactor(float factor)

Sets the resolution scale factor. This scale factor is used as an extra transform applied on the chart area during the printing in order to increase the resolution.

getBackground

public Color getBackground()

Returns the background color override.

Returns:

A color, or null for the default, possibly Swing Look&Feel dependent, background color.

Since:

JViews 8.1

setBackground

public void setBackground(Color bgColor)

Sets the background color override. If specified as a non-null value, it overrides the default background color. If specified as null, the default (possibly Swing Look&Feel dependent) background color is used.

Since:

JViews 8.1

getFlow

public IlvFlow getFlow()

Overwrite the method to disable the usage of the flow in this type of document. The method always throw an IllegalArgumentException.

Overrides:

getFlow in class IlvPrintableDocument

See Also:

IlvPrintableDocument.isFlowLayoutValid(), IlvPrintableDocument.invalidateFlowLayout()

createPages

protected IlvPage[] createPages()

Creates the pages and populates this document.

Overrides:

createPages in class IlvPrintableDocument

createPrintableChart

protected IlvPrintableChart createPrintableChart(IlvPage page,
                                                 int pageIdx,
                                                 IlvUnit.Rectangle pageArea)

Returns a new IlvPrintableChart instance to print the document chart in the specified page. The default implementation first creates an IlvDefaultChartPrintContext initialized with the data window returned by computeDataWindow(int, int). Then it returns an IlvPrintableChart instance initialized with this context.

Parameters:

page - The current printed page.

pageIdx - The page index in the document.

pageArea - The destination printable area (in paper coordinates).

Returns:

The IlvPrintableChart.

computeDataWindow

protected IlvDataWindow computeDataWindow(int pageIdx,
                                          int coordSysIdx)

Returns the data window to print in the specified page for the specified coordinate system. The default implementation returns a data window with the x-range computed according to the printed data window and the number of pages, and the y-range equals to the printed data window y-range.

Parameters:

pageIdx - The page index.

coordSysIdx - The coordinate system index.

Returns:

The data window for the specified page.

See Also:

setDataWindow(ilog.views.chart.IlvDataWindow)