com.partnersoft.maps.app

Class MapPrintLogic

java.lang.Object

com.partnersoft.maps.app.MapPrintLogic

public class MapPrintLogic
extends java.lang.Object

Controls the behavior of printing in a map app.

Copyright 2005-2010 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
MapPrintLogic(MapApp app)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	initialize()
void	plot(MapViewFrame frame, java.awt.Graphics2D g2d) Plots the given framed map area to the given graphics context.
void	plot(MapViewFrame frame, java.awt.Graphics2D g2d, boolean isMonochrome) Plots the given framed map area to the given graphics context.
void	plotToPdf(MapViewFrame frame, java.io.File pdfFile) Plots the given frame to a PDF file at a resolution of 144 dpi.
void	plotToPdf(MapViewFrame frame, java.io.OutputStream outputStream) Plots the given frame to a PDF file at a resolution of 144 dpi.
void	plotToPdf(MapViewFrame frame, java.io.OutputStream outputStream, boolean isMonochrome) Plots the given frame to a PDF file at a resolution of 144 dpi.
void	plotToPdf(MapViewFrame frame, VfsFile pdfFile) Plots the given frame to a PDF file at a resolution of 144 dpi.
void	plotToPdf(MapViewFrame frame, VfsFile pdfFile, boolean isMonochrome) Plots the given frame to a PDF file at a resolution of 144 dpi.
void	print() Deprecated. use quickPrint() instead
void	printWithData() Deprecated. use quickPrintWithData() instead
void	quickPdf()
void	quickPdfWithData()
void	quickPrint()
void	quickPrintWithData()
void	screenshot(java.io.File file)
void	screenshot(java.io.File file, double centerX, double centerY, double scale, int pixelWidth, int pixelHeight)
void	screenshot(java.io.File file, int pixelWidth, int pixelHeight)
void	screenshot(java.awt.Graphics2D g2d)
void	screenshot(java.awt.Graphics2D g2d, double centerX, double centerY, double rotation, double scale, int pixelWidth, int pixelHeight) Generates a screen shot in the passed graphics as described by the passed parameters.
void	screenshot(java.awt.Graphics2D g2d, double centerX, double centerY, double rotation, double scale, int pixelWidth, int pixelHeight, boolean isMonochrome) Generates a screen shot in the passed graphics as described by the passed parameters.
void	screenshot(java.awt.Graphics2D g2d, double centerX, double centerY, double scale, int pixelWidth, int pixelHeight)
void	screenshot(java.awt.Graphics2D g2d, int pixelWidth, int pixelHeight)
void	screenshot(java.io.OutputStream output, java.lang.String fileType, double centerX, double centerY, double scale, int pixelWidth, int pixelHeight)
void	screenshot(java.io.OutputStream output, java.lang.String fileType, double centerX, double centerY, double scale, int pixelWidth, int pixelHeight, boolean drawScaleAndNorthArrow)
com.lowagie.text.pdf.PdfTemplate	screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer) Same as the full screenShotAsTemplate(), centered on the current map view and with the same width and height as the map view.
com.lowagie.text.pdf.PdfTemplate	screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer, double centerX, double centerY, double rotation, double scale, int pixelWidth, int pixelHeight) Returns an iText PDFTemplate you can use to insert a map image into a PDF document.
com.lowagie.text.pdf.PdfTemplate	screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer, double centerX, double centerY, double rotation, double scale, int pixelWidth, int pixelHeight, boolean isMonochrome) Returns an iText PDFTemplate you can use to insert a map image into a PDF document.
com.lowagie.text.pdf.PdfTemplate	screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer, double centerX, double centerY, double scale, int pixelWidth, int pixelHeight) Returns an iText PDFTemplate you can use to insert a map image into a PDF document.
com.lowagie.text.pdf.PdfTemplate	screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer, int pixelWidth, int pixelHeight) Same as the full screenShotAsTemplate(), centered on the current map view, but with the given width and height.
com.lowagie.text.pdf.PdfTemplate	screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer, MapViewFrame frame) Returns an iText PDFTemplate you can use to insert a map image into a PDF document.
com.lowagie.text.pdf.PdfTemplate	screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer, MapViewFrame frame, boolean isMonochrome) Returns an iText PDFTemplate you can use to insert a map image into a PDF document.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapPrintLogic

public MapPrintLogic(MapApp app)

Method Detail

initialize

protected void initialize()

print

public void print()

Deprecated. use quickPrint() instead

printWithData

public void printWithData()

Deprecated. use quickPrintWithData() instead

quickPrint

public void quickPrint()

quickPrintWithData

public void quickPrintWithData()

