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;
021
022import org.apiguardian.api.API;
023import org.tquadrat.foundation.annotation.ClassVersion;
024import org.tquadrat.foundation.svg.internal.SVGUseImpl;
025import org.tquadrat.foundation.svg.type.SVGNumber;
026
027/**
028 *  The definition of the SVG element {@code <use>}. <br>
029 *  <br>A {@code <use>} element is useless without the attribute {@code href}
030 *  set; therefore it is required already on creation and will not appear in
031 *  this interface.
032 *
033 *  @see SVGUtils#createUse(java.net.URI)
034 *  @see SVGUtils#createUse(SVGElementWithChildren,java.net.URI)
035 *
036 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
037 *  @version $Id: SVGUse.java 1074 2023-10-02 12:05:06Z tquadrat $
038 *  @since 0.0.5
039 *
040 *  @see "https://www.w3.org/TR/SVG/single-page.html#struct-SVGElement"
041 *
042 *  @UMLGraph.link
043 */
044@ClassVersion( sourceVersion = "$Id: SVGUse.java 1074 2023-10-02 12:05:06Z tquadrat $" )
045@API( status = STABLE, since = "0.0.5" )
046public sealed interface SVGUse extends SVGElement, AllowsConditionalProcessingAttributes, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsXLinkAttributes
047    permits SVGElementAdapter, SVGUseImpl
048{
049        /*---------*\
050    ====** Methods **==========================================================
051        \*---------*/
052    /**
053     *  Sets the height of the cloned element.
054     *
055     *  @param  value   The type; if {@code null} the
056     *      attribute will be removed.
057     */
058    @SuppressWarnings( "UseOfConcreteClass" )
059    public void setHeight( final SVGNumber value );
060
061    /**
062     *  Sets the width of the cloned element.
063     *
064     *  @param  value   The type; if {@code null} the
065     *      attribute will be removed.
066     */
067    @SuppressWarnings( "UseOfConcreteClass" )
068    public void setWidth( final SVGNumber value );
069
070    /**
071     *  Sets the x coordinate for the top left corner of the cloned element.
072     *
073     *  @param  value   The type; if {@code null} the
074     *      attribute will be removed.
075     */
076    @SuppressWarnings( "UseOfConcreteClass" )
077    public void setX( final SVGNumber value );
078
079    /**
080     *  Sets the y coordinate for the top left corner of the cloned element.
081     *
082     *  @param  value   The type; if {@code null} the
083     *      attribute will be removed.
084     */
085    @SuppressWarnings( "UseOfConcreteClass" )
086    public void setY( final SVGNumber value );
087}
088//  interface SVGUse
089
090/*
091 *  End of File
092 */