prajna.util

Class SvgGraphics

java.lang.Object

java.awt.Graphics

prajna.util.SvgGraphics

public class SvgGraphics
extends java.awt.Graphics

This class is designed to provide SVG output for drawing objects with Java2D. It essentially transforms the Graphics2D calls into SVG elements.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
SvgGraphics() Instantiates a new svg graphics.

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributes, java.lang.String data) Adds the SVG element to the current document
void	addFunction(java.lang.String function) Adds a Javascript function to the SVG document.
void	beginGroup(java.util.Map<java.lang.String,java.lang.String> attributes) Begin a group of elements within the SVG document.
void	beginLink(java.lang.String urlString) Begin a hyperlink reference.
void	clear() Clear the current SVG document, and rebuild.
void	clearRect(int x, int y, int width, int height) Clears the specified rectangle by filling it with the background color of the current drawing surface.
void	clipRect(int x, int y, int width, int height) Intersects the current clip with the specified rectangle.
void	copyArea(int x, int y, int width, int height, int dx, int dy) Copies an area of the component by a distance specified by dx and dy.
java.awt.Graphics	create() Creates a new Graphics object that is a copy of this Graphics object.
void	dispose() Disposes of this graphics context and releases any system resources that it is using.
void	drawArc(int x, int y, int width, int height, int startAngle, int arcAngle) Draws the outline of a circular or elliptical arc covering the specified rectangle.
boolean	drawImage(java.awt.Image img, int x, int y, java.awt.Color bgcolor, java.awt.image.ImageObserver observer) Draws as much of the specified image as is currently available.
boolean	drawImage(java.awt.Image img, int x, int y, java.awt.image.ImageObserver observer) Draws as much of the specified image as is currently available.
boolean	drawImage(java.awt.Image img, int x, int y, int width, int height, java.awt.Color bgcolor, java.awt.image.ImageObserver observer) Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.
boolean	drawImage(java.awt.Image img, int x, int y, int width, int height, java.awt.image.ImageObserver observer) Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.
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) Draws as much of the specified area of the specified image as is currently available, scaling it on the fly to fit inside the specified area of the destination drawable surface.
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) Draws as much of the specified area of the specified image as is currently available, scaling it on the fly to fit inside the specified area of the destination drawable surface.
void	drawLine(int x1, int y1, int x2, int y2) Draws a line, using the current color, between the points (x1, y1) and (x2, y2) in this graphics context's coordinate system.
void	drawOval(int x, int y, int width, int height) Draws the outline of an oval.
void	drawPolygon(int[] xPoints, int[] yPoints, int nPoints) Draws a closed polygon defined by arrays of x and y coordinates.
void	drawPolyline(int[] xPoints, int[] yPoints, int nPoints) Draws a sequence of connected lines defined by arrays of x and y coordinates.
void	drawRect(int x, int y, int width, int height) Draws the outline of the specified rectangle.
void	drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight) Draws an outlined round-cornered rectangle using this graphics context's current color.
void	drawString(java.text.AttributedCharacterIterator iterator, int x, int y) Draws the text given by the specified iterator, using this graphics context's current color.
void	drawString(java.lang.String str, int x, int y) Draws the text given by the specified string, using this graphics context's current font and color.
void	endGroup() End the current group.
void	endLink() End the current hyperlink element.
void	fillArc(int x, int y, int width, int height, int startAngle, int arcAngle) Fills a circular or elliptical arc covering the specified rectangle.
void	fillOval(int x, int y, int width, int height) Fills an oval bounded by the specified rectangle with the current color.
void	fillPolygon(int[] xPoints, int[] yPoints, int nPoints) Fills a closed polygon defined by arrays of x and y coordinates.
void	fillRect(int x, int y, int width, int height) Fills the specified rectangle.
void	fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight) Fills the specified rounded corner rectangle with the current color.
java.awt.Shape	getClip() Gets the current clipping area.
java.awt.Rectangle	getClipBounds() Returns the bounding rectangle of the current clipping area
java.awt.Color	getColor() Gets this graphics context's current color.
java.awt.Font	getFont() Gets the font metrics of the current font.
java.awt.FontMetrics	getFontMetrics(java.awt.Font font) Gets the font metrics of the specified font.
java.lang.String	getSvg() Gets the svg.
void	setClip(int x, int y, int width, int height) Sets the current clip to the rectangle specified by the given coordinates.
void	setClip(java.awt.Shape clip) Sets the current clipping area to an arbitrary clip shape.
void	setColor(java.awt.Color col) Sets this graphics context's current color to the specified color.
void	setFont(java.awt.Font font) Sets this graphics context's font to the specified font.
void	setPaintMode() Sets the paint mode of this graphics context to overwrite the destination with this graphics context's current color.
void	setSize(int width, int height) Sets the size.
void	setXORMode(java.awt.Color c1) Sets the paint mode of this graphics context to alternate between this graphics context's current color and the new specified color.
void	translate(int x, int y) Translates the origin of the graphics context to the point (x, y) in the current coordinate system.
void	writeSvg(java.io.Writer writer) Write the current SVG content to a writer.

