Overview Package Class Use Tree Index Deprecated About
fop 0.94
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.fop.svg

Class SVGUtilities

public class SVGUtilities
extends java.lang.Object
Some utilities for creating svg DOM documents and elements.

Method Summary

static Element
createClip(Document doc, Element els, String id)
Create an SVG Clip.
static Element
createEllipse(Document doc, float cx, float cy, float rx, float ry)
Create an SVG Ellipse
static Element
createG(Document doc)
Create an SVG G.
static Element
createImage(Document doc, String ref, float width, float height)
Create and svg image element.
static Element
createLine(Document doc, float x, float y, float x2, float y2)
Create an SVG Line
static Element
createPath(Document doc, String str)
Create an SVG Path.
static Element
createRect(Document doc, float x, float y, float width, float height)
Create an SVG Rectangle.
static Document
createSVGDocument(float width, float height)
Create a new svg document with batik.
static Element
createText(Document doc, float x, float y, String str)
Create an SVG Text object.
static Rectangle2D
getStringBounds(String str, java.awt.Font font)
Get the string bounds for a particular string given the font.
static float
getStringHeight(String str, java.awt.Font font)
Get the string height for a particular string given the font.
static float
getStringWidth(String str, java.awt.Font font)
Get the string width for a particular string given the font.
static Element
wrapText(Document doc, String str, java.awt.Font font, float width)
Create some SVG text that is wrapped into a specified width.

Method Details

createClip

public static final Element createClip(Document doc,
                                       Element els,
                                       String id)
Create an SVG Clip.
Parameters:
doc - the document to create the element
els - the child elements that make the clip
id - the id of the clipping path
Returns:
the new clip element

createEllipse

public static final Element createEllipse(Document doc,
                                          float cx,
                                          float cy,
                                          float rx,
                                          float ry)
Create an SVG Ellipse
Parameters:
doc - the document to create the element
cx - the centre x position
cy - the centre y position
rx - the x axis radius
ry - the y axis radius
Returns:
the new ellipse element

createG

public static final Element createG(Document doc)
Create an SVG G.
Parameters:
doc - the document to create the element
Returns:
the new g element

createImage

public static final Element createImage(Document doc,
                                        String ref,
                                        float width,
                                        float height)
Create and svg image element.
Parameters:
doc - the document to create the element
ref - the href link to the image
width - the width to set on the image
height - the height to set on the image
Returns:
a new image element

createLine

public static final Element createLine(Document doc,
                                       float x,
                                       float y,
                                       float x2,
                                       float y2)
Create an SVG Line
Parameters:
doc - the document to create the element
x - the start x position
y - the start y position
x2 - the end x position
y2 - the end y position
Returns:
the new line element

createPath

public static final Element createPath(Document doc,
                                       String str)
Create an SVG Path.
Parameters:
doc - the document to create the element
str - the string for the d attribute on the path
Returns:
the new path element

createRect

public static final Element createRect(Document doc,
                                       float x,
                                       float y,
                                       float width,
                                       float height)
Create an SVG Rectangle.
Parameters:
doc - the document to create the element
x - the start x position
y - the start y position
width - the width of the rectangle
height - the height of the rectangle
Returns:
the new rectangle element

createSVGDocument

public static final Document createSVGDocument(float width,
                                               float height)
Create a new svg document with batik.
Parameters:
width - the width of the root svg element
height - the height of the root svg element
Returns:
a new SVG Document

createText

public static final Element createText(Document doc,
                                       float x,
                                       float y,
                                       String str)
Create an SVG Text object.
Parameters:
doc - the document to create the element
x - the start x position
y - the start y position
str - the string
Returns:
the new text element

getStringBounds

public static final Rectangle2D getStringBounds(String str,
                                                java.awt.Font font)
Get the string bounds for a particular string given the font.
Parameters:
str - the string
font - the font
Returns:
the bounds of the string

getStringHeight

public static final float getStringHeight(String str,
                                          java.awt.Font font)
Get the string height for a particular string given the font.
Parameters:
str - the string
font - the font
Returns:
the height of the string in the given font

getStringWidth

public static final float getStringWidth(String str,
                                         java.awt.Font font)
Get the string width for a particular string given the font.
Parameters:
str - the string
font - the font
Returns:
the width of the string in the given font

wrapText

public static final Element wrapText(Document doc,
                                     String str,
                                     java.awt.Font font,
                                     float width)
Create some SVG text that is wrapped into a specified width.
Parameters:
doc - the document to create the elements
str - the string to wrap
font - the font
width - the width to wrap
Returns:
the new element containing the wrapped text

Overview Package Class Use Tree Index Deprecated About
fop 0.94
Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.