Module org.tquadrat.foundation.svg
Package org.tquadrat.foundation.svg

Class SVGElementAdapter

java.lang.Object
org.tquadrat.foundation.xml.builder.internal.XMLElementImpl
org.tquadrat.foundation.xml.builder.spi.XMLElementAdapter
org.tquadrat.foundation.svg.internal.SVGElementImpl
org.tquadrat.foundation.svg.SVGElementAdapter
All Implemented Interfaces:
AllowsConditionalProcessingAttributes, AllowsDocumentElementEventAttributes, AllowsDocumentEventAttributes, AllowsGlobalEventAttributes, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes, AllowsXLinkAttributes, SVGClipPath, SVGElement, SVGElementWithChildren, SVGGroup, SVGLine, SVGMarker, SVGPath, SVGPositionedMarker, SVGRectangle, SVGStyle, SVGSymbol, SVGText, SVGTSpan, SVGUse, Element, XMLElement
Direct Known Subclasses:
SVGGenericElement
@ClassVersion(sourceVersion="$Id: SVGElementAdapter.java 980 2022-01-06 15:29:19Z tquadrat $") @API(status=STABLE, since="0.0.5") public abstract non-sealed class SVGElementAdapter extends SVGElementImpl implements AllowsDocumentElementEventAttributes, AllowsDocumentEventAttributes, SVGClipPath, SVGGroup, SVGLine, SVGPath, SVGPositionedMarker, SVGRectangle, SVGStyle, SVGSymbol, SVGText, SVGTSpan, SVGUse

This is the base class for a custom type that wants to extend an SVG element with additional features.

