PDFGraphics2D (FreeHEP Vector Graphics 2.2.2-SNAPSHOT API)

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: freehep-graphicsio-pdf/src/main/java/org/freehep/graphicsio/pdf/PDFGraphics2D.java 59372df5e0d9 2007/02/06 21:11:19 duns $

Author:

Simon Fischer, Mark Donszelmann

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTHOR`
`static String`	`BACKGROUND`
`static String`	`BACKGROUND_COLOR`
`static String`	`COMPRESS`
`static String`	`EMBED_FONTS`
`static String`	`EMBED_FONTS_AS`
`static String`	`FIT_TO_PAGE`
`static String`	`KEYWORDS`
`static String`	`ORIENTATION`
`static String`	`PAGE_MARGINS`
`static String`	`PAGE_SIZE`
`static String`	`SUBJECT`
`static String`	`THUMBNAIL_SIZE`
`static String`	`THUMBNAILS`
`static String`	`TITLE`
`static String`	`TRANSPARENT`
`static String`	`version`
`static String`	`VERSION`
`static String`	`VERSION4`
`static String`	`VERSION5`
`static String`	`VERSION6`
`static 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

Constructors
Modifier	Constructor and Description
	`PDFGraphics2D(File file, Component component)`
	`PDFGraphics2D(File file, Dimension size)`
	`PDFGraphics2D(OutputStream ros, Component component)`
	`PDFGraphics2D(OutputStream ros, Dimension size)`
`protected`	`PDFGraphics2D(PDFGraphics2D graphics, boolean doRestoreOnDispose)` Cloneconstructor

Method Summary

Methods
Modifier and Type	Method and Description
`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)`
`Graphics`	`create()`
`Graphics`	`create(double x, double y, double width, double height)`
`void`	`draw(Shape s)`
`void`	`fill(Shape s)`
`static Properties`	`getDefaultProperties()`
`GraphicsConfiguration`	`getDeviceConfiguration()`
`boolean`	`isMultiPage()`
`void`	`openPage(Component component)` Start the next page
`void`	`openPage(Dimension size, String title)`
`static void`	`setClipEnabled(boolean enabled)` Set the clipping enabled flag.
`static void`	`setDefaultProperties(Properties newProperties)`
`void`	`setFooter(Font font, TagString left, TagString center, TagString right, int underlineThickness)` Set the footline of all pages.
`void`	`setHeader(Font font, TagString left, TagString center, TagString right, int underlineThickness)` Set the headline of all pages.
`void`	`setMultiPage(boolean multiPage)`
`protected void`	`setNonStrokeColor(Color c)`
`void`	`setPaintMode()`
`protected void`	`setStrokeColor(Color c)`
`void`	`setXORMode(Color c1)`
`void`	`showString(Font font, String str)`
`String`	`toString()`
`void`	`writeBackground()`
`protected void`	`writeCap(int cap)` Writes out the cap of the stroke.
`protected void`	`writeClip(Shape s)` Write out Shape clip.
`void`	`writeComment(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(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(RenderedImage image, AffineTransform xform, 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(Color c)` Writes out paint as the given color.
`protected void`	`writePaint(GradientPaint c)` Writes out paint as the given gradient.
`protected void`	`writePaint(Paint paint)` Writes out paint.
`protected void`	`writePaint(TexturePaint c)` Writes out paint as the given texture.
`protected void`	`writeSetClip(Shape s)` Write out Shape clip.
`protected void`	`writeString(String str, double x, double y)`
`void`	`writeTrailer()` Called to write the trailing part of the output.
`protected void`	`writeTransform(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 String VERSION6
```
    See Also:
    Constant Field Values
  - VERSION5
```
public static final String VERSION5
```
    See Also:
    Constant Field Values
  - VERSION4
```
public static final String VERSION4
```
    See Also:
    Constant Field Values
  - TRANSPARENT
```
public static final String TRANSPARENT
```
  - BACKGROUND
```
public static final String BACKGROUND
```
  - BACKGROUND_COLOR
```
public static final String BACKGROUND_COLOR
```
  - PAGE_SIZE
```
public static final String PAGE_SIZE
```
  - PAGE_MARGINS
```
public static final String PAGE_MARGINS
```
  - ORIENTATION
```
public static final String ORIENTATION
```
  - FIT_TO_PAGE
```
public static final String FIT_TO_PAGE
```
  - EMBED_FONTS
```
public static final String EMBED_FONTS
```
  - EMBED_FONTS_AS
```
public static final String EMBED_FONTS_AS
```
  - THUMBNAILS
```
public static final String THUMBNAILS
```
  - THUMBNAIL_SIZE
```
public static final String THUMBNAIL_SIZE
```
  - COMPRESS
