org.qenherkhopeshef.graphics.generic

Class BaseGraphics2D

java.lang.Object

java.awt.Graphics

java.awt.Graphics2D

org.qenherkhopeshef.graphics.generic.BaseGraphics2D

Direct Known Subclasses:

EMFGraphics2D, EncapsulatedPostscriptGraphics2D, MacPictGraphics2D, MultiFileGraphics, QenherPDFGraphics2D, StreamGraphics2DDelegate, SVGGraphics2D, WMFGraphics2D

public abstract class BaseGraphics2D
extends java.awt.Graphics2D

Basic class for creating customs Graphics2D.

We now use IText for pdf export, so the freehep library wasn't very useful anymore. We have decided to write this class to allow the wmf export to be stand alone. We took some of the principles from freehep.

This class defines most of Graphics2D methods in terms of a few selected basic ones. It's basically very simple and straightforward. If your target has good specific methods for a particular operation, feel free to overwrite the corresponding methods.

As a rule, data is defined to support Graphics2D operations, and the simpler operations call the more advanced one. For instance, translate(int,int) calls translate(double,double) which calls transform() with the appropriate transformation. Hence, defining the abstract method should give usable results, but redefining more specific methods should give better results. As an example, every drawing will be done though the Shape interface, but it will probably be more efficient to redefine specific rectangle, etc...

A few design decisions :

• transformations are handled in a straightforward way. Drawing operations should not modify the current transformation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseGraphics2D()
	BaseGraphics2D(BaseGraphics2D g) Create a duplicate of this graphic context.

Method Summary

Modifier and Type	Method and Description
void	addRenderingHints(java.util.Map hints)
void	clearRect(int x, int y, int width, int height)
void	clip(java.awt.Shape s)
void	clipRect(int x, int y, int width, int height)
abstract void	copyArea(int x, int y, int width, int height, int dx, int dy)
abstract java.awt.Graphics	create() Create a clone of this graphics2d, rendering into the same picture.
abstract void	dispose()
void	draw(java.awt.Shape s) Draws a shape.
void	drawArc(int x, int y, int width, int height, int startAngle, int arcAngle)
void	drawGlyphVector(java.awt.font.GlyphVector g, float x, float y)
void	drawImage(java.awt.image.BufferedImage img, java.awt.image.BufferedImageOp op, int x, int y)
abstract boolean	drawImage(java.awt.Image img, java.awt.geom.AffineTransform xform, java.awt.image.ImageObserver obs)
boolean	drawImage(java.awt.Image img, int x, int y, java.awt.Color bgcolor, java.awt.image.ImageObserver observer)
boolean	drawImage(java.awt.Image img, int x, int y, java.awt.image.ImageObserver observer)
boolean	drawImage(java.awt.Image img, int x, int y, int width, int height, java.awt.Color bgcolor, java.awt.image.ImageObserver observer)
boolean	drawImage(java.awt.Image img, int x, int y, int width, int height, java.awt.image.ImageObserver observer)
boolean	drawImage(java.awt.Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, java.awt.Color bgcolor, java.awt.image.ImageObserver observer)
boolean	drawImage(java.awt.Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, java.awt.image.ImageObserver observer)
void	drawLine(int x1, int y1, int x2, int y2)
void	drawOval(int x, int y, int width, int height)
void	drawPolygon(int[] xPoints, int[] yPoints, int nPoints)
void	drawPolyline(int[] xPoints, int[] yPoints, int nPoints) Draws a polygon.
void	drawRenderableImage(java.awt.image.renderable.RenderableImage img, java.awt.geom.AffineTransform xform) A simple and probably false interpretation.
abstract void	drawRenderedImage(java.awt.image.RenderedImage img, java.awt.geom.AffineTransform xform)
void	drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
void	drawString(java.text.AttributedCharacterIterator iterator, float x, float y)
void	drawString(java.text.AttributedCharacterIterator iterator, int x, int y)
void	drawString(java.lang.String s, float x, float y)
void	drawString(java.lang.String str, int x, int y)
abstract void	fill(java.awt.Shape s)
void	fillArc(int x, int y, int width, int height, int startAngle, int arcAngle)
void	fillOval(int x, int y, int width, int height)
void	fillPolygon(int[] xPoints, int[] yPoints, int nPoints)
void	fillRect(int x, int y, int width, int height)
void	fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
java.awt.Color	getBackground()
java.awt.Shape	getClip()
java.awt.Rectangle	getClipBounds()
java.awt.Color	getColor()
java.awt.Composite	getComposite()
java.awt.GraphicsConfiguration	getDeviceConfiguration()
java.awt.Font	getFont()
java.awt.FontMetrics	getFontMetrics(java.awt.Font f)
java.awt.font.FontRenderContext	getFontRenderContext()
java.awt.Paint	getPaint()
protected java.awt.geom.GeneralPath	getPathFor(int[] xPoints, int[] yPoints, int nPoints) Builds a path for a polyline.
java.lang.Object	getRenderingHint(java.awt.RenderingHints.Key hintKey)
java.awt.RenderingHints	getRenderingHints()
java.awt.Stroke	getStroke()
java.awt.geom.AffineTransform	getTransform()
boolean	hit(java.awt.Rectangle rect, java.awt.Shape s, boolean onStroke)
void	rotate(double theta)
void	rotate(double theta, double x, double y)
void	scale(double sx, double sy)
void	setBackground(java.awt.Color color)
void	setClip(int x, int y, int width, int height)
void	setClip(java.awt.Shape clip)
void	setColor(java.awt.Color c)
void	setComposite(java.awt.Composite comp)
void	setFont(java.awt.Font font)
void	setPaint(java.awt.Paint paint)
abstract void	setPaintMode()
abstract void	setProperties(java.util.Properties properties) Communicates properties (which can be used as a generic system for parameters) to the graphic system.
void	setRenderingHint(java.awt.RenderingHints.Key hintKey, java.lang.Object hintValue)
void	setRenderingHints(java.util.Map hints)
void	setStroke(java.awt.Stroke s)
void	setTransform(java.awt.geom.AffineTransform Tx)
abstract void	setXORMode(java.awt.Color c1) Switches to Xor mode.
void	shear(double shx, double shy)
void	transform(java.awt.geom.AffineTransform Tx) Transform the current system reference according to Tx.
void	translate(double tx, double ty)
void	translate(int x, int y)

