org.freehep.graphicsio
Class DummyGraphics2D

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.DummyGraphics2D

All Implemented Interfaces:

VectorGraphicsConstants

public class DummyGraphics2D
extends AbstractVectorGraphicsIO

This class provides a dummy Graphics2D class, which issues warnings for all non implemented methods. It also describes how to implement these methods. It serves as an example to start the implementation for a new output format.

Version:

$Id: DummyGraphics2D.java 8584 2006-08-10 23:06:37Z duns $

Author:

Mark Donszelmann

Field Summary

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

protected	DummyGraphics2D(AbstractVectorGraphicsIO graphics, boolean doRestoreOnDispose)
	DummyGraphics2D(java.awt.Dimension size, boolean doRestoreOnDispose)

Method Summary

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 shape)
void	fill(java.awt.Shape shape)
void	fillAndDraw(java.awt.Shape shape, java.awt.Color fillColor)
java.awt.GraphicsConfiguration	getDeviceConfiguration()
boolean	hit(java.awt.Rectangle rect, java.awt.Shape s, boolean onStroke) Checks whether or not the specified Shape intersects the specified Rectangle, which is in device space.
void	setPaintMode()
void	setXORMode(java.awt.Color c1)
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() Called to write the header part of the output.
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 p) Writes out paint as the given color.
protected void	writePaint(java.awt.GradientPaint p) Writes out paint as the given gradient.
protected void	writePaint(java.awt.Paint p) Writes out paint.
protected void	writePaint(java.awt.TexturePaint p) Writes out paint as the given texture.
protected void	writeSetClip(java.awt.Shape s) Write out Shape clip.
protected void	writeSetTransform(java.awt.geom.AffineTransform t) Clears any existing transformation and sets the a new one.
protected void	writeString(java.lang.String string, double x, double y)
void	writeTrailer() Called to write the trailing part of the output.
protected void	writeTransform(java.awt.geom.AffineTransform t) 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, 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

Constructor Detail

DummyGraphics2D

public DummyGraphics2D(java.awt.Dimension size,
                       boolean doRestoreOnDispose)

DummyGraphics2D

protected DummyGraphics2D(AbstractVectorGraphicsIO graphics,
                          boolean doRestoreOnDispose)

Method Detail

writeHeader

public void writeHeader()
                 throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Called to write the header part of the output.

Specified by:

writeHeader in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

writeBackground

public void writeBackground()
                     throws java.io.IOException

Specified by:

writeBackground in class AbstractVectorGraphicsIO

Throws:

java.io.IOException

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

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 shape)

Specified by:

draw in class VectorGraphics

fill

public void fill(java.awt.Shape shape)

Specified by:

fill in class VectorGraphics

fillAndDraw

public void fillAndDraw(java.awt.Shape shape,
                        java.awt.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(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 string,
                           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

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:

t - to be written

Throws:

java.io.IOException

writeSetTransform

protected void writeSetTransform(java.awt.geom.AffineTransform t)
                          throws java.io.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:

t - to be written

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

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

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 p)
                   throws java.io.IOException

Description copied from class: AbstractVectorGraphicsIO

Writes out paint as the given color.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

p - to be written

Throws:

java.io.IOException

writePaint

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

Description copied from class: AbstractVectorGraphicsIO

Writes out paint as the given gradient.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

p - to be written

Throws:

java.io.IOException

writePaint

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

Description copied from class: AbstractVectorGraphicsIO

Writes out paint as the given texture.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

p - to be written

Throws:

java.io.IOException

writePaint

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

Description copied from class: AbstractVectorGraphicsIO

Writes out paint.

Specified by:

writePaint in class AbstractVectorGraphicsIO

Parameters:

p - to be written

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

hit

public boolean hit(java.awt.Rectangle rect,
                   java.awt.Shape s,
                   boolean onStroke)

Description copied from class: AbstractVectorGraphics

Checks whether or not the specified Shape intersects the specified Rectangle, which is in device space.

Overrides:

hit in class AbstractVectorGraphics

Parameters:

rect - the area in device space to check for a hit

s - the Shape to check for a hit

onStroke - flag used to choose between testing the stroked or the filled shape.

See Also:

Graphics2D.hit(Rectangle, Shape, boolean)

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