Basically, an implementation may look like this (in this example, for an SVG <symbol> extension:

  …
  public class MySymbol extends SVGElementBase
  {
      …
      public MySymbol()
      {
          super( SVGUtils.SVGELEMENT_Symbol, ALLOW_CHILDREN );
          …
      }
      …
  }
Note:
  • Such a custom element implements all the other interfaces; it is all the other element type at the same time! But that does not mean that it will inherit their features automatically! Especially it will not validate children or attributes!
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: SVGElementAdapter.java 980 2022-01-06 15:29:19Z tquadrat $
Since:
0.0.5
UML Diagram
UML Diagram for "org.tquadrat.foundation.svg.SVGElementAdapter"⁠

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

UML Diagram for "org.tquadrat.foundation.svg.SVGElementAdapter"⁠

  • Field Details

  • Constructor Details

    • SVGElementAdapter

      protected SVGElementAdapter(String elementName, XMLElement.Flags... flags)
      Creates a new SVGElementAdapter instance.
      Parameters:
      elementName - The name of the element.
      flags - The flags that determine the behaviour of the new element.

  • Method Details

    • addStyle

      @MountPoint public void addStyle(CharSequence... styles)
      Adds a CSS style definition to this style.
      Specified by:
      addStyle in interface SVGStyle
      Parameters:
      styles - The style definitions to add.

    • defineLine

      @MountPoint public void defineLine(SVGNumber x1, SVGNumber y1, SVGNumber x2, SVGNumber y2)
      Sets the start and end points for this line.
      Specified by:
      defineLine in interface SVGLine
      Parameters:
      x1 - The x coordinate for the starting point of the line.
      y1 - The y coordinate for the starting point of the line.
      x2 - The x coordinate for the ending point of the line.
      y2 - The y coordinate for the ending point of the line.

    • setPathLength

      @MountPoint public void setPathLength(double length)
      Sets the length of the path represented by this SVG <line> element.
      Specified by:
      setPathLength in interface SVGLine
      Specified by:
      setPathLength in interface SVGPath
      Specified by:
      setPathLength in interface SVGRectangle
      Parameters:
      length - The author's computation of the total length of the path, in user units. This type is used to calibrate the user agent's own distance-along-a-path calculations with that of the author. The user agent will scale all distance-along-a-path computations by the ratio of this type to the user agent's own computed type for total path length.

      A type of zero is valid, but a negative type is an error.

    • setPathLength

      @MountPoint public void setPathLength(long length)
      Sets the length of the path represented by this SVG <line> element.
      Specified by:
      setPathLength in interface SVGLine
      Specified by:
      setPathLength in interface SVGPath
      Specified by:
      setPathLength in interface SVGRectangle
      Parameters:
      length - The author's computation of the total length of the path, in user units. This type is used to calibrate the user agent's own distance-along-a-path calculations with that of the author. The user agent will scale all distance-along-a-path computations by the ratio of this type to the user agent's own computed type for total path length.

      A type of zero is valid, but a negative type is an error.

    • getStyleSheet

      @MountPoint public String getStyleSheet()
      Returns the style sheet.
      Specified by:
      getStyleSheet in interface SVGStyle
      Returns:
      The style definitions.

    • merge

      @MountPoint public void merge(SVGStyle other)
      Merges the given SVG <style> element into this one.

      Only the CSS style definitions are taken from the other element, no attributes or comments.
      Specified by:
      merge in interface SVGStyle
      Parameters:
      other - The other <style> element.

    • setClipPathUnits

      @MountPoint public void setClipPathUnits(boolean flag)
      Sets the "clipPathUnits" attribute that defines the coordinate system for the contents of this <clipPath> element.
      Specified by:
      setClipPathUnits in interface SVGClipPath
      Parameters:
      flag - true if the user coordinate system for the contents of the <clipPath> element is established using the bounding box of the element to which the clipping path is applied, false if the contents of the <clipPath> element represents values in the current user coordinate system in place at the time when the <clipPath> element is referenced.

    • setDx

      @MountPoint public void setDx(SVGNumber... values)
      Sets a list of lengths which move the characters relative to the absolute position of the last glyph drawn. The nth length is given to nth character in the text. If there are additional characters after the positions run out, the last length is applied to them.
      Specified by:
      setDx in interface SVGText
      Specified by:
      setDx in interface SVGTSpan
      Parameters:
      values - The lengths.

    • setDy

      @MountPoint public void setDy(SVGNumber... values)
      Sets a list of heights which move the characters relative to the absolute position of the last glyph drawn. The nth height is given to nth character in the text. If there are additional characters after the positions run out, the last height is applied to them.
      Specified by:
      setDy in interface SVGText
      Specified by:
      setDy in interface SVGTSpan
      Parameters:
      values - The heights.

    • setLengthAdjust

      @MountPoint public void setLengthAdjust(boolean flag)
      Sets the way the text length will be adjusted in order to meet the target length set by SVGText.setTextLength(SVGNumber).
      Specified by:
      setLengthAdjust in interface SVGText
      Specified by:
      setLengthAdjust in interface SVGTSpan
      Parameters:
      flag - true means that both, spacing and glyph size will be adjusted to match, false indicates that only the spacing will be changed.

    • setMarkerHeight

      @MountPoint public void setMarkerHeight(SVGNumber value)
      Sets the height of the viewport into which the <marker> is to be fitted when it is rendered.
      Specified by:
      setMarkerHeight in interface SVGMarker
      Parameters:
      value - The height.
      See Also:

    • setMarkerUnits

      @MountPoint public void setMarkerUnits(boolean flag)
      Sets the marker units attribute that defines the coordinate system for the attributes "markerWidth" and "markerHeight".
      Specified by:
      setMarkerUnits in interface SVGMarker
      Parameters:
      flag - true if the user space should be used, false for the stroke width.

    • setMarkerWidth

      @MountPoint public void setMarkerWidth(SVGNumber value)
      Sets the width of the viewport into which the <marker> is to be fitted when it is rendered.
      Specified by:
      setMarkerWidth in interface SVGMarker
      Parameters:
      value - The width.
      See Also:

    • setOrientation

      @MountPoint public void setOrientation(SVGMarkerOrientation value)
      Sets the orientation of the marker. Basically, this means how it is rotated when it is placed at its position on the markable element.
      Specified by:
      setOrientation in interface SVGMarker
      Parameters:
      value - The orientation.

    • setOrientation

      @MountPoint public void setOrientation(SVGNumber.SVGDegree value)
      Sets the orientation of the marker. Basically, this means how it is rotated when it is placed at its position on the markable element.
      Specified by:
      setOrientation in interface SVGMarker
      Parameters:
      value - The orientation.

    • setPathDefinition

      @MountPoint public void setPathDefinition(SVGPathElement... pathElements)
      Sets the path definition for this SVG <path> element.
      Specified by:
      setPathDefinition in interface SVGPath
      Parameters:
      pathElements - The elements of the path.

    • setPosition

      @MountPoint public void setPosition(SVGNumber value)
      Sets the relative position for this marker.
      Specified by:
      setPosition in interface SVGPositionedMarker
      Parameters:
      value - The distance.

    • setReferenceX

      @MountPoint public void setReferenceX(SVGNumber value)
      Sets the x coordinate of the marker reference point.
      Specified by:
      setReferenceX in interface SVGMarker
      Parameters:
      value - The coordinate type.
      See Also:

    • setReferenceY

      @MountPoint public void setReferenceY(SVGNumber value)
      Sets the y coordinate of the marker reference point.
      Specified by:
      setReferenceY in interface SVGMarker
      Parameters:
      value - The coordinate type.
      See Also:

    • setRotate

      @MountPoint public void setRotate(SVGNumber.SVGDegree... values)
      Sets a list of rotations for the glyphs. The nth rotation is given to nth character in the text. Additional characters are not given the last rotation (although some browsers may handle that differently).
      Specified by:
      setRotate in interface SVGText
      Specified by:
      setRotate in interface SVGTSpan
      Parameters:
      values - The rotations.

    • setTextLength

      @MountPoint public 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.
      Specified by:
      setTextLength in interface SVGText
      Specified by:
      setTextLength in interface SVGTSpan
      Parameters:
      value - The intended text length.

    • setX

      @MountPoint public void setX(SVGNumber... values)
      Sets a list of x-axis position. The nth x-axis position is given to nth character in the text. If there are additional characters after the positions run out, they are placed after the last character.
      Specified by:
      setX in interface SVGText
      Specified by:
      setX in interface SVGTSpan
      Parameters:
      values - The x-axis positions.

    • setX1

      @MountPoint public void setX1(SVGNumber value)
      Sets the x coordinate of the starting point for this line.
      Specified by:
      setX1 in interface SVGLine
      Parameters:
      value - The x coordinate.

    • setX2

      @MountPoint public void setX2(SVGNumber value)
      Sets the x coordinate of the ending point for this line.
      Specified by:
      setX2 in interface SVGLine
      Parameters:
      value - The x coordinate.

    • setY

      @MountPoint public void setY(SVGNumber... values)
      Sets a list of y-axis position. The nth y-axis position is given to nth character in the text. If there are additional characters after the positions run out, they are placed after the last character.
      Specified by:
      setY in interface SVGText
      Specified by:
      setY in interface SVGTSpan
      Parameters:
      values - The y-axis positions.

    • setY1

      @MountPoint public void setY1(SVGNumber value)
      Sets the y coordinate of the starting point for this line.
      Specified by:
      setY1 in interface SVGLine
      Parameters:
      value - The y coordinate.

    • setY2

      @MountPoint public void setY2(SVGNumber value)
      Sets the y coordinate of the ending point for this line.
      Specified by:
      setY2 in interface SVGLine
      Parameters:
      value - The y coordinate.

    • toString

      @MountPoint public String toString(int indentationLevel, boolean prettyPrint)
      Specified by:
      toString in interface Element
      Specified by:
      toString in interface SVGStyle