```
public static final String COMPRESS
```
  - VERSION
```
public static final String VERSION
```
  - WRITE_IMAGES_AS
```
public static final String WRITE_IMAGES_AS
```
  - AUTHOR
```
public static final String AUTHOR
```
  - TITLE
```
public static final String TITLE
```
  - SUBJECT
```
public static final String SUBJECT
```
  - KEYWORDS
```
public static final String KEYWORDS
```
  - version
```
public static final String version
```
    See Also:
    Constant Field Values
- Constructor Detail
  - PDFGraphics2D
```
public PDFGraphics2D(File file,
             Dimension size)
              throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - PDFGraphics2D
```
public PDFGraphics2D(File file,
             Component component)
              throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - PDFGraphics2D
```
public PDFGraphics2D(OutputStream ros,
             Dimension size)
```
  - PDFGraphics2D
```
public PDFGraphics2D(OutputStream ros,
             Component component)
```
  - PDFGraphics2D
```
protected PDFGraphics2D(PDFGraphics2D graphics,
             boolean doRestoreOnDispose)
```
    Cloneconstructor
- Method Detail
  - getDefaultProperties
```
public static Properties getDefaultProperties()
```
  - setDefaultProperties
```
public static void setDefaultProperties(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 IOException
```
    Writes the catalog, docinfo, preferences, and (as we use only single page output the page tree.
    
    Specified by:
    
    writeHeader in class AbstractVectorGraphicsIO
    
    Throws:
    
    IOException
  - writeBackground
```
public void writeBackground()
```
    Specified by:
    
    writeBackground in class AbstractVectorGraphicsIO
  - writeTrailer
```
public void writeTrailer()
                  throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Called to write the trailing part of the output.
    
    Specified by:
    
    writeTrailer in class AbstractVectorGraphicsIO
    
    Throws:
    
    IOException
  - closeStream
```
public void closeStream()
                 throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Called to close the stream you are writing to.
    
    Specified by:
    
    closeStream in class AbstractVectorGraphicsIO
    
    Throws:
    
    IOException
  - openPage
```
public void openPage(Component component)
              throws IOException
```
    Description copied from interface: MultiPageDocument
    
    Start the next page
    
    Specified by:
    
    openPage in interface MultiPageDocument
    
    Throws:
    
    IOException
  - openPage
```
public void openPage(Dimension size,
            String title)
              throws IOException
```
    Specified by:
    
    openPage in interface MultiPageDocument
    
    Throws:
    
    IOException
  - closePage
```
public void closePage()
               throws IOException
```
    Description copied from interface: MultiPageDocument
    
    End the current page.
    
    Specified by:
    
    closePage in interface MultiPageDocument
    
    Throws:
    
    IOException
  - setHeader
```
public void setHeader(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(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 Graphics create()
```
    Specified by:
    
    create in class VectorGraphics
  - create
```
public Graphics create(double x,
              double y,
              double width,
              double height)
```
    Specified by:
    
    create in class VectorGraphics
  - writeGraphicsSave
```
protected void writeGraphicsSave()
                          throws 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:
    
    IOException
  - writeGraphicsRestore
```
protected void writeGraphicsRestore()
                             throws 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:
    
    IOException
  - draw
```
public void draw(Shape s)
```
    Specified by:
    
    draw in class VectorGraphics
  - fill
```
public void fill(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(RenderedImage image,
              AffineTransform xform,
              Color bkg)
                   throws IOException
```
    Specified by:
    
    writeImage in class AbstractVectorGraphicsIO
    
    Throws:
    
    IOException
  - writeString
```
protected void writeString(String str,
               double x,
               double y)
                    throws IOException
```
    Specified by:
    
    writeString in class AbstractVectorGraphicsIO
    
    Throws:
    
    IOException
  - writeTransform
```
protected void writeTransform(AffineTransform t)
                       throws IOException
```
    Write the given transformation matrix to the file.
    
    Specified by:
    
    writeTransform in class AbstractVectorGraphicsIO
    
    Parameters:
    t - to be written
    
    Throws:
    
    IOException
  - writeSetClip
```
protected void writeSetClip(Shape s)
                     throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Write out Shape clip.
    
    Specified by:
    
    writeSetClip in class AbstractVectorGraphicsIO
    
    Parameters:
    s - to be used for clipping
    
    Throws:
    
    IOException
  - writeClip
```
protected void writeClip(Shape s)
                  throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Write out Shape clip.
    
    Specified by:
    
    writeClip in class AbstractVectorGraphicsIO
    
    Parameters:
    s - to be used for clipping
    
    Throws:
    
    IOException
  - writeWidth
```
protected void writeWidth(float width)
                   throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Writes out the width of the stroke.
    
    Overrides:
    
    writeWidth in class AbstractVectorGraphicsIO
    
    Parameters:
    width - of the stroke
    
    Throws:
    
    IOException
  - writeCap
```
protected void writeCap(int cap)
                 throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Writes out the cap of the stroke.
    
    Overrides:
    
    writeCap in class AbstractVectorGraphicsIO
    
    Parameters:
    cap - of the stroke
    
    Throws:
    
    IOException
  - writeJoin
```
protected void writeJoin(int join)
                  throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Writes out the join of the stroke.
    
    Overrides:
    
    writeJoin in class AbstractVectorGraphicsIO
    
    Parameters:
    join - of the stroke
    
    Throws:
    
    IOException
  - writeMiterLimit
```
protected void writeMiterLimit(float limit)
                        throws 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:
    
    IOException
  - writeDash
```
protected void writeDash(float[] dash,
             float phase)
                  throws 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:
    
    IOException
  - setPaintMode
```
public void setPaintMode()
```
    Specified by:
    
    setPaintMode in class VectorGraphics
  - setXORMode
```
public void setXORMode(Color c1)
```
    Specified by:
    
    setXORMode in class VectorGraphics
  - writePaint
```
protected void writePaint(Color c)
                   throws 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:
    
    IOException
  - writePaint
```
protected void writePaint(GradientPaint c)
                   throws 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:
    
    IOException
  - writePaint
```
protected void writePaint(TexturePaint c)
                   throws 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:
    
    IOException
  - writePaint
```
protected void writePaint(Paint paint)
                   throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Writes out paint.
    
    Specified by:
    
    writePaint in class AbstractVectorGraphicsIO
    
    Parameters:
    paint - to be written
    
    Throws:
    
    IOException
  - setNonStrokeColor
```
protected void setNonStrokeColor(Color c)
                          throws IOException
```
    Throws:
    
    IOException
  - setStrokeColor
```
protected void setStrokeColor(Color c)
                       throws IOException
```
    Throws:
    
    IOException
  - writeFont
```
protected void writeFont(Font font)
                  throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Writes the font
    
    Specified by:
    
    writeFont in class AbstractVectorGraphicsIO
    
    Parameters:
    font - to be written
    
    Throws:
    
    IOException
  - getDeviceConfiguration
```
public GraphicsConfiguration getDeviceConfiguration()
```
    Specified by:
    
    getDeviceConfiguration in class VectorGraphics
  - writeComment
```
public void writeComment(String comment)
                  throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Called to Write out a comment.
    
    Specified by:
    
    writeComment in class AbstractVectorGraphicsIO
    
    Parameters:
    comment - to be written
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class VectorGraphics
  - showString
```
public void showString(Font font,
              String str)
                throws IOException
```
    Specified by:
    
    showString in interface FontUtilities.ShowString
    
    Throws:
    
    IOException

Class PDFGraphics2D

Field Summary

Fields inherited from class org.freehep.graphicsio.AbstractVectorGraphicsIO

Fields inherited from interface org.freehep.graphics2d.VectorGraphicsConstants

Constructor Summary

Method Summary

Methods inherited from class org.freehep.graphicsio.AbstractVectorGraphicsIO

Methods inherited from class org.freehep.graphicsio.VectorGraphicsIO

Methods inherited from class org.freehep.graphics2d.AbstractVectorGraphics

Methods inherited from class org.freehep.graphics2d.VectorGraphics

Methods inherited from class java.awt.Graphics2D

Methods inherited from class java.awt.Graphics

Methods inherited from class java.lang.Object

Field Detail

VERSION6

VERSION5

VERSION4

TRANSPARENT

BACKGROUND

BACKGROUND_COLOR

PAGE_SIZE

PAGE_MARGINS

ORIENTATION

FIT_TO_PAGE

EMBED_FONTS

EMBED_FONTS_AS

THUMBNAILS

THUMBNAIL_SIZE

COMPRESS

VERSION

WRITE_IMAGES_AS

AUTHOR

TITLE

SUBJECT

KEYWORDS

version

Constructor Detail

PDFGraphics2D

PDFGraphics2D

PDFGraphics2D

PDFGraphics2D

PDFGraphics2D

Method Detail

getDefaultProperties

setDefaultProperties

setMultiPage

isMultiPage

setClipEnabled

writeHeader

writeBackground

writeTrailer

closeStream

openPage

openPage

closePage

setHeader

setFooter

create

create

writeGraphicsSave

writeGraphicsRestore

draw

fill

copyArea

writeImage

writeString

writeTransform

writeSetClip

writeClip

writeWidth

writeCap

writeJoin

writeMiterLimit

writeDash

setPaintMode

setXORMode

writePaint

writePaint

writePaint

writePaint