Module org.tquadrat.foundation.svg

Package org.tquadrat.foundation.svg

Interface SVGText

All Superinterfaces:

AllowsConditionalProcessingAttributes, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes, Element, SVGElement, SVGElementWithChildren

All Known Implementing Classes:

SVGElementAdapter, SVGGenericElement, SVGTextImpl

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

The definition of the SVG <text> element.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

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

CONDITIONALPROCESSING_ATTRIBUTES

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
XMLElement	addCDATA(CharSequence text)	Adds a CDATA element to this <text> element.
XMLElement	addText(CharSequence text)	Adds text to this <text> element.
void	setDx(SVGNumber... values)	Sets a list of lengths which move the characters relative to the absolute position of the last glyph drawn.
void	setDy(SVGNumber... values)	Sets a list of heights which move the characters relative to the absolute position of the last glyph drawn.
void	setLengthAdjust(boolean flag)	Sets the way the text length will be adjusted in order to meet the target length set by setTextLength(SVGNumber).
void	setRotate(SVGNumber.SVGDegree... values)	Sets a list of rotations for the glyphs.
void	setTextLength(SVGNumber value)	Sets the target length for the text that an SVG viewer will attempt to display the text between by adjusting the spacing and/or the glyphs.
void	setX(SVGNumber... values)	Sets a list of x-axis position.
void	setY(SVGNumber... values)	Sets a list of y-axis position.

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

setExternalResourcesRequired, setRequiredExtensions, setRequiredFeatures, setSystemLanguage

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

addCDATA

XMLElement addCDATA(CharSequence text)

Adds a CDATA element to this <text> element.

Parameters:

text - The text.

Returns:

This instance.

addText

XMLElement addText(CharSequence text)

Adds text to this <text> element. Special characters will be escaped.

Parameters:

text - The text.

Returns:

This instance.

Throws:

IllegalArgumentException - No text allowed for this element.

setDx

void setDx(SVGNumber... values)

Sets a list of lengths which move the characters relative to the absolute position of the last glyph drawn. The n^th length is given to n^th character in the text. If there are additional characters after the positions run out, the last length is applied to them.

Parameters:

values - The lengths.

setDy

void setDy(SVGNumber... values)

Sets a list of heights which move the characters relative to the absolute position of the last glyph drawn. The n^th height is given to n^th character in the text. If there are additional characters after the positions run out, the last height is applied to them.

Parameters:

values - The heights.

setLengthAdjust

void setLengthAdjust(boolean flag)

Sets the way the text length will be adjusted in order to meet the target length set by setTextLength(SVGNumber).

Parameters:

flag - true means that both, spacing and glyph size will be adjusted to match, false indicates that only the spacing will be changed.

setRotate

void setRotate(SVGNumber.SVGDegree... values)

Sets a list of rotations for the glyphs. The n^th rotation is given to n^th character in the text. Additional characters are not given the last rotation (although some browsers may handle that differently).

Parameters:

values - The rotations.

setTextLength

void setTextLength(SVGNumber value)

Sets the target length for the text that an SVG viewer will attempt to display the text between by adjusting the spacing and/or the glyphs.

Parameters:

value - The intended text length.

setX

void setX(SVGNumber... values)

Sets a list of x-axis position. The n^th x-axis position is given to n^th character in the text. If there are additional characters after the positions run out, they are placed after the last character.

Parameters:

values - The x-axis positions.

setY

void setY(SVGNumber... values)

Sets a list of y-axis position. The n^th y-axis position is given to n^th character in the text. If there are additional characters after the positions run out, they are placed after the last character.

Parameters:

values - The y-axis positions.