Package com.storedobject.svg

Class Canvas

java.lang.Object

com.storedobject.svg.Svg

com.storedobject.svg.Canvas

public final class Canvas
extends Svg

A canvas for drawing SVGs. It can contain multiple Svg objects.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.svg.Svg

Svg.Anchor, Svg.Margin, Svg.Mover, Svg.Scale, Svg.ScaleTo

Field Summary

Fields inherited from class com.storedobject.svg.Svg

height, svg, width, x, y

Constructor Summary

Constructors

Constructor	Description
Canvas()	Constructor.
Canvas(double width, double height)	Constructor.

Method Summary

Modifier and Type	Method	Description
MovableSvg	add(Svg svg)	Add an SVG.
Canvas	autoSize()	Set the auto-size flag to true.
Canvas	autoSize(boolean autoSize)	Set the auto-size flag.
void	build()	Build the SVG.
Canvas	clip(Element clip)	Add a clip element.
boolean	isBuilt()	Check if the chart is built.
Svg	remove(Svg svg)	Remove an SVG.
void	removeClip(Element clip)	Remove a clip element.
Canvas	size(double width, double height)	Set the size.

Methods inherited from class com.storedobject.svg.Svg

add, add, add, escapeXml, flipHorizontally, flipVertically, getFilledSvg, getHeight, getScaledSvg, getSvg, getWidth, getX, getY, margin, margin, scale, scale, scaleTo, scaleToHeight, scaleToWidth, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Canvas

public Canvas()

Constructor.

Canvas

public Canvas(double width,
 double height)

Constructor.

Parameters:

width - Width.

height - Height.

Method Details

clip

public Canvas clip(Element clip)

Add a clip element.

Parameters:

clip - Clip element.

Returns:

Self.

removeClip

public void removeClip(Element clip)

Remove a clip element.

Parameters:

clip - Clip element.

size

public Canvas size(double width,
 double height)

Set the size.

Parameters:

width - Width.

height - Height.

Returns:

Self.

autoSize

public Canvas autoSize(boolean autoSize)

Set the auto-size flag.

Parameters:

autoSize - Auto-size flag.

Returns:

Self.

autoSize

public Canvas autoSize()

Set the auto-size flag to true.

Returns:

Self.

add

public MovableSvg add(Svg svg)

Add an SVG.

Parameters:

svg - SVG to add.

Returns:

The MovableSvg that wraps the added SVG.

remove

public Svg remove(Svg svg)

Remove an SVG.

Parameters:

svg - SVG to remove.

Returns:

The removed SVG (could be a MovableSvg).

build

public void build()

Description copied from class: Svg

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

Specified by:

build in class Svg

isBuilt

public boolean isBuilt()

Description copied from class: Svg

Check if the chart is built.

Specified by:

isBuilt in class Svg

Returns:

True if built.