quickPdf

public void quickPdf()

quickPdfWithData

public void quickPdfWithData()

screenshot

public void screenshot(java.io.File file)

screenshot

public void screenshot(java.io.File file,
              int pixelWidth,
              int pixelHeight)

screenshot

public void screenshot(java.io.File file,
              double centerX,
              double centerY,
              double scale,
              int pixelWidth,
              int pixelHeight)

screenshot

public void screenshot(java.io.OutputStream output,
              java.lang.String fileType,
              double centerX,
              double centerY,
              double scale,
              int pixelWidth,
              int pixelHeight)

screenshot

public void screenshot(java.io.OutputStream output,
              java.lang.String fileType,
              double centerX,
              double centerY,
              double scale,
              int pixelWidth,
              int pixelHeight,
              boolean drawScaleAndNorthArrow)

screenshotAsTemplate

public com.lowagie.text.pdf.PdfTemplate screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer)

Same as the full screenShotAsTemplate(), centered on the current map view and with the same width and height as the map view.

screenshotAsTemplate

public com.lowagie.text.pdf.PdfTemplate screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer,
                                                    int pixelWidth,
                                                    int pixelHeight)

Same as the full screenShotAsTemplate(), centered on the current map view, but with the given width and height.

screenshotAsTemplate

public com.lowagie.text.pdf.PdfTemplate screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer,
                                                    double centerX,
                                                    double centerY,
                                                    double scale,
                                                    int pixelWidth,
                                                    int pixelHeight)

Returns an iText PDFTemplate you can use to insert a map image into a PDF document. Specifies a centerpoint, scale, and size in pixels. The PDF version will have the rendered map at 144 pixels per inch, so if you want e.g. a 4" wide image use 144 * 4 as your pixelWidth.

screenshotAsTemplate

public com.lowagie.text.pdf.PdfTemplate screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer,
                                                    MapViewFrame frame)

Returns an iText PDFTemplate you can use to insert a map image into a PDF document. Specifies a centerpoint, rotation, scale, and size in pixels. The PDF version will have the rendered map at 144 pixels per inch, so if you want e.g. a 4" wide image use 144 * 4 as your pixelWidth.

Parameters:

writer - - PdfWriter to generate template with

frame - - MapViewFrame describing screenshot

Returns:

PdfTemplate containing screen shot

screenshotAsTemplate

public com.lowagie.text.pdf.PdfTemplate screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer,
                                                    MapViewFrame frame,
                                                    boolean isMonochrome)

Returns an iText PDFTemplate you can use to insert a map image into a PDF document. Specifies a centerpoint, rotation, scale, and size in pixels. The PDF version will have the rendered map at 144 pixels per inch, so if you want e.g. a 4" wide image use 144 * 4 as your pixelWidth.

Parameters:

writer - - PdfWriter to generate template with

frame - - MapViewFrame describing screenshot

isMonochrome - - true if TiledRoverSets should be drawn monochrome, false otherwise.

Returns:

PdfTemplate containing screen shot

screenshotAsTemplate

public com.lowagie.text.pdf.PdfTemplate screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer,
                                                    double centerX,
                                                    double centerY,
                                                    double rotation,
                                                    double scale,
                                                    int pixelWidth,
                                                    int pixelHeight,
                                                    boolean isMonochrome)

Returns an iText PDFTemplate you can use to insert a map image into a PDF document. Specifies a centerpoint, rotation, scale, and size in pixels. The PDF version will have the rendered map at 144 pixels per inch, so if you want e.g. a 4" wide image use 144 * 4 as your pixelWidth.

Parameters:

writer - - PdfWriter to write screen shot to

centerX - - X coordinate in map units for screen shot

centerY - - Y coordinate in map units for screen shot

rotation - - rotation for screen shot

scale - - Scale for screen shot

pixelWidth - - Width of screen shot in pixels

pixelHeight - - Height of screen shot in pixels

isMonochrome - - true if TiledRoverSets should be drawn monochrome, false otherwise.

Returns:

PdfTemplate containing screen shot

screenshotAsTemplate

public com.lowagie.text.pdf.PdfTemplate screenshotAsTemplate(com.lowagie.text.pdf.PdfWriter writer,
                                                    double centerX,
                                                    double centerY,
                                                    double rotation,
                                                    double scale,
                                                    int pixelWidth,
                                                    int pixelHeight)

Returns an iText PDFTemplate you can use to insert a map image into a PDF document. Specifies a centerpoint, rotation, scale, and size in pixels. The PDF version will have the rendered map at 144 pixels per inch, so if you want e.g. a 4" wide image use 144 * 4 as your pixelWidth.

