com.luciad.view.lightspeed

LuciadLightspeedClass TLspViewPrintSettings

java.lang.Object

com.luciad.view.lightspeed.TLspViewPrintSettings

public class TLspViewPrintSettings
extends Object

Provides configuration parameters used for printing the contents of an ILspView. Print settings can be created using the supplied TLspViewPrintSettings.Builder.

Note that in most cases, the recommended way to print the contents of a view is using TLspViewComponentPrintable, which does not require the user to build a TLspViewPrintSettings object manually.

Since:

2013.0

See Also:

ALspAWTView.print(java.awt.Graphics2D, TLspViewPrintSettings), TLspViewComponentPrintable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLspViewPrintSettings.Builder Builder for TLspViewPrintSettings objects.

Method Summary

Modifier and Type	Method and Description
double	getFeatureScale() Returns the feature scale to use during printing.
Rectangle	getPrintBounds() Returns the bounds of the area into which the view is to be printed.
ILcdStatusListener	getStatusListener() Returns a status listener that will be notified of progress during a printing operations.
static TLspViewPrintSettings.Builder	newBuilder() Creates a new builder for print settings.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static TLspViewPrintSettings.Builder newBuilder()

Creates a new builder for print settings.

Returns:

a new builder

getPrintBounds

public Rectangle getPrintBounds()

Returns the bounds of the area into which the view is to be printed. The area is defined in pixel coordinates for the Graphics to which the printing will be done. Transformations on the Graphics do not need to be taken into account. If, for example, a print area of 1000x1000 pixels is specified for a Graphics which has been scaled by a factor 2, the resolution of the printed output will be 2000x2000 pixels.

If the aspect ratio of this area does not match the current aspect ratio of the view, the view will expand as needed to fill the print area. While doing so, it will ensure that at least the geographic area which was visible in the view on screen will also be visible in the print.

If no bounds are specified, the bounds of the view are used (i.e. [0, 0, width, height]).

Returns:

the print area bounds in pixels

getFeatureScale

public double getFeatureScale()

Returns the feature scale to use during printing. A factor of 1.0 (the default) means that all elements of the view are printed with the same proportions as they appear on screen. For instance, an icon or a label which spans 1/10th of the width of the view on screen will also span 1/10th of the width of the print. Using a lower value will make features in the view become proportionally smaller when printed, i.e. the print will appear "finer" in comparison.

Returns:

the feature scale to be applied during printing

getStatusListener

public ILcdStatusListener getStatusListener()

Returns a status listener that will be notified of progress during a printing operations. If the listener is null, no status events will be generated.

Returns:

a status listener for printing progress