Package de.cau.cs.kieler.klighd.piccolo.freehep

Class SemanticSVGGraphics2D

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

de.cau.cs.kieler.klighd.piccolo.freehep.SemanticSVGGraphics2D

All Implemented Interfaces:

org.freehep.graphics2d.VectorGraphicsConstants

public class SemanticSVGGraphics2D
extends org.freehep.graphicsio.AbstractVectorGraphicsIO

This class implements the Scalable Vector Graphics output. SVG specifications can be found at http://www.w3c.org/Graphics/SVG/ The current implementation is based on REC-SVG11-20030114

Version:

$Id: freehep-graphicsio-svg/src/main/java/org/freehep/graphicsio/svg/SVGGraphics2D.java 4c4708a97391 2007/06/12 22:32:31 duns $ - Added capabilities to add semantic information to the svg, ie key/value pairs within the 'klighd' namespace. - Allow comments to be switched off. - Corrected direction of color gradients. - Added support for multi-line text and proper font sizing.

Author:

Mark Donszelmann, uru

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_ROOT_DATA
static final String	BACKGROUND
static final String	BACKGROUND_COLOR
static final String	COMPRESS
static final String	CSS
static final String	DESCRIPTION
static final String	EMBED_FONTS
static final String	EXPORT_IMAGES
static final String	EXPORT_SUFFIX
static final String	FOR
static final String	IMAGE_SIZE
static final String	STYLABLE	use style="font-size:20" instaed of font-size="20" see style(java.util.Properties) for details
static final String	TITLE
static final String	TRANSPARENT
static final String	version
static final String	VERSION
static final String	VERSION_1_1
static final 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	Description
protected	SemanticSVGGraphics2D(SemanticSVGGraphics2D graphics, boolean doRestoreOnDispose)
	SemanticSVGGraphics2D(File file, Component component)
	SemanticSVGGraphics2D(File file, Dimension size)
	SemanticSVGGraphics2D(OutputStream os, Component component)
	SemanticSVGGraphics2D(OutputStream os, Dimension size)

Method Summary

Modifier and Type	Method	Description
void	addSemanticData(KlighdSemanticDiagramData nextSemanticData)
void	closeStream()
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)
static Path2D	createAWTPath(org.eclipse.swt.graphics.PathData pathData)	Builds up a AWT Path2D according to a given SWT Geometry PathData.
void	dispose()
void	draw(Shape shape)	Draws the shape using the current paint as border
void	drawString(String string, double x, double y)	Copied from AbstractVectorGraphicsIO to change the handling of text as shapes.
void	endGroup()
void	fill(Shape shape)	Fills the shape without a border using the current paint
static String	fixedPrecision(double d)	converts the double value to a representing string
protected float	getAdjustedFontHeight()
protected float	getAdjustedFontHeight(int height, int ascent, int descent, boolean firstLine)
static Properties	getDefaultProperties()
GraphicsConfiguration	getDeviceConfiguration()
protected org.eclipse.swt.graphics.FontData	getFontData(Font font)
float	getFontHeight()	Gets the height of the current font.
FontMetrics	getFontMetrics()	KLighD uses SWT to estimate font sizes, hence we do the same when exporting svgs.
protected PrintWriter	getOutputStream()
protected String	getPath(PathIterator path)
protected static String	getPathContent(PathIterator path)
void	pushComment(Stack<String> stack, String s)
void	setBoundingBox()	Get the bounding box for this image.
static void	setDefaultProperties(Properties newProperties)
void	setNextTextLength(double textLength)
void	setPaintMode()
void	setWriteComments(boolean writeComments)
void	setXORMode(Color c1)
void	startGroup(KlighdSemanticDiagramData nextSemanticData)
protected String	textLength(Double nextLength)
String	toString()
void	writeBackground()
protected void	writeCap(int cap)
protected void	writeClip(Shape s)
void	writeComment(String s)
protected void	writeDash(float[] dash, float phase)
protected void	writeFont(Font font)
protected void	writeGraphicsRestore()
protected void	writeGraphicsSave()
void	writeHeader()	Write out the header of this SVG file.
protected void	writeImage(RenderedImage image, AffineTransform xform, Color bkg)
protected void	writeJoin(int join)
protected void	writeMiterLimit(float limit)
protected void	writePaint(Color c)
protected void	writePaint(GradientPaint paint)
protected void	writePaint(Paint p)
protected void	writePaint(TexturePaint paint)
protected void	writeSetClip(Shape s)
protected void	writeSetTransform(AffineTransform transform)
protected void	writeString(String str, double x, double y)
void	writeTrailer()	Writes the font definitions and calls writeGraphicsRestore() to close all open XML Tags
protected void	writeTransform(AffineTransform transform)
protected void	writeWidth(float width)

