org.freehep.graphicsio.ps

Class AbstractPSGraphics2D

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.ps.AbstractPSGraphics2D

All Implemented Interfaces:

FontUtilities.ShowString, VectorGraphicsConstants

Direct Known Subclasses:

EPSGraphics2D, PSGraphics2D

public abstract class AbstractPSGraphics2D
extends AbstractVectorGraphicsIO
implements FontUtilities.ShowString

Version:

$Id: freehep-graphicsio-ps/src/main/java/org/freehep/graphicsio/ps/AbstractPSGraphics2D.java bed5e3a39f35 2007/09/10 18:13:00 duns $

Author:

duns

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACKGROUND
static String	BACKGROUND_COLOR
static String	CUSTOM_PAGE_SIZE Property name (and value!) for setting a custom page size.
static String	EMBED_FONTS
static String	EMBED_FONTS_AS
static String	FIT_TO_PAGE
static String	FOR
static int	LEVEL_2
static int	LEVEL_3
static String	ORIENTATION
protected PrintStream	os
static String	PAGE_MARGINS Set this to an Insets object to set the page margins.
static String	PAGE_SIZE Property name for setting the size of the pages output by this AbstractPSGraphics2D.
static String	PREVIEW
static String	PREVIEW_BITS
protected OutputStream	ros
static String	TITLE
static String	version
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
protected	AbstractPSGraphics2D(AbstractPSGraphics2D graphics, boolean doRestoreOnDispose) This protected method is used by the create() methods to create a clone of the given graphics object.
	AbstractPSGraphics2D(Component component, boolean doRestoreOnDispose)
	AbstractPSGraphics2D(Dimension size, boolean doRestoreOnDispose)

Method Summary

Methods

Modifier and Type	Method and Description
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)
void	draw(Shape shape)
void	fill(Shape shape)
void	fillAndDraw(Shape shape, Color fillColor)
String	fixedPrecision(double d)
static Properties	getDefaultProperties()
GraphicsConfiguration	getDeviceConfiguration()
protected Dimension	getPageSize() Reads the PAGE_SIZE Property.
protected void	init(OutputStream os)
protected void	openPage(Dimension size, String title, Component component)
static void	setClipEnabled(boolean enabled) Set the clipping enabled flag.
void	setFooter(Font font, TagString left, TagString center, TagString right, int underlineThickness)
void	setHeader(Font font, TagString left, TagString center, TagString right, int underlineThickness)
void	setPaintMode()
void	setXORMode(Color c1)
void	showString(Font font, String str) Write the string str the the stream.
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 s) Embed a PostScript comment into the output file.
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() Embed a grestore in the PostScript file.
protected void	writeGraphicsSave() Embed a gsave in the PostScript file.
void	writeHeader() Write out the header of this EPS file.
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 paint) Writes out paint as the given gradient.
protected void	writePaint(Paint p) Writes out paint.
protected void	writePaint(TexturePaint paint) Writes out paint as the given texture.
protected void	writeSetClip(Shape s) Write out Shape clip.
protected void	writeSetTransform(AffineTransform tx) Clears any existing transformation and sets the a new one.
protected void	writeString(String str, double x, double y)
void	writeTrailer() Called to write the trailing part of the output.
protected void	writeTransform(AffineTransform tx) Writes out the transform as it needs to be concatenated to the internal transform of the output format.
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, 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, 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, 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

BACKGROUND

public static final String BACKGROUND

BACKGROUND_COLOR

public static final String BACKGROUND_COLOR

PAGE_SIZE

public static final String PAGE_SIZE

Property name for setting the size of the pages output by this AbstractPSGraphics2D.

To set a pre-defined page size, set this property to one of the page size constants defined in PageConstants - for instance, PageConstants.A4, PageConstants.LETTER.

To set a custom page size, set this property to the value CUSTOM_PAGE_SIZE. Then, set the CUSTOM_PAGE_SIZE property to a Dimension object.

See Also:

UserProperties

CUSTOM_PAGE_SIZE

public static final String CUSTOM_PAGE_SIZE

Property name (and value!) for setting a custom page size.

If the PAGE_SIZE property is set to THIS VALUE, then the properties are consulted for the value of THIS KEY. The value of this key should be a Dimension object, in the "user coordinates" of Java2D.

PAGE_MARGINS

public static final String PAGE_MARGINS

Set this to an Insets object to set the 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

FOR

public static final String FOR

TITLE

public static final String TITLE

PREVIEW

public static final String PREVIEW

PREVIEW_BITS

public static final String PREVIEW_BITS

WRITE_IMAGES_AS

public static final String WRITE_IMAGES_AS

version

public static final String version

See Also:

Constant Field Values

LEVEL_2

public static final int LEVEL_2

See Also:

Constant Field Values

LEVEL_3

