Module org.tquadrat.foundation.svg

Package org.tquadrat.foundation.svg

Interface SVGElement

All Superinterfaces:

Element

All Known Subinterfaces:

SVG, SVGClipPath, SVGElementWithChildren, SVGGroup, SVGLine, SVGMarker, SVGPath, SVGPositionedMarker, SVGRectangle, SVGStyle, SVGSymbol, SVGText, SVGTSpan, SVGUse

All Known Implementing Classes:

SVGClipPathImpl, SVGElementAdapter, SVGElementImpl, SVGGenericElement, SVGGroupImpl, SVGImpl, SVGLineImpl, SVGMarkerImpl, SVGPathImpl, SVGPositionedMarkerImpl, SVGRectangleImpl, SVGStyleImpl, SVGSymbolImpl, SVGTextBase, SVGTextImpl, SVGTSpanImpl, SVGUseImpl

@ClassVersion(sourceVersion="$Id: SVGElement.java 1074 2023-10-02 12:05:06Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public sealed interface SVGElement
extends Element
permits SVGElementWithChildren, SVGStyle, SVGUse, SVGElementImpl

The definition of an SVG element.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: SVGElement.java 1074 2023-10-02 12:05:06Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.svg.SVGElement"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	CORE_ATTRIBUTES	The core attributes.

Method Summary

Modifier and Type	Method	Description
XMLElement	addComment(CharSequence comment)	Adds a comment.
default Collection<SVGElementCategory>	getSVGElementCategory()	Returns the element category.
XMLElement	setId(String id)	Sets the SVG id for the element. The type will be validated using the method that is provided by a call to XMLBuilderUtils.getNMTokenValidator().
void	setLang(Locale value)	Sets the human language attribute for this SVG element.
void	setPreserveSpace(boolean flag)	Sets attribute that defines how space is handled by this SVG element.
void	setTabIndex(int value)	Sets the tabulator index for the SVG element.
void	setTitle(CharSequence title)	Sets the title for the SVG element. This is not an attribute, instead a <"title"> element will be added as a child.
void	setXMLBase(URI value)	Sets XML attribute for the base URI that is used to reference external resources.
void	setXMLId(String id)	Sets the id for the element. The type will be validated using the method that is provided by a call to XMLBuilderUtils.getNMTokenValidator().
void	setXMLLang(Locale value)	Sets XML attribute for the human language for this SVG element.

Methods inherited from interface org.tquadrat.foundation.xml.builder.spi.Element

getAttribute, getAttributes, getChildren, getElementName, getNamespaces, getParent, hasChildren, isBlock, setParent, toString

Field Details

CORE_ATTRIBUTES

static final List<String> CORE_ATTRIBUTES

The core attributes.

Method Details

addComment

XMLElement addComment(CharSequence comment)
               throws IllegalArgumentException

Adds a comment.

Parameters:

comment - The comment text.

Returns:

This instance.

Throws:

IllegalArgumentException - No comment allowed for this element.

getSVGElementCategory

default Collection<SVGElementCategory> getSVGElementCategory()

Returns the element category.

Returns:

The element categories; will never be null.

setId

XMLElement setId(String id)
          throws IllegalArgumentException

Sets the SVG id for the element.

The type will be validated using the method that is provided by a call to XMLBuilderUtils.getNMTokenValidator().

Parameters:

id - The id.

Returns:

This instance.

Throws:

IllegalArgumentException - An attribute with the given name is not valid for the element, or no attributes are allowed at all, or the type is not a valid NMToken.

See Also:

• SVGUtils.SVGATTRIBUTE_Id

setLang

void setLang(Locale value)

Sets the human language attribute for this SVG element.

Parameters:

value - The language code.

setPreserveSpace

void setPreserveSpace(boolean flag)

Sets attribute that defines how space is handled by this SVG element.

Parameters:

flag - true to preserve space in the source, false for the XML default behaviour (ignoring excessive whitespace).

setTabIndex

void setTabIndex(int value)

Sets the tabulator index for the SVG element.

Parameters:

value - The tabindex type.

setTitle

void setTitle(CharSequence title)

Sets the title for the SVG element.

This is not an attribute, instead a <"title"> element will be added as a child.

Parameters:

title - The title; nothing happens if null, empty, or blank.

Throws:

IllegalStateException - The given title is not null, empty, or blank, and a title was applied already earlier.

setXMLBase

void setXMLBase(URI value)

Sets XML attribute for the base URI that is used to reference external resources.

Parameters:

value - The base URI.

setXMLId

void setXMLId(String id)
       throws IllegalArgumentException

Sets the id for the element.

The type will be validated using the method that is provided by a call to XMLBuilderUtils.getNMTokenValidator().

Parameters:

id - The id.

Throws:

IllegalArgumentException - An attribute with the given name is not valid for the element, or no attributes are allowed at all, or the type is not a valid NMToken.

See Also:

• CommonConstants.XMLATTRIBUTE_Id

setXMLLang

void setXMLLang(Locale value)

Sets XML attribute for the human language for this SVG element.

Parameters:

value - The language code.