Methods inherited from class java.awt.Graphics

create, draw3DRect, drawBytes, drawChars, drawPolygon, fill3DRect, 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

SvgGraphics

public SvgGraphics()

Instantiates a new svg graphics.

Method Detail

addElement

public void addElement(java.lang.String name,
              java.util.Map<java.lang.String,java.lang.String> attributes,
              java.lang.String data)

Adds the SVG element to the current document

Parameters:

name - the name of the element

attributes - the attributes for the element

data - the textual data to include with the SVG

addFunction

public void addFunction(java.lang.String function)

Adds a Javascript function to the SVG document.

Parameters:

function - the function

beginGroup

public void beginGroup(java.util.Map<java.lang.String,java.lang.String> attributes)

Begin a group of elements within the SVG document.

Parameters:

attributes - the map of attributes

beginLink

public void beginLink(java.lang.String urlString)

Begin a hyperlink reference.

Parameters:

urlString - the url string for the hyperlink destination

clear

public void clear()

Clear the current SVG document, and rebuild.

clearRect

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

Clears the specified rectangle by filling it with the background color of the current drawing surface.

Specified by:

clearRect in class java.awt.Graphics

Parameters:

x - the x coordinate of the rectangle to clear.

y - the y coordinate of the rectangle to clear.

width - the width of the rectangle to clear.

height - the height of the rectangle to clear.

clipRect

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

Intersects the current clip with the specified rectangle.

Specified by:

clipRect in class java.awt.Graphics

Parameters:

x - the x coordinate of the rectangle to intersect the clip with

y - the y coordinate of the rectangle to intersect the clip with

width - the width of the rectangle to intersect the clip with

height - the height of the rectangle to intersect the clip with

copyArea

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

Copies an area of the component by a distance specified by dx and dy.

Specified by:

copyArea in class java.awt.Graphics

Parameters:

x - the x coordinate of the source rectangle.

y - the y coordinate of the source rectangle.

width - the width of the source rectangle.

height - the height of the source rectangle.

dx - the horizontal distance to copy the pixels.

dy - the vertical distance to copy the pixels.

create

public java.awt.Graphics create()

Creates a new Graphics object that is a copy of this Graphics object.

Specified by:

create in class java.awt.Graphics

Returns:

a new graphics context that is a copy of this graphics context.

dispose

public void dispose()

Disposes of this graphics context and releases any system resources that it is using.

Specified by:

dispose in class java.awt.Graphics

drawArc

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

Draws the outline of a circular or elliptical arc covering the specified rectangle.

Specified by:

drawArc in class java.awt.Graphics

Parameters:

x - the x coordinate of the upper-left corner of the arc to be drawn.

y - the y coordinate of the upper-left corner of the arc to be drawn.

width - the width of the arc to be drawn.

height - the height of the arc to be drawn.

