svgom: make SVGStylable compatible with modern CSSOM and Typed OM

Author: carlosame

cssom-api/src/main/java/org/w3c/css/om/CSSStyleDeclaration.java

@@ -12,17 +12,19 @@
 
 import org.w3c.css.om.typed.CSSStyleValue;
 import org.w3c.dom.DOMException;
+import org.w3c.dom.css.CSSValue;
 
 /**
  * CSS style declaration.
  */
-public interface CSSStyleDeclaration {
+public interface CSSStyleDeclaration extends org.w3c.dom.css.CSSStyleDeclaration {
 
 	/**
 	 * A parsable serialization of the declaration.
 	 *
 	 * @return the textual representation of the declaration.
 	 */
+	@Override
 	String getCssText();
 
 	/**
@@ -31,6 +33,7 @@ public interface CSSStyleDeclaration {
 	 * 
 	 * @param cssText the serialized style declaration.
 	 */
+	@Override
 	void setCssText(String cssText) throws DOMException;
 
 	/**
@@ -40,6 +43,7 @@ public interface CSSStyleDeclaration {
 	 * @return the value of the removed property, or the empty string if that
 	 *         property was not explicitly set in this declaration.
 	 */
+	@Override
 	String removeProperty(String propertyName) throws DOMException;
 
 	/**
@@ -48,6 +52,7 @@ public interface CSSStyleDeclaration {
 	 * @param propertyName the name of the property.
 	 * @return the priority string, or the empty string if no priority was set.
 	 */
+	@Override
 	String getPropertyPriority(String propertyName);
 
 	/**
@@ -57,13 +62,15 @@ public interface CSSStyleDeclaration {
 	 * @param value the property value.
 	 * @param priority the priority.
 	 */
+	@Override
 	void setProperty(String propertyName, String value, String priority) throws DOMException;
 
 	/**
 	 * The number of properties in this declaration.
 	 * 
 	 * @return the number of properties in this declaration.
 	 */
+	@Override
 	int getLength();
 
 	/**
@@ -74,8 +81,31 @@ public interface CSSStyleDeclaration {
 	 *         less than zero, or greater or equal to the length of this
 	 *         declaration.
 	 */
+	@Override
 	String item(int index);
 
+	/**
+	 * Gives the legacy object representation of the value of a CSS property if it
+	 * has been explicitly set within this declaration block.
+	 * <p>
+	 * This method returns <code>null</code> if the property is a shorthand
+	 * property. Shorthand property values can only be accessed and modified as
+	 * strings, using the <code>getPropertyValue</code> and <code>setProperty</code>
+	 * methods.
+	 * </p>
+	 * 
+	 * @param propertyName The name of the CSS property.
+	 * @return the value of the property if it has been explicitly set for this
+	 *         declaration block. Returns <code>null</code> if the property has not
+	 *         been set, or the implementation does not support legacy object
+	 *         values.
+	 */
+	@SuppressWarnings("exports")
+	@Override
+	default CSSValue getPropertyCSSValue(String propertyName) {
+		return null;
+	}
+
 	/**
 	 * Gets the object representation of the value of a CSS property if it has been
 	 * explicitly set for this declaration block.
@@ -109,6 +139,7 @@ default CSSStyleValue getCSSStyleValue(String propertyName) {
 	 *         block, or the empty string if the property has not been set or is a shorthand
 	 *         that could not be serialized.
 	 */
+	@Override
 	String getPropertyValue(String propertyName);
 
 	/**
@@ -117,6 +148,7 @@ default CSSStyleValue getCSSStyleValue(String propertyName) {
 	 * @return the CSS rule that contains this declaration block or <code>null</code> if this
 	 *         <code>CSSStyleDeclaration</code> is not attached to a <code>CSSRule</code>.
 	 */
+	@Override
 	CSSRule getParentRule();
 
 }

svgom-api/build.gradle

@@ -4,6 +4,7 @@ plugins {
 
 dependencies {
 	api project(':smil-api')
+	api project(':cssom-api')
 }
 
 description = 'io.sf.carte:svgom-api'

svgom-api/src/main/java/module-info.java

@@ -10,15 +10,15 @@
  * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
  * 
  * Later modifications:
- * Copyright (c) 2020-2021 Carlos Amengual
+ * Copyright (c) 2020-2024 Carlos Amengual
  */
 
 /**
  * Scalable Vector Graphics (SVG) Java binding.
  * <p>
  * This is a Java binding for an old version of the SVG DOM API (SVGOM). It is
- * compatible with the SVGOM API used by Apache Batik (which uses the SVGOM
- * packages at the <a href=
+ * compatible with modern Typed OM but also with the legacy SVGOM API used by
+ * Apache Batik (which uses the SVGOM packages at the <a href=
  * "http://archive.apache.org/dist/xml/commons/xml-commons-external-1.3.04-src.zip">{@code xml-apis-ext-1.3.04}</a>
  * package), that seem to be a mixture of the
  * <a href="http://www.w3.org/TR/2000/CR-SVG-20000802/java-binding.zip">SVG
@@ -28,12 +28,15 @@
  * </p>
  * <p>
  * Some method signatures were modified so they match the implementations in
- * Apache Batik/EchoSVG.
+ * Apache Batik.
  * </p>
  */
 module org.w3c.dom.svg {
+
 	exports org.w3c.dom.svg;
 
 	requires transitive jdk.xml.dom;
 	requires transitive org.w3c.dom.smil;
+	requires transitive org.w3c.css.om;
+
 }

svgom-api/src/main/java/org/w3c/dom/svg/SVGColor.java

@@ -34,6 +34,7 @@ default RGBColor getRGBColor() {
 		return null;
 	}
 
+	@SuppressWarnings("removal")
 	default SVGICCColor getICCColor() {
 		return null;
 	}

svgom-api/src/main/java/org/w3c/dom/svg/SVGPaint.java

@@ -17,6 +17,7 @@
  * ‘fill’ and ‘stroke’.
  */
 @Deprecated
+@SuppressWarnings("removal")
 public interface SVGPaint extends SVGColor {
 	// Paint Types
 	public static final short SVG_PAINTTYPE_UNKNOWN = 0;

svgom-api/src/main/java/org/w3c/dom/svg/SVGRect.java

@@ -14,20 +14,82 @@
 
 import org.w3c.dom.DOMException;
 
+/**
+ * Represents rectangular geometry.
+ * <p>
+ * Rectangles are defined as consisting of a (x,y) coordinate pair identifying a
+ * minimum X value, a minimum Y value, and a width and height, which are usually
+ * constrained to be non-negative.
+ * </p>
+ */
 public interface SVGRect {
-	public float getX();
 
-	public void setX(float x) throws DOMException;
+	/**
+	 * The minimum X value.
+	 * 
+	 * @return the minimum X value in user units.
+	 */
+	float getX();
+
+	/**
+	 * Sets the minimum X value.
+	 * 
+	 * @param x the minimum X value in user units.
+	 * @throws DOMException NO_MODIFICATION_ALLOWED_ERR if the rectangle corresponds
+	 *                      to a read only attribute or when the object itself is
+	 *                      read only.
+	 */
+	void setX(float x) throws DOMException;
+
+	/**
+	 * The minimum Y value.
+	 * 
+	 * @return the minimum Y value in user units.
+	 */
+	float getY();
 
-	public float getY();
+	/**
+	 * Sets the minimum Y value.
+	 * 
+	 * @param y the minimum Y value in user units.
+	 * @throws DOMException NO_MODIFICATION_ALLOWED_ERR if the rectangle corresponds
+	 *                      to a read only attribute or when the object itself is
+	 *                      read only.
+	 */
+	void setY(float y) throws DOMException;
 
-	public void setY(float y) throws DOMException;
+	/**
+	 * The width.
+	 * 
+	 * @return the width in user units.
+	 */
+	float getWidth();
 
-	public float getWidth();
+	/**
+	 * Sets the width of the rectangle.
+	 * 
+	 * @param width the width in user units.
+	 * @throws DOMException NO_MODIFICATION_ALLOWED_ERR if the rectangle corresponds
+	 *                      to a read only attribute or when the object itself is
+	 *                      read only.
+	 */
+	void setWidth(float width) throws DOMException;
 
-	public void setWidth(float width) throws DOMException;
+	/**
+	 * The height.
+	 * 
+	 * @return the height in user units.
+	 */
+	float getHeight();
 
-	public float getHeight();
+	/**
+	 * Sets the height of the rectangle.
+	 * 
+	 * @param height the height in user units.
+	 * @throws DOMException NO_MODIFICATION_ALLOWED_ERR if the rectangle corresponds
+	 *                      to a read only attribute or when the object itself is
+	 *                      read only.
+	 */
+	void setHeight(float height) throws DOMException;
 
-	public void setHeight(float height) throws DOMException;
 }

svgom-api/src/main/java/org/w3c/dom/svg/SVGStylable.java

@@ -12,13 +12,24 @@
 
 package org.w3c.dom.svg;
 
-import org.w3c.dom.css.CSSStyleDeclaration;
 import org.w3c.dom.css.CSSValue;
 
-public interface SVGStylable {
-	public SVGAnimatedString getClassName();
+/**
+ * This interface is implemented on all objects corresponding to SVG elements
+ * that can have <code>style</code>, <code>class</code> and presentation
+ * attributes specified on them.
+ */
+public interface SVGStylable extends SVGStylableP<CSSValue> {
 
-	public CSSStyleDeclaration getStyle();
+	/**
+	 * Returns the base value of a given presentation attribute as an object.
+	 * 
+	 * @param name the presentation attribute.
+	 * @return the given presentation attribute as an object.
+	 */
+	@Deprecated
+	default CSSValue getPresentationAttribute(String name) {
+		return null;
+	}
 
-	public CSSValue getPresentationAttribute(String name);
 }

svgom-api/src/main/java/org/w3c/dom/svg/SVGStylableP.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2010 World Wide Web Consortium,
+ *
+ * (Massachusetts Institute of Technology, European Research Consortium for
+ * Informatics and Mathematics, Keio University). All Rights Reserved. This
+ * work is distributed under the W3C(r) Software License [1] in the hope that
+ * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ *
+ * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
+ */
+
+package org.w3c.dom.svg;
+
+import org.w3c.css.om.CSSStyleDeclaration;
+
+/**
+ * This interface is implemented on all objects corresponding to SVG elements
+ * that can have <code>style</code>, <code>class</code> and presentation
+ * attributes specified on them.
+ */
+public interface SVGStylableP<V> {
+
+	/**
+	 * Gets the attribute {@code class} on this element.
+	 * 
+	 * @return the attribute {@code class}.
+	 */
+	SVGAnimatedString getClassName();
+
+	/**
+	 * Gets the inline style of this element.
+	 * 
+	 * @return the inline style.
+	 */
+	CSSStyleDeclaration getStyle();
+
+	/**
+	 * Returns the base value of a given presentation attribute as an object of type
+	 * {@code V}.
+	 * 
+	 * @param name the presentation attribute.
+	 * @return the given presentation attribute as an object.
+	 */
+	@Deprecated
+	V getPresentationAttribute(String name);
+
+}