Package com.storedobject.svg

Class Grid

java.lang.Object

com.storedobject.svg.Node

com.storedobject.svg.Element

com.storedobject.svg.Rectangle

com.storedobject.svg.Grid

All Implemented Interfaces:

Serializable

public class Grid
extends Rectangle

Represents a rectangle with vertical and/or horizontal grid-lines at specified gaps. Vertical and horizontal gaps may be different or absent.

Author:

Syam

See Also:

• Serialized Form

Field Summary

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
Grid(double vGap, double hGap)	Constructor.
Grid(double w, double h, double vGap, double hGap)	Constructor.
Grid(double x, double y, double w, double h, double vGap, double hGap)	Constructor.
Grid(Point p, double vGap, double hGap)	Constructor.
Grid(Point p, double w, double h, double vGap, double hGap)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	extraContent()	Provides additional content specific to the node.
double	getHGap()	Get the horizontal gap.
double	getVGap()	Get the vertical gap.
Grid	hGap(double hGap)	Set the horizontal gap.
static Grid	of(double w, double h, double vGap, double hGap)	Create a grid at (0, 0).
static Grid	of(double x, double y, double w, double h, double vGap, double hGap)	Create a grid.
static Grid	of(Point p, double w, double h, double vGap, double hGap)	Create a grid.
void	setHGap(double hGap)	Set the horizontal gap.
void	setVGap(double vGap)	Set the vertical gap.
Grid	vGap(double vGap)	Set the vertical gap.

Methods inherited from class com.storedobject.svg.Rectangle

at, at, attributes, getHeight, getPosition, getWidth, height, of, of, setHeight, setPosition, setWidth, setX, setY, width, x, y

Methods inherited from class com.storedobject.svg.Element

getStyles, styles, tag

Methods inherited from class com.storedobject.svg.Node

compute, copy, copy, createDocument, equals, escapeXml, flipHorizontally, flipHorizontallyAroundOrigin, flipVertically, flipVerticallyAroundOrigin, getCoordinates, getId, getMargin, getSvg, hashCode, id, ID, IDValue, innerContent, 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

Grid

public Grid(Point p,
 double w,
 double h,
 double vGap,
 double hGap)

Constructor.

Parameters:

p - Top-left point.

w - Width.

h - Height.

vGap - Vertical gap.

hGap - Horizontal gap.

Grid

public Grid(double x,
 double y,
 double w,
 double h,
 double vGap,
 double hGap)

Constructor.

Parameters:

x - Top-left X coordinate.

y - Top-left Y coordinate.

w - Width.

h - Height.

vGap - Vertical gap.

hGap - Horizontal gap.

Grid

public Grid(double w,
 double h,
 double vGap,
 double hGap)

Constructor.

Parameters:

w - Width.

h - Height.

vGap - Vertical gap.

hGap - Horizontal gap.

Grid

public Grid(Point p,
 double vGap,
 double hGap)

Constructor.

Parameters:

p - Top-left point.

vGap - Vertical gap.

hGap - Horizontal gap.

Grid

public Grid(double vGap,
 double hGap)

Constructor.

Parameters:

vGap - Vertical gap.

hGap - Horizontal gap.

Method Details

setVGap

public void setVGap(double vGap)

Set the vertical gap.

Parameters:

vGap - Vertical gap.

getVGap

public double getVGap()

Get the vertical gap.

Returns:

Vertical gap.

setHGap

public void setHGap(double hGap)

Set the horizontal gap.

Parameters:

hGap - Horizontal gap.

getHGap

public double getHGap()

Get the horizontal gap.

Returns:

Horizontal gap.

of

public static Grid of(Point p,
 double w,
 double h,
 double vGap,
 double hGap)

Create a grid.

Parameters:

p - Top-left point.

w - Width.

h - Height.

vGap - Vertical gap.

hGap - Horizontal gap.

Returns:

Grid.

of

public static Grid of(double x,
 double y,
 double w,
 double h,
 double vGap,
 double hGap)

Create a grid.

Parameters:

x - Top-left X coordinate.

y - Top-left Y coordinate.

w - Width.

h - Height.

vGap - Vertical gap.

hGap - Horizontal gap.

Returns:

Grid.

of

public static Grid of(double w,
 double h,
 double vGap,
 double hGap)

Create a grid at (0, 0).

Parameters:

w - Width.

h - Height.

vGap - Vertical gap.

hGap - Horizontal gap.

Returns:

Grid.

vGap

public Grid vGap(double vGap)

Set the vertical gap.

Parameters:

vGap - Vertical gap.

Returns:

Self.

hGap

public Grid hGap(double hGap)

Set the horizontal gap.

Parameters:

hGap - Horizontal gap.

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

Returns:

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