startAngle - the beginning angle.

arcAngle - the angular extent of the arc, relative to the start angle.

drawImage

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

Draws as much of the specified image as is currently available.

Specified by:

drawImage in class java.awt.Graphics

Parameters:

img - the specified image to be drawn. This method does nothing if img is null.

x - the x coordinate.

y - the y coordinate.

bgcolor - the background color to paint under the non-opaque portions of the image.

observer - object to be notified as more of the image is converted.

Returns:

false if the image pixels are still changing; true otherwise.

drawImage

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

Draws as much of the specified image as is currently available.

Specified by:

drawImage in class java.awt.Graphics

Parameters:

img - the specified image to be drawn. This method does nothing if img is null.

x - the x coordinate.

y - the y coordinate. portions of the image.

observer - object to be notified as more of the image is converted.

Returns:

false if the image pixels are still changing; true otherwise.

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)

Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.

Specified by:

drawImage in class java.awt.Graphics

Parameters:

img - the specified image to be drawn. This method does nothing if img is null.

x - the x coordinate.

y - the y coordinate.

width - the width of the rectangle.

height - the height of the rectangle.

bgcolor - the background color to paint under the non-opaque portions of the image.

observer - object to be notified as more of the image is converted.

Returns:

false if the image pixels are still changing; true otherwise.

drawImage

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

Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.

Specified by:

drawImage in class java.awt.Graphics

Parameters:

img - the specified image to be drawn. This method does nothing if img is null.

x - the x coordinate.

y - the y coordinate.

width - the width of the rectangle.

height - the height of the rectangle.

observer - object to be notified as more of the image is converted.

Returns:

false if the image pixels are still changing; true otherwise.

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)

Draws as much of the specified area of the specified image as is currently available, scaling it on the fly to fit inside the specified area of the destination drawable surface.

Specified by:

drawImage in class java.awt.Graphics

Parameters:

img - the specified image to be drawn. This method does nothing if img is null.

dx1 - the x coordinate of the first corner of the destination rectangle.

dy1 - the y coordinate of the first corner of the destination rectangle.

dx2 - the x coordinate of the second corner of the destination rectangle.

dy2 - the y coordinate of the second corner of the destination rectangle.

sx1 - the x coordinate of the first corner of the source rectangle.

sy1 - the y coordinate of the first corner of the source rectangle.

sx2 - the x coordinate of the second corner of the source rectangle.

sy2 - the y coordinate of the second corner of the source rectangle.

bgcolor - the background color to paint under the non-opaque portions of the image.

observer - object to be notified as more of the image is scaled and converted.

Returns:

false if the image pixels are still changing; true otherwise.

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)

Draws as much of the specified area of the specified image as is currently available, scaling it on the fly to fit inside the specified area of the destination drawable surface.

Specified by:

drawImage in class java.awt.Graphics

Parameters:

img - the specified image to be drawn. This method does nothing if img is null.

dx1 - the x coordinate of the first corner of the destination rectangle.

dy1 - the y coordinate of the first corner of the destination rectangle.

dx2 - the x coordinate of the second corner of the destination rectangle.

dy2 - the y coordinate of the second corner of the destination rectangle.

sx1 - the x coordinate of the first corner of the source rectangle.

sy1 - the y coordinate of the first corner of the source rectangle.

sx2 - the x coordinate of the second corner of the source rectangle.

sy2 - the y coordinate of the second corner of the source rectangle.

observer - object to be notified as more of the image is scaled and converted.

Returns:

false if the image pixels are still changing; true otherwise.

drawLine

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

Draws a line, using the current color, between the points (x1, y1) and (x2, y2) in this graphics context's coordinate system.

Specified by:

drawLine in class java.awt.Graphics

Parameters:

x1 - the first point's x coordinate.

y1 - the first point's y coordinate.

x2 - the second point's x coordinate.

y2 - the second point's y coordinate.

drawOval

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

Draws the outline of an oval. The result is a circle or ellipse that fits within the rectangle specified by the x, y, width, and height arguments.

