org.apache.batik.svggen
public class SVGGraphics2D extends AbstractGraphics2D implements Cloneable, SVGSyntax, ErrorConstants
See Also: GraphicContext DOMTreeManager DOMGroupManager ImageHandler ExtensionHandler org.w3c.dom.Document
Field Summary | |
---|---|
protected DOMGroupManager | domGroupManager
The DOMGroupManager manages additions to the current group
node associated for this Graphics2D object. |
protected DOMTreeManager | domTreeManager
The DOMTreeManager manages the process of creating
and growing the SVG tree. |
static int | DEFAULT_MAX_GC_OVERRIDES
Controls the policy for grouping nodes. |
static String | DEFAULT_XML_ENCODING |
protected Graphics2D | fmg
Used to create proper font metrics |
protected SVGGeneratorContext | generatorCtx
Contains some information for SVG generation. |
protected SVGShape | shapeConverter
Used to convert Java 2D API Shape objects to equivalent SVG
elements |
protected Dimension | svgCanvasSize
SVG Canvas size |
protected Set | unsupportedAttributes |
Constructor Summary | |
---|---|
SVGGraphics2D(Document domFactory) | |
SVGGraphics2D(Document domFactory, ImageHandler imageHandler, ExtensionHandler extensionHandler, boolean textAsShapes) | |
SVGGraphics2D(SVGGeneratorContext generatorCtx, boolean textAsShapes)
Creates a new SVGGraphics2D object. | |
SVGGraphics2D(SVGGraphics2D g)
This constructor is used in create()
|
Method Summary | |
---|---|
static SVGGeneratorContext | buildSVGGeneratorContext(Document domFactory, ImageHandler imageHandler, ExtensionHandler extensionHandler)
Helper method to create an SVGGeneratorContext from the
constructor parameters. |
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 . |
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 | draw(Shape s)
Strokes the outline of a Shape using the settings of the
current Graphics2D context. |
boolean | drawImage(Image img, int x, int y, ImageObserver observer)
Draws as much of the specified image as is currently available.
|
boolean | drawImage(Image img, int x, int y, int width, int height, ImageObserver observer)
Draws as much of the specified image as has already been scaled
to fit inside the specified rectangle.
|
boolean | drawImage(Image img, AffineTransform xform, ImageObserver obs)
Renders an image, applying a transform from image space into user space
before drawing.
|
void | drawImage(BufferedImage img, BufferedImageOp op, int x, int y)
Renders a BufferedImage that is
filtered with a
BufferedImageOp.
|
void | drawRenderableImage(RenderableImage img, AffineTransform trans2)
Renders a
RenderableImage,
applying a transform from image space into user space before drawing.
|
void | drawRenderedImage(RenderedImage img, AffineTransform trans2)
Renders a RenderedImage,
applying a transform from image
space into user space before drawing.
|
void | drawString(String s, float x, float y)
Renders the text specified by the specified String ,
using the current Font and Paint attributes
in the Graphics2D context.
|
void | drawString(AttributedCharacterIterator ati, float x, float y)
Renders the text of the specified iterator, using the
Graphics2D context's current Paint . |
void | fill(Shape s)
Fills the interior of a Shape using the settings of the
Graphics2D context. |
List | getDefinitionSet()
Invoking this method will return a set of definition element that
contain all the definitions referenced by the attributes generated by
the various converters. |
GraphicsConfiguration | getDeviceConfiguration()
Returns the device configuration associated with this
Graphics2D . |
Document | getDOMFactory() |
protected DOMGroupManager | getDOMGroupManager() |
DOMTreeManager | getDOMTreeManager() |
ExtensionHandler | getExtensionHandler() |
FontMetrics | getFontMetrics(Font f)
Gets the font metrics for the specified font. |
SVGGeneratorContext | getGeneratorContext() |
GenericImageHandler | getGenericImageHandler() |
ImageHandler | getImageHandler() |
Element | getRoot() |
Element | getRoot(Element svgRoot)
This version of the getRoot method will append the input svgRoot
and set its attributes.
|
SVGShape | getShapeConverter() |
Dimension | getSVGCanvasSize() |
Element | getTopLevelGroup()
Invoking this method will return a reference to the topLevelGroup
Element managed by this object. |
Element | getTopLevelGroup(boolean includeDefinitionSet)
Invoking this method will return a reference to the topLevelGroup
Element managed by this object. |
protected void | setDOMGroupManager(DOMGroupManager groupMgr)
Set a new DOM Group manager for this SVGGraphics2D. |
protected void | setDOMTreeManager(DOMTreeManager treeMgr)
Set a DOM Tree manager for the SVGGraphics2D. |
void | setExtensionHandler(ExtensionHandler extensionHandler) |
protected void | setGeneratorContext(SVGGeneratorContext generatorCtx)
Sets an non null SVGGeneratorContext . |
void | setSVGCanvasSize(Dimension svgCanvasSize)
Set the Canvas size, this is used to set the width and
height attributes on the outermost 'svg' element. |
void | setTopLevelGroup(Element topLevelGroup)
Sets the topLevelGroup to the input element. |
void | setUnsupportedAttributes(Set attrs)
This method let's users indicate that they don't care that
certain text attributes will not be properly converted to
SVG, in exchange when those attributes are used they will
get real SVG text instead of paths.
|
void | setXORMode(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 | stream(String svgFileName) |
void | stream(String svgFileName, boolean useCss) |
void | stream(Writer writer) |
void | stream(Writer writer, boolean useCss, boolean escaped) |
void | stream(Writer writer, boolean useCss) |
void | stream(Element svgRoot, Writer writer) |
void | stream(Element svgRoot, Writer writer, boolean useCss, boolean escaped) |
boolean | usesUnsupportedAttributes(AttributedCharacterIterator aci) |
See Also: DOMTreeManager
Parameters: domFactory Factory which will produce Elements for the DOM tree this Graphics2D generates.
Throws: SVGGraphics2DRuntimeException if domFactory is null.
Parameters: domFactory Factory which will produce Elements for the DOM tree this Graphics2D generates. imageHandler defines how images are referenced in the generated SVG fragment extensionHandler defines how Java 2D API extensions map to SVG Nodes. textAsShapes if true, all text is turned into SVG shapes in the convertion. No SVG text is output.
Throws: SVGGraphics2DRuntimeException if domFactory is null.
Parameters: generatorCtx the SVGGeneratorContext
instance
that will provide all useful information to the generator. textAsShapes if true, all text is turned into SVG shapes in the
convertion. No SVG text is output.
Throws: SVGGraphics2DRuntimeException if generatorContext is null.
See Also: SVGGraphics2D
dx
and dy
. From the point specified
by x
and y
, this method
copies downwards and to the right. To copy an area of the
component to the left or upwards, specify a negative value for
dx
or dy
.
If a portion of the source rectangle lies outside the bounds
of the component, or is obscured by another window or component,
copyArea
will be unable to copy the associated
pixels. The area that is omitted can be refreshed by calling
the component's paint
method.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.
Graphics
object that is
a copy of this Graphics
object.Returns: a new graphics context that is a copy of this graphics context.
Graphics
object cannot be used after
dispose
has been called.
When a Java program runs, a large number of Graphics
objects can be created within a short time frame.
Although the finalization process of the garbage collector
also disposes of the same system resources, it is preferable
to manually free the associated resources by calling this
method rather than to rely on a finalization process which
may not run to completion for a long period of time.
Graphics objects which are provided as arguments to the
paint
and update
methods
of components are automatically released by the system when
those methods return. For efficiency, programmers should
call dispose
when finished using
a Graphics
object only if it was created
directly from a component or another Graphics
object.
See Also: java.awt.Graphics#finalize java.awt.Component#paint java.awt.Component#update java.awt.Component#getGraphics java.awt.Graphics#create()
Shape
using the settings of the
current Graphics2D
context. The rendering attributes
applied include the Clip
, Transform
,
Paint
, Composite
and
Stroke
attributes.Parameters: s the Shape
to be rendered
See Also: SVGGraphics2D SVGGraphics2D java.awt.Graphics#setColor SVGGraphics2D SVGGraphics2D SVGGraphics2D
This method returns immediately in all cases, even if the complete image has not yet been loaded, and it has not been dithered and converted for the current output device.
If the image has not yet been completely loaded, then
drawImage
returns false
. As more of
the image becomes available, the process that draws the image notifies
the specified image observer.
Parameters: img the specified image to be drawn. x the x coordinate. y the y coordinate. observer object to be notified as more of the image is converted.
See Also: java.awt.Image java.awt.image.ImageObserver java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
The image is drawn inside the specified rectangle of this graphics context's coordinate space, and is scaled if necessary. Transparent pixels do not affect whatever pixels are already there.
This method returns immediately in all cases, even if the
entire image has not yet been scaled, dithered, and converted
for the current output device.
If the current output representation is not yet complete, then
drawImage
returns false
. As more of
the image becomes available, the process that draws the image notifies
the image observer by calling its imageUpdate
method.
A scaled version of an image will not necessarily be available immediately just because an unscaled version of the image has been constructed for this output device. Each size of the image may be cached separately and generated from the original data in a separate image production sequence.
Parameters: img the specified image to be drawn. 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.
See Also: java.awt.Image java.awt.image.ImageObserver java.awt.image.ImageObserver#imageUpdate(java.awt.Image, int, int, int, int, int)
Transform
in the Graphics2D
.
The specified transformation is applied to the image before the
transform attribute in the Graphics2D
context is applied.
The rendering attributes applied include the Clip
,
Transform
, and Composite
attributes.
Note that no rendering is done if the specified transform is
noninvertible.Parameters: img the Image
to be rendered xform the transformation from image space into user space obs the ImageObserver
to be notified as more of the Image
is converted
Returns: true
if the Image
is
fully loaded and completely rendered;
false
if the Image
is still being loaded.
See Also: SVGGraphics2D SVGGraphics2D SVGGraphics2D
BufferedImage
that is
filtered with a
BufferedImageOp.
The rendering attributes applied include the Clip
,
Transform
and Composite
attributes. This is equivalent to:
img1 = op.filter(img, null); drawImage(img1, new AffineTransform(1f,0f,0f,1f,x,y), null);
Parameters: op the filter to be applied to the image before rendering img the BufferedImage
to be rendered x the x coordinate in user space where the upper left
corner of the image is rendered y the y coordinate in user space where the upper left
corner of the image is rendered
See Also: SVGGraphics2D SVGGraphics2D SVGGraphics2D
Transform
in the Graphics2D
.
The specified transformation is applied to the image before the
transform attribute in the Graphics2D
context is applied.
The rendering attributes applied include the Clip
,
Transform
, and Composite
attributes. Note
that no rendering is done if the specified transform is
noninvertible.
Rendering hints set on the Graphics2D
object might
be used in rendering the RenderableImage
.
If explicit control is required over specific hints recognized by a
specific RenderableImage
, or if knowledge of which hints
are used is required, then a RenderedImage
should be
obtained directly from the RenderableImage
and rendered using
SVGGraphics2D.
Parameters: img the image to be rendered trans2 the transformation from image space into user space
See Also: SVGGraphics2D SVGGraphics2D SVGGraphics2D SVGGraphics2D
Transform
in the Graphics2D
.
The specified transformation is applied to the image before the
transform attribute in the Graphics2D
context is applied.
The rendering attributes applied include the Clip
,
Transform
, and Composite
attributes. Note
that no rendering is done if the specified transform is
noninvertible.Parameters: img the image to be rendered trans2 the transformation from image space into user space
See Also: SVGGraphics2D SVGGraphics2D SVGGraphics2D
String
,
using the current Font
and Paint
attributes
in the Graphics2D
context.
The baseline of the first character is at position
(x, y) in the User Space.
The rendering attributes applied include the Clip
,
Transform
, Paint
, Font
and
Composite
attributes. For characters in script systems
such as Hebrew and Arabic, the glyphs can be rendered from right to
left, in which case the coordinate supplied is the location of the
leftmost character on the baseline.Parameters: s the String
to be rendered x the x coordinate where the String
should be rendered y the y coordinate where the String
should be rendered
See Also: SVGGraphics2D java.awt.Graphics#setColor java.awt.Graphics#setFont SVGGraphics2D SVGGraphics2D SVGGraphics2D
Graphics2D
context's current Paint
. The
iterator must specify a font
for each character. The baseline of the
first character is at position (x, y) in the
User Space.
The rendering attributes applied include the Clip
,
Transform
, Paint
, and
Composite
attributes.
For characters in script systems such as Hebrew and Arabic,
the glyphs can be rendered from right to left, in which case the
coordinate supplied is the location of the leftmost character
on the baseline.Parameters: ati the iterator whose text is to be rendered x the x coordinate where the iterator's text is to be rendered y the y coordinate where the iterator's text is to be rendered
See Also: SVGGraphics2D java.awt.Graphics#setColor SVGGraphics2D SVGGraphics2D SVGGraphics2D
Shape
using the settings of the
Graphics2D
context. The rendering attributes applied
include the Clip
, Transform
,
Paint
, and Composite
.Parameters: s the Shape
to be filled
See Also: SVGGraphics2D java.awt.Graphics#setColor SVGGraphics2D SVGGraphics2D SVGGraphics2D
Graphics2D
.Returns: the Document used as a DOM object factory by this SVGGraphics2D instance
Returns: the DOMGroupManager used by this SVGGraphics2D instance
Returns: the DOMTreeManager used by this SVGGraphics2D instance
Returns: the extension handler used by this SVGGraphics2D instance
Parameters: f the specified font
Returns: the font metrics for the specified font.
See Also: java.awt.Graphics#getFont java.awt.FontMetrics java.awt.Graphics#getFontMetrics()
Returns: the SVGGeneratorContext used by this SVGGraphics2D instance.
Returns: the GenericImageHandler used by this SVGGraphics2D instance
Returns: the ImageHandler used by this SVGGraphics2D instance
Returns: the svg root node of the SVG document associated with this object
Parameters: svgRoot an SVG element underwhich the content should be appended.
Returns: the svg root node of the SVG document associated with this object.
Returns: the SVGShape used by this SVGGraphics2D instance to turn Java2D shapes into SVG Shape objects.
Returns: SVG Canvas size, as set in the root svg element
Returns: top level group
Parameters: includeDefinitionSet if true, the definition set is included and the converters are reset (i.e., they start with an empty set of definitions).
Returns: top level group
Parameters: groupMgr the new DOM Group manager this SVGGraphics2D should use
Parameters: treeMgr the new DOM Tree manager this SVGGraphics2D should use
Parameters: extensionHandler new extension handler this SVGGraphics2D should use
SVGGeneratorContext
.Parameters: svgCanvasSize SVG Canvas size. May be null (equivalent to 100%, 100%)
Parameters: attrs The set of attrs to treat as unsupported, and if present cause text to be drawn as paths. If null ACI text will be rendered as text (unless 'textAsShapes' is set).
When drawing operations are performed, pixels which are the current color are changed to the specified color, and vice versa.
Pixels that are of colors other than those two colors are changed in an unpredictable but reversible manner; if the same figure is drawn twice, then all pixels are restored to their original values.
Parameters: c1 the XOR alternation color
Parameters: svgFileName name of the file where SVG content should be written
Parameters: svgFileName name of the file where SVG content should be written useCss defines whether the output SVG should use CSS style properties as opposed to plain attributes.
Parameters: writer used to writer out the SVG content
Parameters: writer used to writer out the SVG content useCss defines whether the output SVG should use CSS escaped defines if the characters will be escaped style properties as opposed to plain attributes.
Parameters: writer used to writer out the SVG content useCss defines whether the output SVG should use CSS style properties as opposed to plain attributes.
Parameters: svgRoot root element to stream out
Parameters: svgRoot root element to stream out writer output useCss defines whether the output SVG should use CSS style escaped defines if the characters will be escaped properties as opposed to plain attributes.