Package com.storedobject.svg

Class Node

java.lang.Object

com.storedobject.svg.Node

Direct Known Subclasses:

Canvas, Chart, Element, TransformedNode

public abstract class Node
extends Object

Base class for all SVG objects. This represents a single visual unit or part of an SVG document. It has got its own size and origin, and can be independently translated and scaled. Many such node objects can be combined to form a larger visual composition.

Author:

Syam

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected String	svg	SVG content of the node.
protected double	x1	Current x and y coordinates of this node.
protected double	x2	Current x and y coordinates of this node.
protected double	y1	Current x and y coordinates of this node.
protected double	y2	Current x and y coordinates of this node.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Node	add(Node node, double dx, double dy)	Add another node at a specific displacement.
Node	add(Node node, Point at)	Add another node at a specific point.
Node	add(Node node, Side side)	Add another node to this one at a specified side.
abstract void	build()	Build the content.
final Document	createDocument()	Creates a new Document instance associated with the current Node.
DuplicatedNode	duplicate()	Creates and returns a duplicate of the current node instance.
final boolean	equals(Object obj)
static String	escapeXml(String text)	Escape XML special characters in a string.
Node	flipHorizontally()	Flip this node content horizontally.
Node	flipVertically()	Flip this node content vertically.
Coordinates	getCoordinates()	Retrieves the coordinates associated with this Node.
final double	getHeight()	Get the height of the bounding box.
final long	getId()	Retrieves the unique identifier of the node.
final String	getSvg()	Retrieves the SVG representation of the current Node.
final double	getWidth()	Get the width of the bounding box.
final double	getX1()	Get the X coordinate of the top-left corner of the bounding box.
final double	getX2()	Get the X coordinate of the bottom-right corner of the bounding box.
final double	getY1()	Get the Y coordinate of the top-left corner of the bounding box.
final double	getY2()	Get the Y coordinate of the bottom-right corner of the bounding box.
final int	hashCode()
static String	ID(long id)	Generates a unique string identifier for the given numerical ID.
static long	IDValue()	Generates a globally unique identifier in a thread-safe manner.
abstract boolean	isBuilt()	Check if the content is built.
Node	margin(double margin)	Add a margin to this content.
Node	margin(double topMargin, double rightMargin, double bottomMargin, double leftMargin)	Add a margin to this content.
Node	margin(double margin, Side side)	Add a margin to this SVG on a specific side.
MovableNode	moveTo(double x, double y)	Moves the current node to a new position specified by the given x and y coordinates.
MovableNode	moveTo(Point p)	Moves the current node to a new position specified by the given Point.
Node	scale(double scale)	Scale this node content by a specified factor.
Node	scale(double scaleX, double scaleY)	Scale this node content by specified factors.
Node	scaleTo(double newWidth, double newHeight)	Scale this node content to new dimensions.
Node	scaleToHeight(double newHeight)	Scale this node content to a new height.
Node	scaleToWidth(double newWidth)	Scale this node content to a new width.
String	toString()
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

svg

protected String svg

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

Note: It can contain one or more svg tags clubbed together to form a logical unit or visual part.

x1

protected double x1

Current x and y coordinates of this node. These values should be maintained by the subclasses, and these values determine the position, width, and height of the node. If the width and height ae zero, then no output is generated.

y1

protected double y1

Current x and y coordinates of this node. These values should be maintained by the subclasses, and these values determine the position, width, and height of the node. If the width and height ae zero, then no output is generated.

x2

protected double x2

Current x and y coordinates of this node. These values should be maintained by the subclasses, and these values determine the position, width, and height of the node. If the width and height ae zero, then no output is generated.

y2

protected double y2

Current x and y coordinates of this node. These values should be maintained by the subclasses, and these values determine the position, width, and height of the node. If the width and height ae zero, then no output is generated.

Constructor Details

Node

public Node()

Default constructor for the Node class. Initializes a new instance of the node object with default properties.

Method Details

build

public abstract void build()

Build the content. This method is called internally to get before getting the output.

getX1

public final double getX1()

Get the X coordinate of the top-left corner of the bounding box.

Returns:

X coordinate of the top-left corner.

getY1

public final double getY1()

Get the Y coordinate of the top-left corner of the bounding box.

Returns:

Y coordinate of the top-left corner.

getX2

public final double getX2()

Get the X coordinate of the bottom-right corner of the bounding box.

Returns:

X coordinate of the bottom-right corner.

getY2

public final double getY2()

Get the Y coordinate of the bottom-right corner of the bounding box.

Returns:

Y coordinate of the bottom-right corner.

getWidth

public final double getWidth()

Get the width of the bounding box.