Methods inherited from class org.freehep.graphicsio.AbstractVectorGraphicsIO

addRenderingHints, clearRect, clip, clipRect, clipRect, createShape, drawGlyphVector, drawImage, drawImage, drawImage, drawImage, drawImage, drawImage, drawImage, drawImage, drawRenderableImage, drawRenderedImage, 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, fillAndDraw, 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, 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, hitClip

Methods inherited from class java.lang.Object

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

Field Details

VERSION_1_1

public static final String VERSION_1_1

See Also:

• Constant Field Values

TRANSPARENT

public static final String TRANSPARENT

BACKGROUND

public static final String BACKGROUND

BACKGROUND_COLOR

public static final String BACKGROUND_COLOR

VERSION

public static final String VERSION

COMPRESS

public static final String COMPRESS

STYLABLE

public static final String STYLABLE

use style="font-size:20" instaed of font-size="20" see style(java.util.Properties) for details

IMAGE_SIZE

public static final String IMAGE_SIZE

EXPORT_IMAGES

public static final String EXPORT_IMAGES

EXPORT_SUFFIX

public static final String EXPORT_SUFFIX

WRITE_IMAGES_AS

public static final String WRITE_IMAGES_AS

FOR

public static final String FOR

TITLE

public static final String TITLE

EMBED_FONTS

public static final String EMBED_FONTS

DESCRIPTION

public static final String DESCRIPTION

ADDITIONAL_ROOT_DATA

public static final String ADDITIONAL_ROOT_DATA

CSS

public static final String CSS

version

public static final String version

See Also:

• Constant Field Values

Constructor Details

SemanticSVGGraphics2D

public SemanticSVGGraphics2D(File file,
 Dimension size)
                      throws IOException

Throws:

IOException

SemanticSVGGraphics2D

public SemanticSVGGraphics2D(File file,
 Component component)
                      throws IOException

Throws:

IOException

SemanticSVGGraphics2D

public SemanticSVGGraphics2D(OutputStream os,
 Dimension size)

SemanticSVGGraphics2D

public SemanticSVGGraphics2D(OutputStream os,
 Component component)

SemanticSVGGraphics2D

protected SemanticSVGGraphics2D(SemanticSVGGraphics2D graphics,
 boolean doRestoreOnDispose)

Method Details

getDefaultProperties

public static Properties getDefaultProperties()

setDefaultProperties

public static void setDefaultProperties(Properties newProperties)

getAdjustedFontHeight

protected float getAdjustedFontHeight()

dispose

public void dispose()

Overrides:

dispose in class org.freehep.graphicsio.AbstractVectorGraphicsIO

setBoundingBox

public void setBoundingBox()

Get the bounding box for this image.

setWriteComments

public void setWriteComments(boolean writeComments)

Parameters:

writeComments - the writeComments to set

writeHeader

public void writeHeader()
                 throws IOException

Write out the header of this SVG file.

Specified by:

writeHeader in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeBackground

public void writeBackground()
                     throws IOException

Specified by:

writeBackground in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeTrailer

public void writeTrailer()
                  throws IOException

Writes the font definitions and calls writeGraphicsRestore() to close all open XML Tags

Specified by:

writeTrailer in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

closeStream

public void closeStream()
                 throws IOException

Specified by:

closeStream in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

create

public Graphics create()

Specified by:

create in class org.freehep.graphics2d.VectorGraphics

create

public Graphics create(double x,
 double y,
 double width,
 double height)

Specified by:

create in class org.freehep.graphics2d.VectorGraphics

writeGraphicsSave

protected void writeGraphicsSave()
                          throws IOException

Specified by:

writeGraphicsSave in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeGraphicsRestore

protected void writeGraphicsRestore()
                             throws IOException

Specified by:

writeGraphicsRestore in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

draw

public void draw(Shape shape)

Draws the shape using the current paint as border

Specified by:

draw in class org.freehep.graphics2d.VectorGraphics

Parameters:

shape - Shape to draw

fill

public void fill(Shape shape)

Fills the shape without a border using the current paint

Specified by:

fill in class org.freehep.graphics2d.VectorGraphics

Parameters:

shape - Shape to be filled with the current paint

copyArea

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

Specified by:

copyArea in class org.freehep.graphics2d.VectorGraphics

writeImage

protected void writeImage(RenderedImage image,
 AffineTransform xform,
 Color bkg)
                   throws IOException

Specified by:

writeImage in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

setNextTextLength

public void setNextTextLength(double textLength)

drawString

public void drawString(String string,
 double x,
 double y)

Copied from AbstractVectorGraphicsIO to change the handling of text as shapes. Draws the string at (x, y). If TEXT_AS_SHAPES is set AbstractVectorGraphicsIO.drawGlyphVector(java.awt.font.GlyphVector, float, float) is used, otherwise writeString(String, double, double) for a more direct output of the string.

Overrides:

drawString in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Parameters:

string -

x -

y -

writeString

protected void writeString(String str,
 double x,
 double y)
                    throws IOException

Specified by:

writeString in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

getAdjustedFontHeight

protected float getAdjustedFontHeight(int height,
 int ascent,
 int descent,
 boolean firstLine)

textLength

protected String textLength(Double nextLength)

getFontMetrics

public FontMetrics getFontMetrics()

KLighD uses SWT to estimate font sizes, hence we do the same when exporting svgs.

Overrides:

getFontMetrics in class Graphics

getFontHeight

public float getFontHeight()

Gets the height of the current font.

Returns:

The current font height.

writeTransform

protected void writeTransform(AffineTransform transform)
                       throws IOException

Specified by:

writeTransform in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeSetTransform

protected void writeSetTransform(AffineTransform transform)
                          throws IOException

Overrides:

writeSetTransform in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeClip

protected void writeClip(Shape s)
                  throws IOException

Specified by:

writeClip in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeSetClip

protected void writeSetClip(Shape s)
                     throws IOException

Specified by:

writeSetClip in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeWidth

protected void writeWidth(float width)
                   throws IOException

Overrides:

writeWidth in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeCap

protected void writeCap(int cap)
                 throws IOException

Overrides:

writeCap in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeJoin

protected void writeJoin(int join)
                  throws IOException

Overrides:

writeJoin in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeMiterLimit

protected void writeMiterLimit(float limit)
                        throws IOException

Overrides:

writeMiterLimit in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeDash

protected void writeDash(float[] dash,
 float phase)
                  throws IOException

Overrides:

writeDash in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

setPaintMode

public void setPaintMode()

Specified by:

setPaintMode in class org.freehep.graphics2d.VectorGraphics

setXORMode

public void setXORMode(Color c1)

Specified by:

setXORMode in class org.freehep.graphics2d.VectorGraphics

writePaint

protected void writePaint(Color c)
                   throws IOException

Specified by:

writePaint in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writePaint

protected void writePaint(GradientPaint paint)
                   throws IOException

Specified by:

writePaint in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writePaint

protected void writePaint(TexturePaint paint)
                   throws IOException

Specified by:

writePaint in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writePaint

protected void writePaint(Paint p)
                   throws IOException

Specified by:

writePaint in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

writeFont

protected void writeFont(Font font)
                  throws IOException

Specified by:

writeFont in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

getDeviceConfiguration

public GraphicsConfiguration getDeviceConfiguration()

Specified by:

getDeviceConfiguration in class org.freehep.graphics2d.VectorGraphics

writeComment

public void writeComment(String s)
                  throws IOException

Specified by:

writeComment in class org.freehep.graphicsio.AbstractVectorGraphicsIO

Throws:

IOException

pushComment

public void pushComment(Stack<String> stack,
 String s)

toString

public String toString()

Specified by:

toString in class org.freehep.graphics2d.VectorGraphics

getPathContent

protected static String getPathContent(PathIterator path)

getPath

protected String getPath(PathIterator path)

addSemanticData

public void addSemanticData(KlighdSemanticDiagramData nextSemanticData)

startGroup

public void startGroup(KlighdSemanticDiagramData nextSemanticData)

endGroup

public void endGroup()

createAWTPath

public static Path2D createAWTPath(org.eclipse.swt.graphics.PathData pathData)

Builds up a AWT Path2D according to a given SWT Geometry PathData.

Parameters:

pathData - provides the segments the new path shall contain. the device to create the path on

Returns:

the desired Path2D object.

getFontData

protected org.eclipse.swt.graphics.FontData getFontData(Font font)

fixedPrecision

public static String fixedPrecision(double d)

converts the double value to a representing string

Parameters:

d - double value to convert

Returns:

same as string

getOutputStream

protected PrintWriter getOutputStream()