Specified by:

drawOval in class java.awt.Graphics

Parameters:

x - the x coordinate of the upper left corner of the oval to be drawn.

y - the y coordinate of the upper left corner of the oval to be drawn.

width - the width of the oval to be drawn.

height - the height of the oval to be drawn.

drawPolygon

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

Draws a closed polygon defined by arrays of x and y coordinates. Each pair of (x, y) coordinates defines a point.

Specified by:

drawPolygon in class java.awt.Graphics

Parameters:

xPoints - a an array of x coordinates.

yPoints - a an array of y coordinates.

nPoints - a the total number of points.

drawPolyline

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

Draws a sequence of connected lines defined by arrays of x and y coordinates. Each pair of (x, y) coordinates defines a point. The figure is not closed if the first point differs from the last point.

Specified by:

drawPolyline in class java.awt.Graphics

Parameters:

xPoints - an array of x points

yPoints - an array of y points

nPoints - the total number of points

drawRect

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

Draws the outline of the specified rectangle. The left and right edges of the rectangle are at x and x + width. The top and bottom edges are at y and y + height. The rectangle is drawn using the graphics context's current color.

Overrides:

drawRect in class java.awt.Graphics

Parameters:

x - the x coordinate of the rectangle to be drawn.

y - the y coordinate of the rectangle to be drawn.

width - the width of the rectangle to be drawn.

height - the height of the rectangle to be drawn.

drawRoundRect

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

Draws an outlined round-cornered rectangle using this graphics context's current color. The left and right edges of the rectangle are at x and x + width, respectively. The top and bottom edges of the rectangle are at y and y + height.

Specified by:

drawRoundRect in class java.awt.Graphics

Parameters:

x - the x coordinate of the rectangle to be drawn.

y - the y coordinate of the rectangle to be drawn.

width - the width of the rectangle to be drawn.

height - the height of the rectangle to be drawn.

arcWidth - the horizontal diameter of the arc at the four corners.

arcHeight - the vertical diameter of the arc at the four corners.

drawString

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

Draws the text given by the specified iterator, using this graphics context's current color. The iterator has to specify a font for each character. The baseline of the leftmost character is at position (x, y) in this graphics context's coordinate system.

Specified by:

drawString in class java.awt.Graphics

Parameters:

iterator - the iterator whose text is to be drawn

x - the x coordinate.

y - the y coordinate.

drawString

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

Draws the text given by the specified string, using this graphics context's current font and color. The baseline of the leftmost character is at position (x, y) in this graphics context's coordinate system.

Specified by:

drawString in class java.awt.Graphics

Parameters:

str - the string to be drawn.

x - the x coordinate.

y - the y coordinate.

endGroup

public void endGroup()

End the current group.

endLink

public void endLink()

End the current hyperlink element.

fillArc

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

Fills a circular or elliptical arc covering the specified rectangle.

Specified by:

fillArc in class java.awt.Graphics

Parameters:

x - the x coordinate of the upper-left corner of the arc to be drawn.

y - the y coordinate of the upper-left corner of the arc to be drawn.

width - the width of the arc to be drawn.

height - the height of the arc to be drawn.

startAngle - the beginning angle.

arcAngle - the angular extent of the arc, relative to the start angle.

fillOval

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

Fills an oval bounded by the specified rectangle with the current color.

Specified by:

fillOval in class java.awt.Graphics

Parameters:

x - the x coordinate of the upper left corner of the oval to be drawn.

y - the y coordinate of the upper left corner of the oval to be drawn.

width - the width of the oval to be drawn.

height - the height of the oval to be drawn.

fillPolygon

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

Fills a closed polygon defined by arrays of x and y coordinates.

Specified by:

fillPolygon in class java.awt.Graphics

Parameters:

xPoints - a an array of x coordinates.

yPoints - a an array of y coordinates.

nPoints - a the total number of points.

fillRect

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