Parameters:

writer - - PdfWriter to write screen shot to

centerX - - X coordinate in map units for screen shot

centerY - - Y coordinate in map units for screen shot

rotation - - rotation for screen shot

scale - - Scale for screen shot

pixelWidth - - Width of screen shot in pixels

pixelHeight - - Height of screen shot in pixels

Returns:

PdfTemplate containing screen shot

screenshot

public void screenshot(java.awt.Graphics2D g2d)

screenshot

public void screenshot(java.awt.Graphics2D g2d,
              int pixelWidth,
              int pixelHeight)

screenshot

public void screenshot(java.awt.Graphics2D g2d,
              double centerX,
              double centerY,
              double scale,
              int pixelWidth,
              int pixelHeight)

screenshot

public void screenshot(java.awt.Graphics2D g2d,
              double centerX,
              double centerY,
              double rotation,
              double scale,
              int pixelWidth,
              int pixelHeight)

Generates a screen shot in the passed graphics as described by the passed parameters.

Parameters:

g2d - - Graphics2D to plot screen shot on

centerX - - Center X coordinate in map units

centerY - - Center Y coordinate in map units

rotation - - MapViewFrame rotation

scale - - MapViewFrame scale

pixelWidth - - Width of screen shot in pixels

pixelHeight - - Height of screen shot in pixels

screenshot

public void screenshot(java.awt.Graphics2D g2d,
              double centerX,
              double centerY,
              double rotation,
              double scale,
              int pixelWidth,
              int pixelHeight,
              boolean isMonochrome)

Generates a screen shot in the passed graphics as described by the passed parameters.

Parameters:

g2d - - Graphics2D to plot screen shot on

centerX - - Center X coordinate in map units

centerY - - Center Y coordinate in map units

rotation - - MapViewFrame rotation

scale - - MapViewFrame scale

pixelWidth - - Width of screen shot in pixels

pixelHeight - - Height of screen shot in pixels

isMonochrome - - true if TiledRoverSets should be drawn monochrome, false otherwise.

plot

public void plot(MapViewFrame frame,
        java.awt.Graphics2D g2d)

Plots the given framed map area to the given graphics context.

Parameters:

frame - - area, rotation, and scale to plot

g2d - - context to plot to

plot

public void plot(MapViewFrame frame,
        java.awt.Graphics2D g2d,
        boolean isMonochrome)

Plots the given framed map area to the given graphics context.

Parameters:

frame - - area, rotation, and scale to plot

g2d - - context to plot to

isMonochrome - - true if TiledRoverSets should be drawn monochrome, false otherwise.

plotToPdf

public void plotToPdf(MapViewFrame frame,
             VfsFile pdfFile)
               throws java.lang.Exception

Plots the given frame to a PDF file at a resolution of 144 dpi.

Parameters:

frame - - MapViewFrame describing plot

pdfFile - - File to plot pdf into

Throws:

java.lang.Exception - if a problem occurs generating snapshot

plotToPdf

public void plotToPdf(MapViewFrame frame,
             VfsFile pdfFile,
             boolean isMonochrome)
               throws java.lang.Exception

Plots the given frame to a PDF file at a resolution of 144 dpi.

Parameters:

frame - - MapViewFrame to plot

pdfFile - - File to plot pdf into

isMonochrome - - true if TiledRoverSets should be drawn monochrome, false otherwise.

Throws:

java.lang.Exception - if a problem occurs generating snapshot

plotToPdf

public void plotToPdf(MapViewFrame frame,
             java.io.File pdfFile)
               throws java.lang.Exception

Plots the given frame to a PDF file at a resolution of 144 dpi.

Parameters:

frame - - MapViewFrame describing plot

pdfFile - - File to plot pdf into

Throws:

java.lang.Exception - if a problem occurs generating snapshot

plotToPdf

public void plotToPdf(MapViewFrame frame,
             java.io.OutputStream outputStream)
               throws java.lang.Exception

Plots the given frame to a PDF file at a resolution of 144 dpi.

Parameters:

frame - - MapViewFrame describing plot

outputStream - - stream to write to

Throws:

java.lang.Exception - if a problem occurs generating snapshot

plotToPdf

public void plotToPdf(MapViewFrame frame,
             java.io.OutputStream outputStream,
             boolean isMonochrome)
               throws java.lang.Exception

Plots the given frame to a PDF file at a resolution of 144 dpi.

Parameters:

frame - - MapViewFrame to plot

outputStream - - stream to write to

isMonochrome - - true if TiledRoverSets should be drawn monochrome, false otherwise.

Throws:

java.lang.Exception - if a problem occurs generating snapshot