Package com.storedobject.svg

Class Canvas

java.lang.Object

com.storedobject.svg.Node<Group>

com.storedobject.svg.Element<Group>

com.storedobject.svg.AbstractGroup<Group>

com.storedobject.svg.Group

com.storedobject.svg.Canvas

All Implemented Interfaces:

Serializable

public final class Canvas
extends Group

A canvas for drawing nodes. It can contain multiple Node objects.

Author:

Syam

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.storedobject.svg.AbstractGroup

children

Fields inherited from class com.storedobject.svg.Element

styles, tag

Fields inherited from class com.storedobject.svg.Node

NUMERIC_PRECISION, x1, x2, y1, y2

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected String	attributes()	Retrieves a string representation of the node's attributes.
Canvas	clip(Element clip)	Add a clip element.
protected String	extraContent()	Provides additional content specific to the node.
void	removeClip(Element clip)	Remove a clip element.
Canvas	size(double width, double height)	Set the size.

Methods inherited from class com.storedobject.svg.Group

add, add, clear, getChildAt, remove

Methods inherited from class com.storedobject.svg.AbstractGroup

children, compute, innerContent

Methods inherited from class com.storedobject.svg.Element

getStyles, styles, tag

Methods inherited from class com.storedobject.svg.Node

copy, createDocument, equals, escapeXml, flipHorizontally, flipHorizontallyAroundOrigin, flipVertically, flipVerticallyAroundOrigin, getCoordinates, getId, getMargin, getSvg, hashCode, id, ID, IDValue, moveTo, moveTo, rotate, rotateAround, rotateAround, rotateAroundCenter, scale, scale, scaleHeightTo, scaleTo, scaleWidthTo, toString, toString, transform, translate, translate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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.

extraContent

protected String extraContent()

Description copied from class: Node

Provides additional content specific to the node. This method is intended to be overridden by subclasses to define custom extra content specific to their implementation. By default, it returns null if no additional content is defined.

Note: The extra content should be formatted as per SVG standards with appropriate tags. No validation is performed on the extra content.

Overrides:

extraContent in class Node<Group>

Returns:

A string representing the extra content of the node, or null if no extra content is defined.

attributes

protected String attributes()

Description copied from class: Node

Retrieves a string representation of the node's attributes. This method is typically overridden by subclasses to provide specific attributes corresponding to the node's state or properties. By default, this method returns null if no attributes are defined.

Overrides:

attributes in class Node<Group>

Returns:

A string representing the attributes of the node, or null if no attributes are defined.