Package com.storedobject.svg

Class Document

java.lang.Object

java.util.AbstractCollection<Node>

java.util.AbstractList<Node>

java.util.ArrayList<Node>

com.storedobject.svg.Document

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Node>, Collection<Node>, List<Node>, RandomAccess, SequencedCollection<Node>

public class Document
extends ArrayList<Node>

The Document class represents a collection of Node objects and provides functionality to generate scalable vector graphic (SVG) output for the collection. It allows the storage and management of Node instances while adding SVG-specific methods to generate graphical representations of the contained nodes.

Author:

Syam

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
Document()	Default constructor for the Document class.
Document(Node node)	Constructs a new Document object, initializing it with a single Node.

Method Summary

Modifier and Type	Method	Description
Coordinates	getCoordinates()	Retrieves the combined coordinates of all nodes within the Document.
final String	getFilledSvg()	Get the SVG output that fills its container (100% width and height).
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.
String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll, reversed

Constructor Details

Document

public Document()

Default constructor for the Document class. Initializes a new instance of the Document without any content or nodes.

Document

public Document(Node node)

Constructs a new Document object, initializing it with a single Node.

Parameters:

node - The Node to be added to the Document during its creation.

Method Details

getCoordinates

public Coordinates getCoordinates()

Retrieves the combined coordinates of all nodes within the Document. If the Document is empty, default coordinates are returned.

The method iterates over all nodes in the Document, ensuring that each node is built before accessing or combining their coordinates. Default coordinates (0, 0, 0.1, 0.1) are returned if the Document contains no nodes.

Returns:

A Coordinates object representing either the combined coordinates of all nodes or default coordinates if the Document is empty.

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. For keeping the aspect ratio, use negative values for the percentage.

Parameters:

scaleWidthPercentage - Scale percentage for width (0 to 100). An out-of-range value means "auto" width to keep the aspect ratio.

scaleHeightPercentage - Scale percentage for height (0 to 100). An out-of-range value means "auto" height to keep the aspect ratio.

Returns:

SVG string.

toString

public String toString()

Overrides:

toString in class AbstractCollection<Node>