Fills the specified rectangle. The left and right edges of the rectangle are at x and x + width - 1. The top and bottom edges are at y and y + height - 1. The resulting rectangle covers an area width pixels wide by height pixels tall. The rectangle is filled using the graphics context's current color.

Specified by:

fillRect in class java.awt.Graphics

Parameters:

x - the x coordinate of the rectangle to be drawn.

y - the y coordinate of the rectangle to be drawn.

width - the width of the rectangle to be drawn.

height - the height of the rectangle to be drawn.

fillRoundRect

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

Fills the specified rounded corner rectangle with the current color. The left and right edges of the rectangle are at x and x + width - 1, respectively. The top and bottom edges of the rectangle are at y and y + height - 1.

Specified by:

fillRoundRect in class java.awt.Graphics

Parameters:

x - the x coordinate of the rectangle to be drawn.

y - the y coordinate of the rectangle to be drawn.

width - the width of the rectangle to be drawn.

height - the height of the rectangle to be drawn.

arcWidth - the horizontal diameter of the arc at the four corners.

arcHeight - the vertical diameter of the arc at the four corners.

getClip

public java.awt.Shape getClip()

Gets the current clipping area.

Specified by:

getClip in class java.awt.Graphics

Returns:

a Shape object representing the current clipping area, or null if no clip is set.

getClipBounds

public java.awt.Rectangle getClipBounds()

Returns the bounding rectangle of the current clipping area

Specified by:

getClipBounds in class java.awt.Graphics

Returns:

the bounding rectangle of the current clipping area, or null if no clip is set.

getColor

public java.awt.Color getColor()

Gets this graphics context's current color.

Specified by:

getColor in class java.awt.Graphics

Returns:

this graphics context's current color.

getFont

public java.awt.Font getFont()

Gets the font metrics of the current font.

Specified by:

getFont in class java.awt.Graphics

Returns:

the font metrics of this graphics context's current font.

getFontMetrics

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

Gets the font metrics of the specified font.

Specified by:

getFontMetrics in class java.awt.Graphics

Parameters:

font - the specified font

Returns:

the font metrics for the specified font.

getSvg

public java.lang.String getSvg()

Gets the svg.

Returns:

the svg

setClip

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

Sets the current clip to the rectangle specified by the given coordinates.

Specified by:

setClip in class java.awt.Graphics

Parameters:

x - the x coordinate of the new clip rectangle.

y - the y coordinate of the new clip rectangle.

width - the width of the new clip rectangle.

height - the height of the new clip rectangle.

setClip

public void setClip(java.awt.Shape clip)

Sets the current clipping area to an arbitrary clip shape.

Specified by:

setClip in class java.awt.Graphics

Parameters:

clip - the Shape to use to set the clip

setColor

public void setColor(java.awt.Color col)

Sets this graphics context's current color to the specified color.

Specified by:

setColor in class java.awt.Graphics

Parameters:

col - the new rendering color.

setFont

public void setFont(java.awt.Font font)

Sets this graphics context's font to the specified font.

Specified by:

setFont in class java.awt.Graphics

Parameters:

font - the font

setPaintMode

public void setPaintMode()

Sets the paint mode of this graphics context to overwrite the destination with this graphics context's current color.

Specified by:

setPaintMode in class java.awt.Graphics

setSize

public void setSize(int width,
           int height)

Sets the size.

Parameters:

width - the width

height - the height

setXORMode

public void setXORMode(java.awt.Color c1)

Sets the paint mode of this graphics context to alternate between this graphics context's current color and the new specified color.

Specified by:

setXORMode in class java.awt.Graphics

Parameters:

c1 - the XOR alternation color

translate

public void translate(int x,
             int y)

Translates the origin of the graphics context to the point (x, y) in the current coordinate system.

Specified by:

translate in class java.awt.Graphics

Parameters:

x - the x coordinate

y - the y coordinate

writeSvg

public void writeSvg(java.io.Writer writer)

Write the current SVG content to a writer.

Parameters:

writer - the writer to write the SVG to.