001/*
002 * ============================================================================
003 * Copyright © 2002-2023 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 * Licensed to the public under the agreements of the GNU Lesser General Public
007 * License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *      http://www.gnu.org/licenses/lgpl.html
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations
015 * under the License.
016 */
017
018package org.tquadrat.foundation.svg;
019
020import static org.apiguardian.api.API.Status.STABLE;
021import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_Class;
022import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_Style;
023
024import java.util.List;
025
026import org.apiguardian.api.API;
027import org.tquadrat.foundation.annotation.ClassVersion;
028
029/**
030 *  SVG elements that allow the style attributes
031 *  {@value SVGUtils#SVGATTRIBUTE_Class} and
032 *  {@value SVGUtils#SVGATTRIBUTE_Style}
033 *  will implement this interface.
034 *
035 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
036 *  @version $Id: AllowsStyleAttributes.java 1074 2023-10-02 12:05:06Z tquadrat $
037 *  @since 0.0.5
038 *
039 *  @UMLGraph.link
040 */
041@ClassVersion( sourceVersion = "$Id: AllowsStyleAttributes.java 1074 2023-10-02 12:05:06Z tquadrat $" )
042@API( status = STABLE, since = "0.0.5" )
043public sealed interface AllowsStyleAttributes
044    permits SVG, SVGGroup, SVGLine, SVGPath, SVGRectangle, SVGSymbol, SVGTSpan, SVGText
045{
046        /*------------------------*\
047    ====** Static Initialisations **===========================================
048        \*------------------------*/
049    /**
050     *  The core attributes.
051     */
052    @SuppressWarnings( "StaticCollection" )
053    public static final List<String> STYLE_ATTRIBUTES = List.of( SVGATTRIBUTE_Class, SVGATTRIBUTE_Style );
054
055        /*---------*\
056    ====** Methods **==========================================================
057        \*---------*/
058    /**
059     *  Sets the CSS class for the SVG element.
060     *
061     *  @param  value   The name of a CSS class for this SVG element.
062     */
063    public void setClass( final CharSequence value );
064
065    /**
066     *  Sets the CSS style for the SVG element.
067     *
068     *  @param  value   A CSS style definition.
069     */
070    public void setStyle( final CharSequence value );
071}
072//  interface AllowsStyleAttributes
073
074/*
075 *  End of File
076 */