public static final int LEVEL_3

See Also:

Constant Field Values

ros

protected OutputStream ros

os

protected PrintStream os

Constructor Detail

AbstractPSGraphics2D

public AbstractPSGraphics2D(Dimension size,
                    boolean doRestoreOnDispose)

AbstractPSGraphics2D

public AbstractPSGraphics2D(Component component,
                    boolean doRestoreOnDispose)

AbstractPSGraphics2D

protected AbstractPSGraphics2D(AbstractPSGraphics2D graphics,
                    boolean doRestoreOnDispose)

This protected method is used by the create() methods to create a clone of the given graphics object.

Parameters:

graphics - Parent graphics to take attributes from

doRestoreOnDispose - if true writeGraphicsRestore() is called on dispose()

Method Detail

getDefaultProperties

public static Properties getDefaultProperties()

init

protected void init(OutputStream os)

setClipEnabled

public static void setClipEnabled(boolean enabled)

Set the clipping enabled flag. This will affect all output operations after this call completes.

Parameters:

enabled - true enables clipping

writeHeader

public void writeHeader()
                 throws IOException

Write out the header of this EPS file.

Specified by:

writeHeader in class AbstractVectorGraphicsIO

Throws:

IOException

writeBackground

public void writeBackground()
                     throws IOException

Specified by:

writeBackground in class AbstractVectorGraphicsIO

Throws:

IOException

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

getPageSize

protected Dimension getPageSize()

Reads the PAGE_SIZE Property. If A4 .. A0 is found, PageConstants will determine the size. If CUSTOM_PAGE_SIZE is found, CUSTOM_PAGE_SIZE is used as a Property key for a dimension object.

Returns:

Size of page

openPage

protected void openPage(Dimension size,
            String title,
            Component component)

setHeader

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

setFooter

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

writeGraphicsSave

protected void writeGraphicsSave()
                          throws IOException

Embed a gsave in the PostScript file.

Specified by:

writeGraphicsSave in class AbstractVectorGraphicsIO

Throws:

IOException

writeGraphicsRestore

protected void writeGraphicsRestore()
                             throws IOException

Embed a grestore in the PostScript file.

Specified by:

writeGraphicsRestore in class AbstractVectorGraphicsIO

Throws:

IOException

draw

public void draw(Shape shape)

Specified by:

draw in class VectorGraphics

fill

public void fill(Shape shape)

Specified by:

fill in class VectorGraphics

fillAndDraw

public void fillAndDraw(Shape shape,
               Color fillColor)

Overrides:

fillAndDraw in class AbstractVectorGraphics

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 tx)
                       throws IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out the transform as it needs to be concatenated to the internal transform of the output format. If there is no implementation of an internal transform, then this method needs to do nothing, BUT all coordinates need to be transformed by the currentTransform before being written out.

Specified by:

writeTransform in class AbstractVectorGraphicsIO

Parameters:

tx - to be written

Throws:

IOException

writeSetTransform

protected void writeSetTransform(AffineTransform tx)
                          throws IOException

Description copied from class: AbstractVectorGraphicsIO

Clears any existing transformation and sets the a new one. The default implementation calls writeTransform using the inverted affine transform to calculate it. s *

Overrides:

writeSetTransform in class AbstractVectorGraphicsIO

Parameters:

tx - to be written

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

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

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 paint)
                   throws IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out paint as the given gradient.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

paint - to be written

Throws:

IOException

writePaint

protected void writePaint(TexturePaint paint)
                   throws IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out paint as the given texture.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

paint - to be written

Throws:

IOException

writePaint

protected void writePaint(Paint p)
                   throws IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out paint.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

p - to be written

Throws:

IOException

writeFont

protected void writeFont(Font font)

Description copied from class: AbstractVectorGraphicsIO

Writes the font

Specified by:

writeFont in class AbstractVectorGraphicsIO

Parameters:

font - to be written

getDeviceConfiguration

public GraphicsConfiguration getDeviceConfiguration()

Specified by:

getDeviceConfiguration in class VectorGraphics

writeComment

public void writeComment(String s)
                  throws IOException

Embed a PostScript comment into the output file.

Specified by:

writeComment in class AbstractVectorGraphicsIO

Parameters:

s - to be written

Throws:

IOException

toString

public String toString()

Specified by:

toString in class VectorGraphics

showString

public void showString(Font font,
              String str)

Write the string str the the stream. Method is used by FontUtilities.showString(java.awt.Font, String, org.freehep.graphics2d.font.CharTable, org.freehep.graphics2d.font.FontUtilities.ShowString) or showCharacterCodes(String, double, double) depending on the settings font embedding.

Specified by:

showString in interface FontUtilities.ShowString

Parameters:

font - font to use

str - string to draw

fixedPrecision

public String fixedPrecision(double d)