Returns:

Width of the bounding box.

getHeight

public final double getHeight()

Get the height of the bounding box.

Returns:

Height of the bounding box.

isBuilt

public abstract boolean isBuilt()

Check if the content is built.

Returns:

True if built.

getId

public final long getId()

Retrieves the unique identifier of the node.

Returns:

The unique identifier as a long value.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

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.

IDValue

public static long IDValue()

Generates a globally unique identifier in a thread-safe manner. The method increments the current ID value atomically. If the ID value reaches Long.MAX_VALUE, it resets to 0 before incrementing.

Returns:

A unique identifier as a long value.

ID

public static String ID(long id)

Generates a unique string identifier for the given numerical ID.

Parameters:

id - The numerical ID to be converted into a string identifier.

Returns:

A string in the format "so-svg-" followed by the numerical ID.

getCoordinates

public Coordinates getCoordinates()

Retrieves the coordinates associated with this Node.

Returns:

A Coordinates object representing the bounding coordinates with properties (x1, y1, x2, y2).

margin

public Node margin(double margin)

Add a margin to this content.

Parameters:

margin - Margin value to be added to each side.

Returns:

A new Node with the margin added.

margin

public Node margin(double topMargin,
 double rightMargin,
 double bottomMargin,
 double leftMargin)

Add a margin to this content.

Parameters:

topMargin - Top margin value.

rightMargin - Right margin value.

bottomMargin - Bottom margin value.

leftMargin - Left margin value.

Returns:

A new Node with the margin added.

margin

public Node 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 Node with the margin added.

add

public Node add(Node node,
 Side side)

Add another node to this one at a specified side.

Parameters:

node - Node to add.

side - Side where the node should be added.

Returns:

A new Node containing both.

add

public Node add(Node node,
 Point at)

Add another node at a specific point.

Parameters:

node - Node to add.

at - Point where the node should be added.

Returns:

A new Node containing both.

add

public Node add(Node node,
 double dx,
 double dy)

Add another node at a specific displacement.

Parameters:

node - Node to add.

dx - X displacement.

dy - Y displacement.

Returns:

A new Node containing both.

scaleToWidth

public Node scaleToWidth(double newWidth)

Scale this node content to a new width.

Parameters:

newWidth - New width.

Returns:

A new Node scaled to the new width.

scaleToHeight

public Node scaleToHeight(double newHeight)

Scale this node content to a new height.

Parameters:

newHeight - New height.

Returns:

A new Node scaled to the new height.

scaleTo

public Node scaleTo(double newWidth,
 double newHeight)

Scale this node content to new dimensions.

Parameters:

newWidth - New width.

newHeight - New height.

Returns:

A new Node scaled to the new dimensions.

scale

public Node scale(double scaleX,
 double scaleY)

Scale this node content by specified factors.

Parameters:

scaleX - X scale factor.

scaleY - Y scale factor.

Returns:

A new Node scaled.

scale

public Node scale(double scale)

Scale this node content by a specified factor.

Parameters:

scale - Scale factor.

Returns:

A new Node scaled.

flipHorizontally

public Node flipHorizontally()

Flip this node content horizontally.

Returns:

A new Node flipped horizontally.

flipVertically

public Node flipVertically()

Flip this node content vertically.

Returns:

A new Node flipped vertically.

moveTo

public MovableNode moveTo(double x,
 double y)

Moves the current node to a new position specified by the given x and y coordinates. This method creates a movable version of the current node, applies the movement, and returns the updated instance of the MovableNode.

Parameters:

x - The new x-coordinate to move the node to.

y - The new y-coordinate to move the node to.

Returns:

A new instance of MovableNode at the specified position.

moveTo

public MovableNode moveTo(Point p)

Moves the current node to a new position specified by the given Point. This method creates a movable version of the current node, applies the movement, and returns the updated instance of MovableNode.

Parameters:

p - The new position represented as a Point object to move the node to.

Returns:

A new instance of MovableNode at the specified position.

duplicate

public DuplicatedNode duplicate()

Creates and returns a duplicate of the current node instance. The duplicate is a new instance of the same node with a different unique identifier. However, any changes made to one will reflect in the other.

Returns:

A new instance of the current node with a different unique identifier.

createDocument

public final Document createDocument()

Creates a new Document instance associated with the current Node. This method initializes and returns a Document object for the node.

Returns:

A new Document instance associated with the current Node.

getSvg

public final String getSvg()

Retrieves the SVG representation of the current Node. This method internally uses a Document instance to generate the SVG output.

Returns:

A string containing the SVG representation of the current Node.

toString

public String toString()

Overrides:

toString in class Object