Package com.storedobject.svg

Class Svg

java.lang.Object

com.storedobject.svg.Svg

Direct Known Subclasses:

Canvas, Chart, Element, TransformedSvg

public abstract class Svg
extends Object

Base class for all SVG objects.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Svg.Anchor	Transformer for anchoring an SVG to another one.
static class	Svg.Margin	Transformer for adding margins.
static class	Svg.Mover	Transformer for moving an SVG.
static class	Svg.Scale	Transformer for scaling by factors.
static class	Svg.ScaleTo	Transformer for scaling to a specific size.

Field Summary

Fields

Modifier and Type	Field	Description
protected double	height	Default size of the SVG.
protected String	svg	SVG content.
protected double	width	Default size of the SVG.
protected double	x	Current x and y coordinates.
protected double	y	Current x and y coordinates.

Constructor Summary

Constructors

Constructor	Description
Svg()	Default constructor for the Svg class.

Method Summary

Modifier and Type	Method	Description
Svg	add(Svg svg, double dx, double dy)	Add another SVG at a specific displacement.
Svg	add(Svg svg, Point at)	Add another SVG at a specific point.
Svg	add(Svg svg, Side side)	Add another SVG to this one at a specified side.
abstract void	build()	Build the SVG.
static String	escapeXml(String text)	Escape XML special characters in a string.
Svg	flipHorizontally()	Flip this SVG horizontally.
Svg	flipVertically()	Flip this SVG vertically.
final String	getFilledSvg()	Get the SVG output that fills its container (100% width and height).
final double	getHeight()	Returns the height of the SVG.
final String	getScaledSvg(double scaleWidthPercentage, double scaleHeightPercentage)	Get the SVG output with specified scale percentages for width and height.
final String	getSvg()	Get the SVG output using its default dimensions.
final double	getWidth()	Returns the width of the SVG.
final double	getX()	Returns the X coordinate.
final double	getY()	Returns the Y coordinate.
abstract boolean	isBuilt()	Check if the chart is built.
Svg	margin(double margin)	Add a margin to this SVG.
Svg	margin(double margin, Side side)	Add a margin to this SVG on a specific side.
Svg	scale(double scale)	Scale this SVG by a specified factor.
Svg	scale(double scaleX, double scaleY)	Scale this SVG by specified factors.
Svg	scaleTo(double newWidth, double newHeight)	Scale this SVG to new dimensions.
Svg	scaleToHeight(double newHeight)	Scale this SVG to a new height.
Svg	scaleToWidth(double newWidth)	Scale this SVG to a new width.
static String	toString(double v, int decimals)	Convert a double to string with specified decimal places and remove trailing zeros.

Methods inherited from class java.lang.Object

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

Field Details

svg

protected String svg

SVG content. This is typically set by the build() method. It should not contain the top level svg tag.

x

protected double x

Current x and y coordinates. These could be set to any value so that the final SVG output will be translated.

y

protected double y

Current x and y coordinates. These could be set to any value so that the final SVG output will be translated.

width

protected double width

Default size of the SVG. This could be set to any value so that the final SVG output will compute the view box using these values and the values of x and y.

height

protected double height

Default size of the SVG. This could be set to any value so that the final SVG output will compute the view box using these values and the values of x and y.

Constructor Details

Svg

public Svg()

Default constructor for the Svg class. Initializes a new instance of the SVG object with default properties.

Method Details

build

public abstract void build()

Build the SVG. This method is called before getting the SVG output.

isBuilt

public abstract boolean isBuilt()

Check if the chart is built.

Returns:

True if built.

getSvg

public final String getSvg()

Get the SVG output using its default dimensions.

Returns:

SVG string.

getFilledSvg

public final String getFilledSvg()

Get the SVG output that fills its container (100% width and height).

Returns:

SVG string.

getScaledSvg

public final String getScaledSvg(double scaleWidthPercentage,
 double scaleHeightPercentage)

Get the SVG output with specified scale percentages for width and height.

Parameters:

scaleWidthPercentage - Scale percentage for width (0 to 100).

scaleHeightPercentage - Scale percentage for height (0 to 100).

Returns:

SVG string.

toString

public static String toString(double v,
 int decimals)

Convert a double to string with specified decimal places and remove trailing zeros.

Parameters:

v - Value.

decimals - Number of decimal places.

Returns:

Formatted string.

escapeXml

public static String escapeXml(String text)

Escape XML special characters in a string.

Parameters:

text - Text to escape.

Returns:

Escaped string.

getWidth

public final double getWidth()

Returns the width of the SVG. This is the same as the view box width if x and y are 0.

Returns:

The width of the SVG.

getHeight

public final double getHeight()

Returns the height of the SVG. This is the same as the view box height if x and y are 0.

Returns:

The height of the SVG.

getX

public final double getX()

Returns the X coordinate.

Returns:

The X coordinate.

getY

public final double getY()

Returns the Y coordinate.

Returns:

The Y coordinate.

margin

public Svg margin(double margin)

Add a margin to this SVG.

Parameters:

margin - Margin value.

Returns:

A new Svg with the margin added.

margin

public Svg margin(double margin,
 Side side)

Add a margin to this SVG on a specific side.

Parameters:

margin - Margin value.

side - Side on which to add the margin.

Returns:

A new Svg with the margin added.

add

public Svg add(Svg svg,
 Side side)

Add another SVG to this one at a specified side.

Parameters:

svg - SVG to add.

side - Side where the SVG should be added.

Returns:

A new Svg containing both.

add

public Svg add(Svg svg,
 Point at)

Add another SVG at a specific point.

Parameters:

svg - SVG to add.

at - Point where the SVG should be added.

Returns:

A new Svg containing both.

add

public Svg add(Svg svg,
 double dx,
 double dy)

Add another SVG at a specific displacement.

Parameters:

svg - SVG to add.

dx - X displacement.

dy - Y displacement.

Returns:

A new Svg containing both.

scaleToWidth

public Svg scaleToWidth(double newWidth)

Scale this SVG to a new width.

Parameters:

newWidth - New width.

Returns:

A new Svg scaled to the new width.

scaleToHeight

public Svg scaleToHeight(double newHeight)

Scale this SVG to a new height.

Parameters:

newHeight - New height.

Returns:

A new Svg scaled to the new height.

scaleTo

public Svg scaleTo(double newWidth,
 double newHeight)

Scale this SVG to new dimensions.

Parameters:

newWidth - New width.

newHeight - New height.

Returns:

A new Svg scaled to the new dimensions.

scale

public Svg scale(double scaleX,
 double scaleY)

Scale this SVG by specified factors.

Parameters:

scaleX - X scale factor.

scaleY - Y scale factor.

Returns:

A new Svg scaled.

scale

public Svg scale(double scale)

Scale this SVG by a specified factor.

Parameters:

scale - Scale factor.

Returns:

A new Svg scaled.

flipHorizontally

public Svg flipHorizontally()

Flip this SVG horizontally.

Returns:

A new Svg flipped horizontally.

flipVertically

public Svg flipVertically()

Flip this SVG vertically.

Returns:

A new Svg flipped vertically.