ilog.views.chart

Class IlvChartPrintContext

java.lang.Object

ilog.views.chart.IlvChartPrintContext

Direct Known Subclasses:

IlvDefaultChartPrintContext

public abstract class IlvChartPrintContext
extends Object

A class to handle printing configurations. This class is used by the IlvChartPrintableDocument to define and handle the printing of a portion of a chart within a page.

Since:

JViews 5.5

See Also:

IlvChartPrintableDocument.createPages(), IlvPrintableChart

Constructor Summary

Constructors

Constructor and Description
IlvChartPrintContext(IlvUnit.Rectangle printArea, IlvChartPrintableDocument document, IlvPage page) Creates a new PrintContext object.

Method Summary

Modifier and Type	Method and Description
Color	getBackground() Returns the background color to use, instead of the default background color.
IlvChart	getChart() Returns the chart to be printed.
IlvChartPrintableDocument	getDocument() Returns the document.
Rectangle	getDrawRect() Returns the printing chart area draw rect in paper coordinate.
IlvPage	getPage() Returns the page.
IlvUnit.Rectangle	getPrintArea() Returns the print area.
abstract IlvDataInterval	getRange(int axisIdx) Returns the printing range for the specified axis.
boolean	isTitleVisible(IlvScale scale) Returns whether the title of the specified scale should be printed on this page.
boolean	isVisible(IlvChartDrawable drawable) Returns whether the specified drawable object should be printed on this page.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvChartPrintContext

public IlvChartPrintContext(IlvUnit.Rectangle printArea,
                            IlvChartPrintableDocument document,
                            IlvPage page)
                     throws IllegalArgumentException

Creates a new PrintContext object.

Parameters:

printArea - The destination printing area.

document - The document handling this page.

page - The page to be printed. Note that the page may have not been added to a document yet.

Throws:

IllegalArgumentException - The corresponding transforms cannot be computed.

Method Detail

getDocument

public final IlvChartPrintableDocument getDocument()

Returns the document.

getPage

public final IlvPage getPage()

Returns the page.

getChart

public final IlvChart getChart()

Returns the chart to be printed.

getPrintArea

public final IlvUnit.Rectangle getPrintArea()

Returns the print area.

getRange

public abstract IlvDataInterval getRange(int axisIdx)

Returns the printing range for the specified axis. Subclass should override this method to return the range to print on this page for the specified axis.

getDrawRect

public Rectangle getDrawRect()

Returns the printing chart area draw rect in paper coordinate.

getBackground

public Color getBackground()

Returns the background color to use, instead of the default background color.

The default implementation uses the background color in the IlvChartPrintableDocument.

Returns:

An override for the background color, or null if the default (possibly Swing Look&Feel dependent) background color should be used.

Since:

JViews 8.1

isTitleVisible

public boolean isTitleVisible(IlvScale scale)

Returns whether the title of the specified scale should be printed on this page.

The default implementation uses the repeatTitle property of the IlvChartPrintableDocument.

isVisible

public boolean isVisible(IlvChartDrawable drawable)

Returns whether the specified drawable object should be printed on this page.

The default implementation uses the repeatYScales property of the IlvChartPrintableDocument.