Methods inherited from class java.awt.Graphics2D

draw3DRect, fill3DRect

Methods inherited from class java.awt.Graphics

create, drawBytes, drawChars, drawPolygon, drawRect, fillPolygon, finalize, getClipBounds, getClipRect, getFontMetrics, hitClip, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseGraphics2D

protected BaseGraphics2D()

BaseGraphics2D

public BaseGraphics2D(BaseGraphics2D g)

Create a duplicate of this graphic context.

To be used when writting copy constructor for subclasses.

Parameters:

g -

Method Detail

addRenderingHints

public void addRenderingHints(java.util.Map hints)

Specified by:

addRenderingHints in class java.awt.Graphics2D

clearRect

public void clearRect(int x,
                      int y,
                      int width,
                      int height)

Specified by:

clearRect in class java.awt.Graphics

clip

public void clip(java.awt.Shape s)

Specified by:

clip in class java.awt.Graphics2D

clipRect

public void clipRect(int x,
                     int y,
                     int width,
                     int height)

Specified by:

clipRect in class java.awt.Graphics

copyArea

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

Specified by:

copyArea in class java.awt.Graphics

create

public abstract java.awt.Graphics create()

Create a clone of this graphics2d, rendering into the same picture. Keep different states informations however. Suggested implementation: create a copy constructor and use

 return new MyGraphicsType(this);
 

as implementation.

Specified by:

create in class java.awt.Graphics

See Also:

Graphics.create()

dispose

public abstract void dispose()

Specified by:

dispose in class java.awt.Graphics

draw

public void draw(java.awt.Shape s)

Draws a shape.

A basic, probably very suboptimal implementation of draw, which calls fill(shape). For the sake of efficiency, you should probably rewrite it.

Specified by:

draw in class java.awt.Graphics2D

See Also:

Graphics2D.draw(Shape)

drawArc

public void drawArc(int x,
                    int y,
                    int width,
                    int height,
                    int startAngle,
                    int arcAngle)

Specified by:

drawArc in class java.awt.Graphics

drawGlyphVector

public void drawGlyphVector(java.awt.font.GlyphVector g,
                            float x,
                            float y)

Specified by:

drawGlyphVector in class java.awt.Graphics2D

drawImage

public void drawImage(java.awt.image.BufferedImage img,
                      java.awt.image.BufferedImageOp op,
                      int x,
                      int y)

Specified by:

drawImage in class java.awt.Graphics2D

drawImage

public abstract boolean drawImage(java.awt.Image img,
                                  java.awt.geom.AffineTransform xform,
                                  java.awt.image.ImageObserver obs)

Specified by:

drawImage in class java.awt.Graphics2D

drawImage

public boolean drawImage(java.awt.Image img,
                         int x,
                         int y,
                         java.awt.Color bgcolor,
                         java.awt.image.ImageObserver observer)

Specified by:

drawImage in class java.awt.Graphics

drawImage

public boolean drawImage(java.awt.Image img,
                         int x,
                         int y,
                         java.awt.image.ImageObserver observer)

Specified by:

