Module org.tquadrat.foundation.svg

Package org.tquadrat.foundation.svg

Interface SVGSymbol

All Superinterfaces:

AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes, Element, SVGElement, SVGElementWithChildren

All Known Implementing Classes:

SVGElementAdapter, SVGGenericElement, SVGSymbolImpl

@ClassVersion(sourceVersion="$Id: SVGSymbol.java 1074 2023-10-02 12:05:06Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public sealed interface SVGSymbol
extends SVGElementWithChildren, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes
permits SVGElementAdapter, SVGSymbolImpl

The definition of the SVG element <symbol>.

A <symbol> element is useless without the attribute id set; therefore it is required already on creation and will not appear in this interface.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

See Also:

• SVGUtils.createSymbol(String)
• SVGUtils.createSymbol(String,SVG)
• "https://www.w3.org/TR/SVG/single-page.html#struct-SVGElement"

UML Diagram

⁠

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

⁠

Field Summary

Fields inherited from interface org.tquadrat.foundation.svg.AllowsGraphicalEventAttributes

GRAPHICALEVENT_ATTRIBUTES

Fields inherited from interface org.tquadrat.foundation.svg.AllowsPresentationAttributes

PRESENTATION_ATTRIBUTES

Fields inherited from interface org.tquadrat.foundation.svg.AllowsStyleAttributes

STYLE_ATTRIBUTES

Fields inherited from interface org.tquadrat.foundation.svg.SVGElement

CORE_ATTRIBUTES

Method Summary

Modifier and Type	Method	Description
void	setExternalResourcesRequired(boolean flag)	Sets the attribute that indicates whether external resources are required to render this <symbol> element.
void	setPreserveAspectRatio(SVGPreserveAspectRatio value)	Sets the mode for the aspect ratio preservation for this <symbol> element.
void	setViewBox(SVGNumber x, SVGNumber y, SVGNumber width, SVGNumber height)	Defines the visible area for this <symbol> element.

Methods inherited from interface org.tquadrat.foundation.svg.AllowsGraphicalEventAttributes

setActivationHandler, setFocusInHandler, setFocusOutHandler

Methods inherited from interface org.tquadrat.foundation.svg.AllowsPresentationAttributes

setAlignmentBaseline, setBaselineShift, setClip, setClipPath, setClipRule, setColor, setColorInterpolation, setColorInterpolationFilters, setColorProfile, setColorRendering, setCursor, setDirection, setDisplay, setDominantBaseline, setEnableBackground, setFill, setFillOpacity, setFillRule, setFilter, setFloodColor, setFloodOpacity, setFontFamily, setFontSize, setFontSizeAdjust, setFontStretch, setFontStyle, setFontVariant, setFontWeight, setGlyphOrientationHorizontal, setGlyphOrientationVertical, setImageRendering, setKerning, setLetterSpacing, setLightingColor, setMarkerEnd, setMarkerMid, setMarkerStart, setMask, setOpacity, setOverflow, setPointerEvents, setShapeRendering, setStopColor, setStopOpacity, setStroke, setStrokeDashArray, setStrokeDashOffset, setStrokeLineCap, setStrokeLineJoin, setStrokeMiterLimit, setStrokeOpacity, setStrokeWidth, setTextAnchor, setTextDecoration, setTextRendering, setTransform, setUnicodeBidi, setVectorEffect, setVisibility, setWordSpacing, setWritingMode

Methods inherited from interface org.tquadrat.foundation.svg.AllowsStyleAttributes

setClass, setStyle

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

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

Methods inherited from interface org.tquadrat.foundation.svg.SVGElement

addComment, getSVGElementCategory, setId, setLang, setPreserveSpace, setTabIndex, setTitle, setXMLBase, setXMLId, setXMLLang

Methods inherited from interface org.tquadrat.foundation.svg.SVGElementWithChildren

addChild, setDescription

Method Details

setExternalResourcesRequired

void setExternalResourcesRequired(boolean flag)

Sets the attribute that indicates whether external resources are required to render this <symbol> element.

Parameters:

flag - true if external resources are needed, false if all required resources are local to the current context.

setPreserveAspectRatio

void setPreserveAspectRatio(SVGPreserveAspectRatio value)

Sets the mode for the aspect ratio preservation for this <symbol> element.

Parameters:

value - The type; if null the attribute will be removed.

setViewBox

void setViewBox(SVGNumber x,
 SVGNumber y,
 SVGNumber width,
 SVGNumber height)

Defines the visible area for this <symbol> element.

Parameters:

x - The x coordinate of top left corner of the area.

y - The y coordinate of top left corner of the area.

width - The width of the area.

height - The height of the area.