Package com.storedobject.svg

Class Group

java.lang.Object

com.storedobject.svg.Node

com.storedobject.svg.Element

com.storedobject.svg.Group

public final class Group
extends Element

Represents a group element in the SVG structure. The Group class is used to manage and organize a collection of child Node elements, allowing for their collective manipulation and rendering in an SVG format. It provides functionality to add, remove, and iterate through child elements, as well as to build the group into its final SVG representation.

Author:

Syam

Nested Class Summary

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

Node.Anchor, Node.Margin, Node.Mover, Node.Scale, Node.ScaleTo

Field Summary

Fields inherited from class com.storedobject.svg.Element

built, styles, tag

Fields inherited from class com.storedobject.svg.Node

svg, x1, x2, y1, y2

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	add(int index, Node child)	Inserts a child Node at the specified position within the group's list of children.
void	add(Node child)	Adds a child Node to the group.
void	build()	Build the content.
Stream<Node>	children()	Retrieves a stream of child Node elements that are part of this group.
void	remove(Node child)	Removes a child Node from the group.

Methods inherited from class com.storedobject.svg.Element

getStyles, getTag, isBuilt, styleEnd, styleStart

Methods inherited from class com.storedobject.svg.Node

add, add, add, createDocument, duplicate, equals, escapeXml, flipHorizontally, flipVertically, getCoordinates, getHeight, getId, getSvg, getWidth, getX1, getX2, getY1, getY2, hashCode, ID, IDValue, margin, margin, margin, moveTo, moveTo, scale, scale, scaleTo, scaleToHeight, scaleToWidth, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Group

public Group()

Default constructor for the Group class. Initializes a new instance of the Group element with the SVG tag "g". This constructor sets up the base structure required for managing and organizing a collection of child Node elements in the SVG structure.

Method Details

add

public void add(Node child)

Adds a child Node to the group. If the provided child node is non-null, it will be added to the internal list of child nodes managed by this group.

Parameters:

child - the Node to be added to the group; must not be null.

add

public void add(int index,
 Node child)

Inserts a child Node at the specified position within the group's list of children. If the provided child node is non-null, it will be added at the specified index.

Parameters:

index - the position at which the child should be inserted; must be a valid index.

child - the Node to be inserted; must not be null.

remove

public void remove(Node child)

Removes a child Node from the group. If the specified child node exists in the group's list of children, it will be removed.

Parameters:

child - the Node to be removed from the group; must not be null.

children

public Stream<Node> children()

Retrieves a stream of child Node elements that are part of this group. The returned stream provides a way to access and process the children sequentially or in parallel.

Returns:

a Stream of Node elements representing the children of this group.

build

public void build()

Description copied from class: Node

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

Specified by:

build in class Node