drawImage in class java.awt.Graphics

drawImage

public boolean drawImage(java.awt.Image img,
                         int x,
                         int y,
                         int width,
                         int height,
                         java.awt.Color bgcolor,
                         java.awt.image.ImageObserver observer)

Specified by:

drawImage in class java.awt.Graphics

drawImage

public boolean drawImage(java.awt.Image img,
                         int x,
                         int y,
                         int width,
                         int height,
                         java.awt.image.ImageObserver observer)

Specified by:

drawImage in class java.awt.Graphics

drawImage

public boolean drawImage(java.awt.Image img,
                         int dx1,
                         int dy1,
                         int dx2,
                         int dy2,
                         int sx1,
                         int sy1,
                         int sx2,
                         int sy2,
                         java.awt.Color bgcolor,
                         java.awt.image.ImageObserver observer)

Specified by:

drawImage in class java.awt.Graphics

drawImage

public boolean drawImage(java.awt.Image img,
                         int dx1,
                         int dy1,
                         int dx2,
                         int dy2,
                         int sx1,
                         int sy1,
                         int sx2,
                         int sy2,
                         java.awt.image.ImageObserver observer)

Specified by:

drawImage in class java.awt.Graphics

drawLine

public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2)

Specified by:

drawLine in class java.awt.Graphics

drawOval

public void drawOval(int x,
                     int y,
                     int width,
                     int height)

Specified by:

drawOval in class java.awt.Graphics

drawPolygon

public void drawPolygon(int[] xPoints,
                        int[] yPoints,
                        int nPoints)

Specified by:

drawPolygon in class java.awt.Graphics

drawPolyline

public void drawPolyline(int[] xPoints,
                         int[] yPoints,
                         int nPoints)

Draws a polygon.

The default implementation uses shapes. You can probably get something more efficient.

Specified by:

drawPolyline in class java.awt.Graphics

See Also:

Graphics.drawPolyline(int[], int[], int)

drawRenderableImage

public void drawRenderableImage(java.awt.image.renderable.RenderableImage img,
                                java.awt.geom.AffineTransform xform)

A simple and probably false interpretation.

Specified by:

drawRenderableImage in class java.awt.Graphics2D

See Also:

Graphics2D.drawRenderableImage(java.awt.image.renderable.RenderableImage, java.awt.geom.AffineTransform)

drawRenderedImage

public abstract void drawRenderedImage(java.awt.image.RenderedImage img,
                                       java.awt.geom.AffineTransform xform)

Specified by:

drawRenderedImage in class java.awt.Graphics2D

drawRoundRect

public void drawRoundRect(int x,
                          int y,
                          int width,
                          int height,
                          int arcWidth,
                          int arcHeight)

Specified by:

drawRoundRect in class java.awt.Graphics

drawString

public void drawString(java.text.AttributedCharacterIterator iterator,
                       float x,
                       float y)

Specified by:

drawString in class java.awt.Graphics2D

drawString

public void drawString(java.text.AttributedCharacterIterator iterator,
                       int x,
                       int y)

Specified by:

drawString in class java.awt.Graphics2D

drawString

public void drawString(java.lang.String s,
                       float x,
                       float y)

Specified by:

drawString in class java.awt.Graphics2D

drawString

public void drawString(java.lang.String str,
                       int x,
                       int y)

Specified by:

drawString in class java.awt.Graphics2D

fill

public abstract void fill(java.awt.Shape s)

Specified by:

fill in class java.awt.Graphics2D

fillArc

public void fillArc(int x,
                    int y,
                    int width,
                    int height,
                    int startAngle,
                    int arcAngle)

Specified by:

fillArc in class java.awt.Graphics

fillOval

public void fillOval(int x,
                     int y,
                     int width,
                     int height)

Specified by:

fillOval in class java.awt.Graphics

fillPolygon

public void fillPolygon(int[] xPoints,
                        int[] yPoints,
                        int nPoints)

Specified by:

fillPolygon in class java.awt.Graphics

fillRect

public void fillRect(int x,
                     int y,
                     int width,
                     int height)

Specified by:

fillRect in class java.awt.Graphics

fillRoundRect

public void fillRoundRect(int x,
                          int y,
                          int width,
                          int height,
                          int arcWidth,
                          int arcHeight)

Specified by:

fillRoundRect in class java.awt.Graphics

getBackground

public java.awt.Color getBackground()

Specified by:

getBackground in class java.awt.Graphics2D

getClip

public java.awt.Shape getClip()

Specified by:

getClip in class java.awt.Graphics

getClipBounds

public java.awt.Rectangle getClipBounds()

Specified by:

getClipBounds in class java.awt.Graphics

getColor

public java.awt.Color getColor()

Specified by:

getColor in class java.awt.Graphics

