org.freehep.graphicsio.pdf
Class PDFGraphics2D

java.lang.Object
  java.awt.Graphics
      java.awt.Graphics2D
          org.freehep.graphics2d.VectorGraphics
              org.freehep.graphics2d.AbstractVectorGraphics
                  org.freehep.graphicsio.VectorGraphicsIO
                      org.freehep.graphicsio.AbstractVectorGraphicsIO
                          org.freehep.graphicsio.pdf.PDFGraphics2D

All Implemented Interfaces:

FontUtilities.ShowString, VectorGraphicsConstants, MultiPageDocument

public class PDFGraphics2D
extends AbstractVectorGraphicsIO
implements MultiPageDocument, FontUtilities.ShowString

Implementation of VectorGraphics that writes the output to a PDF file. Users of this class have to generate a PDFWriter and create an instance by invoking the factory method or the constructor. Document specific settings like page size can then be made by the appropriate setter methods. Before starting to draw, startExport() must be called. When drawing is finished, call endExport().

Version:

$Id: PDFGraphics2D.java 10516 2007-02-06 21:11:19Z duns $

Author:

Simon Fischer, Mark Donszelmann

Field Summary

static java.lang.String	AUTHOR
static java.lang.String	BACKGROUND
static java.lang.String	BACKGROUND_COLOR
static java.lang.String	COMPRESS
static java.lang.String	EMBED_FONTS
static java.lang.String	EMBED_FONTS_AS
static java.lang.String	FIT_TO_PAGE
static java.lang.String	KEYWORDS
static java.lang.String	ORIENTATION
static java.lang.String	PAGE_MARGINS
static java.lang.String	PAGE_SIZE
static java.lang.String	SUBJECT
static java.lang.String	THUMBNAIL_SIZE
static java.lang.String	THUMBNAILS
static java.lang.String	TITLE
static java.lang.String	TRANSPARENT
static java.lang.String	version
static java.lang.String	VERSION
static java.lang.String	VERSION4
static java.lang.String	VERSION5
static java.lang.String	VERSION6
static java.lang.String	WRITE_IMAGES_AS

Fields inherited from class org.freehep.graphicsio.AbstractVectorGraphicsIO

CLIP, EMIT_ERRORS, EMIT_WARNINGS, TEXT_AS_SHAPES

Fields inherited from interface org.freehep.graphics2d.VectorGraphicsConstants

NUMBER_OF_HORIZ_ALIGNMENTS, NUMBER_OF_SYMBOLS, NUMBER_OF_VERTICAL_ALIGNMENTS, SYMBOL_BOX, SYMBOL_CIRCLE, SYMBOL_CROSS, SYMBOL_DIAMOND, SYMBOL_DN_TRIANGLE, SYMBOL_HLINE, SYMBOL_PLUS, SYMBOL_STAR, SYMBOL_UP_TRIANGLE, SYMBOL_VLINE, TEXT_BASELINE, TEXT_BOTTOM, TEXT_CENTER, TEXT_LEFT, TEXT_RIGHT, TEXT_TOP

Constructor Summary

	PDFGraphics2D(java.io.File file, java.awt.Component component)
	PDFGraphics2D(java.io.File file, java.awt.Dimension size)
	PDFGraphics2D(java.io.OutputStream ros, java.awt.Component component)
	PDFGraphics2D(java.io.OutputStream ros, java.awt.Dimension size)
protected	PDFGraphics2D(PDFGraphics2D graphics, boolean doRestoreOnDispose) Cloneconstructor

Method Summary

