DummyGraphics2D (FreeHEP GraphicsIO 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.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: freehep-graphicsio/src/main/java/org/freehep/graphicsio/DummyGraphics2D.java cba39eb5843a 2006/03/20 18:04:28 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

Constructors
Modifier	Constructor and Description
`protected`	`DummyGraphics2D(AbstractVectorGraphicsIO graphics, boolean doRestoreOnDispose)`
	`DummyGraphics2D(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)`
`Graphics`	`create()`
`Graphics`	`create(double x, double y, double width, double height)`
`void`	`draw(Shape shape)`
`void`	`fill(Shape shape)`
`void`	`fillAndDraw(Shape shape, Color fillColor)`
`GraphicsConfiguration`	`getDeviceConfiguration()`
`boolean`	`hit(Rectangle rect, Shape s, boolean onStroke)`
`void`	`setPaintMode()`
`void`	`setXORMode(Color c1)`
`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()` Called to write the header part of the output.
`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 p)` Writes out paint as the given color.
`protected void`	`writePaint(GradientPaint p)` Writes out paint as the given gradient.
`protected void`	`writePaint(Paint p)` Writes out paint.
`protected void`	`writePaint(TexturePaint p)` Writes out paint as the given texture.
`protected void`	`writeSetClip(Shape s)` Write out Shape clip.
`protected void`	`writeSetTransform(AffineTransform t)` Clears any existing transformation and sets the a new one.
`protected void`	`writeString(String string, double x, double y)`
`void`	`writeTrailer()` Called to write the trailing part of the output.
`protected void`	`writeTransform(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(Dimension size,
               boolean doRestoreOnDispose)
```
  - DummyGraphics2D
```
protected DummyGraphics2D(AbstractVectorGraphicsIO graphics,
               boolean doRestoreOnDispose)
```
- Method Detail
  - writeHeader
```
public void writeHeader()
                 throws IOException
```
    Description copied from class: AbstractVectorGraphicsIO
    
    Called to write the header part of the output.
    
    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
  - 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 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 string,
               double x,
               double y)
                    throws IOException
```
    Specified by:
    
    writeString in class AbstractVectorGraphicsIO
    
    Throws:
    
    IOException
  - writeTransform
```
protected void writeTransform(AffineTransform t)
                       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:
    t - to be written
    
    Throws:
    
    IOException
  - writeSetTransform
```
protected void writeSetTransform(AffineTransform t)
                          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:
    t - 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 p)
                   throws 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:
    
    IOException
  - writePaint
```
protected void writePaint(GradientPaint p)
                   throws 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:
    
    IOException
  - writePaint
```
protected void writePaint(TexturePaint p)
                   throws 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:
    
    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)
                  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
  - hit
```
public boolean hit(Rectangle rect,
          Shape s,
          boolean onStroke)
```
    Overrides:
    
    hit in class AbstractVectorGraphics
  - 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

Class DummyGraphics2D

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

Constructor Detail

DummyGraphics2D

DummyGraphics2D

Method Detail

writeHeader

writeBackground

writeTrailer

closeStream

create

create

writeGraphicsSave

writeGraphicsRestore

draw

fill

fillAndDraw

copyArea

writeImage

writeString

writeTransform

writeSetTransform

writeClip

writeSetClip

writeWidth

writeCap

writeJoin

writeMiterLimit

writeDash

setPaintMode

setXORMode

writePaint

writePaint

writePaint

writePaint

writeFont

getDeviceConfiguration

hit

writeComment

toString