getComposite

public java.awt.Composite getComposite()

Specified by:

getComposite in class java.awt.Graphics2D

getFont

public java.awt.Font getFont()

Specified by:

getFont in class java.awt.Graphics

getFontMetrics

public java.awt.FontMetrics getFontMetrics(java.awt.Font f)

Specified by:

getFontMetrics in class java.awt.Graphics

getPaint

public java.awt.Paint getPaint()

Specified by:

getPaint in class java.awt.Graphics2D

getPathFor

protected java.awt.geom.GeneralPath getPathFor(int[] xPoints,
                                               int[] yPoints,
                                               int nPoints)

Builds a path for a polyline.

This command can be used to create the path needed by most polygon oriented commands.

The path is not closed, but a simple closePath command will do.

Parameters:

xPoints -

yPoints -

nPoints -

Returns:

a path, or null if nPoints is 0.

getRenderingHint

public java.lang.Object getRenderingHint(java.awt.RenderingHints.Key hintKey)

Specified by:

getRenderingHint in class java.awt.Graphics2D

getRenderingHints

public java.awt.RenderingHints getRenderingHints()

Specified by:

getRenderingHints in class java.awt.Graphics2D

getStroke

public java.awt.Stroke getStroke()

Specified by:

getStroke in class java.awt.Graphics2D

getTransform

public java.awt.geom.AffineTransform getTransform()

Specified by:

getTransform in class java.awt.Graphics2D

hit

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

Specified by:

hit in class java.awt.Graphics2D

rotate

public void rotate(double theta)

Specified by:

rotate in class java.awt.Graphics2D

rotate

public void rotate(double theta,
                   double x,
                   double y)

Specified by:

rotate in class java.awt.Graphics2D

scale

public void scale(double sx,
                  double sy)

Specified by:

scale in class java.awt.Graphics2D

setBackground

public void setBackground(java.awt.Color color)

Specified by:

setBackground in class java.awt.Graphics2D

setClip

public void setClip(int x,
                    int y,
                    int width,
                    int height)

Specified by:

setClip in class java.awt.Graphics

setClip

public void setClip(java.awt.Shape clip)

Specified by:

setClip in class java.awt.Graphics

setColor

public void setColor(java.awt.Color c)

Specified by:

setColor in class java.awt.Graphics

setComposite

public void setComposite(java.awt.Composite comp)

Specified by:

setComposite in class java.awt.Graphics2D

setFont

public void setFont(java.awt.Font font)

Specified by:

setFont in class java.awt.Graphics

setPaint

public void setPaint(java.awt.Paint paint)

Specified by:

setPaint in class java.awt.Graphics2D

setPaintMode

public abstract void setPaintMode()

Specified by:

setPaintMode in class java.awt.Graphics

setRenderingHint

public void setRenderingHint(java.awt.RenderingHints.Key hintKey,
                             java.lang.Object hintValue)

Specified by:

setRenderingHint in class java.awt.Graphics2D

setRenderingHints

public void setRenderingHints(java.util.Map hints)

Specified by:

setRenderingHints in class java.awt.Graphics2D

setStroke

public void setStroke(java.awt.Stroke s)

Specified by:

setStroke in class java.awt.Graphics2D

setTransform

public void setTransform(java.awt.geom.AffineTransform Tx)

Specified by:

setTransform in class java.awt.Graphics2D

setXORMode

public abstract void setXORMode(java.awt.Color c1)

Switches to Xor mode.

Specified by:

setXORMode in class java.awt.Graphics

See Also:

Graphics.setXORMode(java.awt.Color)

shear

public void shear(double shx,
                  double shy)

Specified by:

shear in class java.awt.Graphics2D

transform

public void transform(java.awt.geom.AffineTransform Tx)

Transform the current system reference according to Tx.

All scaling and assorted transformations in BaseGraphics2D use this method. Hence, if you want to modify the transformation system, simply redefine it.

Specified by:

transform in class java.awt.Graphics2D

See Also:

Graphics2D.transform(java.awt.geom.AffineTransform)

translate

public void translate(double tx,
                      double ty)

Specified by:

translate in class java.awt.Graphics2D

translate

public void translate(int x,
                      int y)

Specified by:

translate in class java.awt.Graphics2D

setProperties

public abstract void setProperties(java.util.Properties properties)

Communicates properties (which can be used as a generic system for parameters) to the graphic system.

Parameters:

properties -

getDeviceConfiguration

public java.awt.GraphicsConfiguration getDeviceConfiguration()

Specified by:

getDeviceConfiguration in class java.awt.Graphics2D

getFontRenderContext

public java.awt.font.FontRenderContext getFontRenderContext()

Specified by:

getFontRenderContext in class java.awt.Graphics2D