ilog.views.print

Class IlvSimplePrintableManager

java.lang.Object

ilog.views.print.IlvSimplePrintableManager

All Implemented Interfaces:

IlvFlowObject

public class IlvSimplePrintableManager
extends Object
implements IlvFlowObject

An area of an IlvManager that can be printed in a flow of text.

Since:

JViews 5.5

See Also:

IlvFlow.add(IlvFlowObject,int)

Constructor Summary

Constructors

Constructor and Description
IlvSimplePrintableManager(IlvManagerView view, IlvUnit.Dimension size) Creates an IlvSimplePrintableManager.

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics g, double xx, double yy) Create the pages of this document.
IlvRect	getPrintArea() Returns the area of the manager that is printed.
IlvUnit.Dimension	getSize() Returns the size of the object.
IlvRect	getTotalManagerPrintArea() Returns the total area of the manager to be printed.
IlvManagerView	getView() Returns the manager view used when creating the document.
double	getZoomLevel() Returns the zoom level used when printing.
IlvTransformer	getZoomTransformer() Returns the zoom transformer used when printing.
boolean	isAutomaticZoomLevel() Returns true if the automatic zoom level calculation is enabled.
boolean	isPrintingAllManagerBBox() Returns true if the area to be printed is the total area of the manager.
void	setAutomaticZoomLevel(boolean enable) Sets whether the automatic zoom level calculation is enabled.
void	setPrintArea(IlvRect area) Changes the area of the manager that is printed.
void	setZoomLevel(double zl) Changes the zoom level used when printing.
void	setZoomTransformer(IlvTransformer t) Changes the zoom transformer that is used when printing.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSimplePrintableManager

public IlvSimplePrintableManager(IlvManagerView view,
                                 IlvUnit.Dimension size)

Creates an IlvSimplePrintableManager.

Parameters:

view - The manager view to print.

size - The dimension on the page.

Method Detail

getSize

public IlvUnit.Dimension getSize()

Returns the size of the object.

Specified by:

getSize in interface IlvFlowObject

getView

public IlvManagerView getView()

Returns the manager view used when creating the document.

isPrintingAllManagerBBox

public boolean isPrintingAllManagerBBox()

Returns true if the area to be printed is the total area of the manager.

getTotalManagerPrintArea

public IlvRect getTotalManagerPrintArea()

Returns the total area of the manager to be printed. The value returned is in manager's coordinate system.

Invisible layers and layers for which IlvManagerView.isContributingToViewBBox(int) returns false are not taken into account when calculating the area.

If the automatic zoom level calculation is enabled, the returned value may only be an approximation. In particular if the manager contains nonzoomable objects, it is recommended to disable the automatic zoom level calculation and to set the zoom transformer instead, so that the returned value is precise with respect to the given zoom transformer.

See Also:

setAutomaticZoomLevel(boolean), getZoomTransformer()

getZoomTransformer

public IlvTransformer getZoomTransformer()

Returns the zoom transformer used when printing. This zoom transformer is only used when automatic zoom level is disabled.

In the printout, the print area of the manager must be transformed to fit to the page area. However, the content of an IlvManager may change when displayed at different zoom level (for example when it contains nonzoomable objects). The zoom transformer is used to specify the zoom level when printing. Still, the print area is transformed to fit to the page area, but the zoom transformer decides how much of this transformation contributes to the nonzoomable objects.

If the method returns null, the zoom transformer of the input view is used instead. In this case, the proportions between zoomable and nonzoomable objects are in the printout exactly as in the view.

Since:

JViews 8.0

See Also:

setZoomTransformer(ilog.views.IlvTransformer), setZoomLevel(double), setAutomaticZoomLevel(boolean)

setZoomTransformer

public void setZoomTransformer(IlvTransformer t)

Changes the zoom transformer that is used when printing. This zoom transformer is only used when automatic zoom level is disabled.

In the printout, the print area of the manager must be transformed to fit to the page area. However, the content of an IlvManager may change when displayed at different zoom level (for example, when it contains nonzoomable objects). The zoom transformer is used to specify the zoom level when printing. Still, the print area is transformed to fit to the page area, but the zoom transformer decides how much of this transformation contributes to the nonzoomable objects. If the input zoom transformer is null, the zoom transformer of the input view is used instead. In this case, the proportions between zoomable and nonzoomable objects are in the printout exactly as in the view.

Changing the zoom transformer may affect the result of the printing but will not affect the number of pages or the area on a page that is printed.

Since:

JViews 8.0

See Also:

getZoomTransformer(), setZoomLevel(double), setAutomaticZoomLevel(boolean)

getZoomLevel

public double getZoomLevel()

Returns the zoom level used when printing. The zoom level is the zoom factor of the zoom transformer.

See Also:

setZoomTransformer(ilog.views.IlvTransformer)

setZoomLevel

public void setZoomLevel(double zl)

Changes the zoom level used when printing. This sets the zoom transformer to a transformation that scales in x and y direction by the same amount.

See Also:

setZoomTransformer(ilog.views.IlvTransformer)

isAutomaticZoomLevel

public boolean isAutomaticZoomLevel()

Returns true if the automatic zoom level calculation is enabled. It is enabled by default.

Since:

JViews 8.0

See Also:

setAutomaticZoomLevel(boolean), setZoomTransformer(ilog.views.IlvTransformer)

setAutomaticZoomLevel

public void setAutomaticZoomLevel(boolean enable)

Sets whether the automatic zoom level calculation is enabled. It is enabled by default.

In the printout, the print area of the manager must be transformed to fit to the page area. However, the content of an IlvManager may change when displayed at different zoom level (for example, when it contains nonzoomable objects). In order to adjust the printing, it is possible to set the zoom transformer (see setZoomTransformer(ilog.views.IlvTransformer)), which however has only an effect if the automatic zoom level calculation is disabled. If it is enabled, an internal zoom transformer is calculated automatically and the explicitly set zoom transformer is ignored.

Since:

JViews 8.0

See Also:

isAutomaticZoomLevel(), setZoomTransformer(ilog.views.IlvTransformer)

setPrintArea

public void setPrintArea(IlvRect area)

Changes the area of the manager that is printed.

Parameters:

area - The new area in manager's coordinate system. When area is null then the area to print will be the full area of the manager.

See Also:

getPrintArea()

getPrintArea

public IlvRect getPrintArea()

Returns the area of the manager that is printed. The area is returned in manager's coordinate

See Also:

setPrintArea(ilog.views.IlvRect)

draw

public void draw(Graphics g,
                 double xx,
                 double yy)

Create the pages of this document. This method takes into account the number of rows and columns, the page order, the printed area, the header and footer and is called every time one of this parameter changes.

Specified by:

draw in interface IlvFlowObject