void	closePage() End the current page.
void	closeStream() Called to close the stream you are writing to.
void	copyArea(int x, int y, int width, int height, int dx, int dy)
java.awt.Graphics	create()
java.awt.Graphics	create(double x, double y, double width, double height)
void	draw(java.awt.Shape s)
void	fill(java.awt.Shape s)
static java.util.Properties	getDefaultProperties()
java.awt.GraphicsConfiguration	getDeviceConfiguration()
boolean	isMultiPage()
void	openPage(java.awt.Component component) Start the next page
void	openPage(java.awt.Dimension size, java.lang.String title)
static void	setClipEnabled(boolean enabled) Set the clipping enabled flag.
static void	setDefaultProperties(java.util.Properties newProperties)
void	setFooter(java.awt.Font font, TagString left, TagString center, TagString right, int underlineThickness) Set the footline of all pages.
void	setHeader(java.awt.Font font, TagString left, TagString center, TagString right, int underlineThickness) Set the headline of all pages.
void	setMultiPage(boolean multiPage)
protected void	setNonStrokeColor(java.awt.Color c)
void	setPaintMode()
protected void	setStrokeColor(java.awt.Color c)
void	setXORMode(java.awt.Color c1)
void	showString(java.awt.Font font, java.lang.String str)
java.lang.String	toString()
void	writeBackground()
protected void	writeCap(int cap) Writes out the cap of the stroke.
protected void	writeClip(java.awt.Shape s) Write out Shape clip.
void	writeComment(java.lang.String comment) Called to Write out a comment.
protected void	writeDash(float[] dash, float phase) Writes out the dash of the stroke.
protected void	writeFont(java.awt.Font font) Writes the font
protected void	writeGraphicsRestore() Writes out the restore of a graphics context.
protected void	writeGraphicsSave() Writes out the save of a graphics context for a later restore.
void	writeHeader() Writes the catalog, docinfo, preferences, and (as we use only single page output the page tree.
protected void	writeImage(java.awt.image.RenderedImage image, java.awt.geom.AffineTransform xform, java.awt.Color bkg)
protected void	writeJoin(int join) Writes out the join of the stroke.
protected void	writeMiterLimit(float limit) Writes out the miter limit of the stroke.
protected void	writePaint(java.awt.Color c) Writes out paint as the given color.
protected void	writePaint(java.awt.GradientPaint c) Writes out paint as the given gradient.
protected void	writePaint(java.awt.Paint paint) Writes out paint.
protected void	writePaint(java.awt.TexturePaint c) Writes out paint as the given texture.
protected void	writeSetClip(java.awt.Shape s) Write out Shape clip.
protected void	writeString(java.lang.String str, double x, double y)
void	writeTrailer() Called to write the trailing part of the output.
protected void	writeTransform(java.awt.geom.AffineTransform t) Write the given transformation matrix to the file.
protected void	writeWidth(float width) Writes out the width of the stroke.

Methods inherited from class org.freehep.graphicsio.AbstractVectorGraphicsIO

addRenderingHints, clearRect, clip, clipRect, clipRect, createShape, dispose, drawGlyphVector, drawImage, drawImage, drawImage, drawImage, drawImage, drawImage, drawImage, drawImage, drawRenderableImage, drawRenderedImage, drawString, drawString, endExport, getClip, getClipBounds, getClipBounds, getComponent, getComposite, getFontMetrics, getFontRenderContext, getRenderingHint, getRenderingHints, getSize, getStroke, getTransform, handleException, overLine, printComment, resetClip, rotate, scale, setClip, setClip, setClip, setColor, setComposite, setFont, setPaint, setRenderingHint, setRenderingHints, setStroke, setTransform, shear, startExport, transform, translate, writeDash, writeError, writeGraphicsState, writeSetTransform, writeStroke, writeWarning, writeWarning

Methods inherited from class org.freehep.graphicsio.VectorGraphicsIO

copyResourceTo, copyResourceTo

Methods inherited from class org.freehep.graphics2d.AbstractVectorGraphics

clearRect, createShape, drawArc, drawArc, drawLine, drawLine, drawOval, drawOval, drawPolygon, drawPolygon, drawPolyline, drawPolyline, drawRect, drawRect, drawRoundRect, drawRoundRect, drawString, drawString, drawString, drawString, drawString, drawString, drawString, drawString, drawSymbol, drawSymbol, drawSymbol, fillAndDraw, fillAndDrawSymbol, fillAndDrawSymbol, fillArc, fillArc, fillOval, fillOval, fillPolygon, fillPolygon, fillRect, fillRect, fillRoundRect, fillRoundRect, fillSymbol, fillSymbol, fillSymbol, getBackground, getColor, getColorMode, getCreator, getFont, getPaint, getPrintColor, getProperties, getProperty, getPropertyColor, getPropertyDimension, getPropertyDouble, getPropertyInsets, getPropertyInt, getPropertyRectangle, hit, initProperties, isDeviceIndependent, isProperty, rotate, setBackground, setColorMode, setCreator, setDeviceIndependent, setLineWidth, setLineWidth, setProperties, translate

Methods inherited from class org.freehep.graphics2d.VectorGraphics

create, create, fill, getSymbol, getTextAlignment, getXalignment, getYalignment

Methods inherited from class java.awt.Graphics2D

draw3DRect, fill3DRect

Methods inherited from class java.awt.Graphics

drawBytes, drawChars, drawPolygon, fillPolygon, finalize, getClipRect, getFontMetrics, hitClip

Methods inherited from class java.lang.Object

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

Field Detail

VERSION6

public static final java.lang.String VERSION6

See Also:

Constant Field Values

VERSION5

public static final java.lang.String VERSION5

See Also:

Constant Field Values

VERSION4

public static final java.lang.String VERSION4

See Also:

Constant Field Values

TRANSPARENT

public static final java.lang.String TRANSPARENT

BACKGROUND

public static final java.lang.String BACKGROUND

BACKGROUND_COLOR

public static final java.lang.String BACKGROUND_COLOR

PAGE_SIZE

public static final java.lang.String PAGE_SIZE

PAGE_MARGINS

public static final java.lang.String PAGE_MARGINS

ORIENTATION

public static final java.lang.String ORIENTATION

FIT_TO_PAGE

public static final java.lang.String FIT_TO_PAGE

EMBED_FONTS

public static final java.lang.String EMBED_FONTS

EMBED_FONTS_AS

public static final java.lang.String EMBED_FONTS_AS

THUMBNAILS

public static final java.lang.String THUMBNAILS

THUMBNAIL_SIZE

public static final java.lang.String THUMBNAIL_SIZE

COMPRESS

public static final java.lang.String COMPRESS

VERSION

public static final java.lang.String VERSION

WRITE_IMAGES_AS

public static final java.lang.String WRITE_IMAGES_AS

AUTHOR

public static final java.lang.String AUTHOR

TITLE

public static final java.lang.String TITLE

SUBJECT

public static final java.lang.String SUBJECT

KEYWORDS

public static final java.lang.String KEYWORDS

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

PDFGraphics2D

public PDFGraphics2D(java.io.File file,
                     java.awt.Dimension size)
              throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

PDFGraphics2D

public PDFGraphics2D(java.io.File file,
                     java.awt.Component component)
              throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

PDFGraphics2D

public PDFGraphics2D(java.io.OutputStream ros,
                     java.awt.Dimension size)

PDFGraphics2D

public PDFGraphics2D(java.io.OutputStream ros,
                     java.awt.Component component)

PDFGraphics2D

protected PDFGraphics2D(PDFGraphics2D graphics,
                        boolean doRestoreOnDispose)

Cloneconstructor

Method Detail

getDefaultProperties

public static java.util.Properties getDefaultProperties()

setDefaultProperties

public static void setDefaultProperties(java.util.Properties newProperties)

setMultiPage

public void setMultiPage(boolean multiPage)

Specified by:

setMultiPage in interface MultiPageDocument

isMultiPage

public boolean isMultiPage()

Specified by:

isMultiPage in interface MultiPageDocument

setClipEnabled

public static void setClipEnabled(boolean enabled)

Set the clipping enabled flag. This will affect all output operations after this call completes. In some circumstances the clipping region is set incorrectly (not yet understood; AWT seems to not correctly dispose of graphic contexts). A workaround is to simply switch it off.

writeHeader

public void writeHeader()
                 throws java.io.IOException

Writes the catalog, docinfo, preferences, and (as we use only single page output the page tree.

Specified by:

writeHeader in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

writeBackground

public void writeBackground()

Specified by:

writeBackground in class AbstractVectorGraphicsIO

writeTrailer

public void writeTrailer()
                  throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Called to write the trailing part of the output.

Specified by:

writeTrailer in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

closeStream

public void closeStream()
                 throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Called to close the stream you are writing to.

Specified by:

closeStream in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

openPage

public void openPage(java.awt.Component component)
              throws java.io.IOException

Description copied from interface: MultiPageDocument

Start the next page

Specified by:

openPage in interface MultiPageDocument

Throws:

java.io.IOException

openPage

public void openPage(java.awt.Dimension size,
                     java.lang.String title)
              throws java.io.IOException

Specified by:

openPage in interface MultiPageDocument

Throws:

java.io.IOException

closePage

public void closePage()
               throws java.io.IOException

Description copied from interface: MultiPageDocument

End the current page.

Specified by:

closePage in interface MultiPageDocument

Throws:

java.io.IOException

setHeader

public void setHeader(java.awt.Font font,
                      TagString left,
                      TagString center,
                      TagString right,
                      int underlineThickness)

Description copied from interface: MultiPageDocument

Set the headline of all pages.

Specified by:

setHeader in interface MultiPageDocument

setFooter

public void setFooter(java.awt.Font font,
                      TagString left,
                      TagString center,
                      TagString right,
                      int underlineThickness)

Description copied from interface: MultiPageDocument

Set the footline of all pages.

Specified by:

setFooter in interface MultiPageDocument

create

public java.awt.Graphics create()

Specified by:

create in class VectorGraphics

create

public java.awt.Graphics create(double x,
                                double y,
                                double width,
                                double height)

Specified by:

create in class VectorGraphics

writeGraphicsSave

protected void writeGraphicsSave()
                          throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out the save of a graphics context for a later restore. Some implementations keep track of this by hand if the output format does not support it.

Specified by:

writeGraphicsSave in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

writeGraphicsRestore

protected void writeGraphicsRestore()
                             throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out the restore of a graphics context. Some implementations keep track of this by hand if the output format does not support it.

Specified by:

writeGraphicsRestore in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

draw

public void draw(java.awt.Shape s)

Specified by:

draw in class VectorGraphics

fill

public void fill(java.awt.Shape s)

Specified by:

fill in class VectorGraphics

copyArea

public void copyArea(int x,
                     int y,
                     int width,
                     int height,
                     int dx,
                     int dy)

Specified by:

copyArea in class VectorGraphics

writeImage

protected void writeImage(java.awt.image.RenderedImage image,
                          java.awt.geom.AffineTransform xform,
                          java.awt.Color bkg)
                   throws java.io.IOException

Specified by:

writeImage in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

writeString

protected void writeString(java.lang.String str,
                           double x,
                           double y)
                    throws java.io.IOException

Specified by:

writeString in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

writeTransform

protected void writeTransform(java.awt.geom.AffineTransform t)
                       throws java.io.IOException

Write the given transformation matrix to the file.

Specified by:

writeTransform in class AbstractVectorGraphicsIO

Parameters:

t - to be written

Throws:

java.io.IOException

writeSetClip

protected void writeSetClip(java.awt.Shape s)
                     throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Write out Shape clip.

Specified by:

writeSetClip in class AbstractVectorGraphicsIO

Parameters:

s - to be used for clipping

Throws:

java.io.IOException

writeClip

protected void writeClip(java.awt.Shape s)
                  throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Write out Shape clip.

Specified by:

writeClip in class AbstractVectorGraphicsIO

Parameters:

s - to be used for clipping

Throws:

java.io.IOException

writeWidth

protected void writeWidth(float width)
                   throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out the width of the stroke.

Overrides:

writeWidth in class AbstractVectorGraphicsIO

Parameters:

width - of the stroke

Throws:

java.io.IOException

writeCap

protected void writeCap(int cap)
                 throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out the cap of the stroke.

Overrides:

writeCap in class AbstractVectorGraphicsIO

Parameters:

cap - of the stroke

Throws:

java.io.IOException

writeJoin

protected void writeJoin(int join)
                  throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out the join of the stroke.

Overrides:

writeJoin in class AbstractVectorGraphicsIO

Parameters:

join - of the stroke

Throws:

java.io.IOException

writeMiterLimit

protected void writeMiterLimit(float limit)
                        throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out the miter limit of the stroke.

Overrides:

writeMiterLimit in class AbstractVectorGraphicsIO

Parameters:

limit - miter limit of the stroke

Throws:

java.io.IOException

writeDash

protected void writeDash(float[] dash,
                         float phase)
                  throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out the dash of the stroke.

Overrides:

writeDash in class AbstractVectorGraphicsIO

Parameters:

dash - dash pattern, empty array is solid line

phase - of the dash pattern

Throws:

java.io.IOException

setPaintMode

public void setPaintMode()

Specified by:

setPaintMode in class VectorGraphics

setXORMode

public void setXORMode(java.awt.Color c1)

Specified by:

setXORMode in class VectorGraphics

writePaint

protected void writePaint(java.awt.Color c)
                   throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out paint as the given color.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

c - to be written

Throws:

java.io.IOException

writePaint

protected void writePaint(java.awt.GradientPaint c)
                   throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out paint as the given gradient.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

c - to be written

Throws:

java.io.IOException

writePaint

protected void writePaint(java.awt.TexturePaint c)
                   throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out paint as the given texture.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

c - to be written

Throws:

java.io.IOException

writePaint

protected void writePaint(java.awt.Paint paint)
                   throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out paint.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

paint - to be written

Throws:

java.io.IOException

setNonStrokeColor

protected void setNonStrokeColor(java.awt.Color c)
                          throws java.io.IOException

Throws:

java.io.IOException

setStrokeColor

protected void setStrokeColor(java.awt.Color c)
                       throws java.io.IOException

Throws:

java.io.IOException

writeFont

protected void writeFont(java.awt.Font font)
                  throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes the font

Specified by:

writeFont in class AbstractVectorGraphicsIO

Parameters:

font - to be written

Throws:

java.io.IOException

getDeviceConfiguration

public java.awt.GraphicsConfiguration getDeviceConfiguration()

Specified by:

getDeviceConfiguration in class VectorGraphics

writeComment

public void writeComment(java.lang.String comment)
                  throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Called to Write out a comment.

Specified by:

writeComment in class AbstractVectorGraphicsIO

Parameters:

comment - to be written

Throws:

java.io.IOException

toString

public java.lang.String toString()

Specified by:

toString in class VectorGraphics

showString

public void showString(java.awt.Font font,
                       java.lang.String str)
                throws java.io.IOException

Specified by:

showString in interface FontUtilities.ShowString

Throws:

java.io.IOException