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.lang.Objects.requireNonNullArgument;
022import static org.tquadrat.foundation.svg.SVGUtils.number;
023
024import org.apiguardian.api.API;
025import org.tquadrat.foundation.annotation.ClassVersion;
026import org.tquadrat.foundation.svg.internal.SVGRectangleImpl;
027import org.tquadrat.foundation.svg.type.SVGNumber;
028import org.tquadrat.foundation.svg.type.SVGNumber.SVGUserUnitValue;
029
030/**
031 *  The definition for the SVG {@code <rect>} element.
032 *
033 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
034 *  @version $Id: SVGRectangle.java 1074 2023-10-02 12:05:06Z tquadrat $
035 *  @since 0.0.5
036 *
037 *  @UMLGraph.link
038 */
039@ClassVersion( sourceVersion = "$Id: SVGRectangle.java 1074 2023-10-02 12:05:06Z tquadrat $" )
040@API( status = STABLE, since = "0.0.5" )
041public sealed interface SVGRectangle extends SVGElementWithChildren, AllowsConditionalProcessingAttributes, AllowsGlobalEventAttributes, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes
042    permits SVGElementAdapter, SVGRectangleImpl
043{
044        /*---------*\
045    ====** Methods **==========================================================
046        \*---------*/
047    /**
048     *  Sets the start and end points for this line.
049     *
050     *  @param  x   The x coordinate for the upper left corner of the
051     *      rectangle.
052     *  @param  y  The y coordinate for the upper left corner of the
053     *      rectangle.
054     *  @param  width   The width of the rectangle.
055     *  @param  height  The height of the rectangle.
056     */
057    @SuppressWarnings( "UseOfConcreteClass" )
058    public default void defineRectangle( final SVGNumber x, final SVGNumber y, final SVGNumber width, final SVGNumber height )
059    {
060        setX( requireNonNullArgument( x, "x" ) );
061        setY( requireNonNullArgument( y, "y" ) );
062        setWidth( requireNonNullArgument( width, "width" ) );
063        setHeight( requireNonNullArgument( height, "height" ) );
064    }   //  defineLine()
065
066    /**
067     *  Sets the height for this SVG {@code <rect>} element.
068     *
069     *  @param  value   The height.
070     */
071    public void setHeight( @SuppressWarnings( "UseOfConcreteClass" ) final SVGNumber value );
072
073    /**
074     *  Sets the length of the path represented by this SVG {@code <rect>}
075     *  element.
076     *
077     *  @param  length  The author's computation of the total length of the
078     *      path, in user units. This type is used to calibrate the user
079     *      agent's own distance-along-a-path calculations with that of the
080     *      author. The user agent will scale all distance-along-a-path
081     *      computations by the ratio of this type to the user agent's own
082     *      computed type for total path length.<br>
083     *      <br>A type of zero is valid, but a negative type is an error.
084     *
085     *  @throws IllegalArgumentException    The type is less than 0.
086     */
087    public void setPathLength( @SuppressWarnings( "UseOfConcreteClass" ) final SVGUserUnitValue length );
088
089    /**
090     *  Sets the length of the path represented by this SVG {@code <rect>}
091     *  element.
092     *
093     *  @param  length  The author's computation of the total length of the
094     *      path, in user units. This type is used to calibrate the user
095     *      agent's own distance-along-a-path calculations with that of the
096     *      author. The user agent will scale all distance-along-a-path
097     *      computations by the ratio of this type to the user agent's own
098     *      computed type for total path length.<br>
099     *      <br>A type of zero is valid, but a negative type is an error.
100     *
101     *  @throws IllegalArgumentException    The type is less than 0.
102     */
103    public default void setPathLength( final double length ) { setPathLength( number( length ) ); }
104
105    /**
106     *  Sets the length of the path represented by this SVG {@code <rect>}
107     *  element.
108     *
109     *  @param  length  The author's computation of the total length of the
110     *      path, in user units. This type is used to calibrate the user
111     *      agent's own distance-along-a-path calculations with that of the
112     *      author. The user agent will scale all distance-along-a-path
113     *      computations by the ratio of this type to the user agent's own
114     *      computed type for total path length.<br>
115     *      <br>A type of zero is valid, but a negative type is an error.
116     *
117     *  @throws IllegalArgumentException    The type is less than 0.
118     */
119    public default void setPathLength( final long length ) { setPathLength( number( length ) ); }
120
121    /**
122     *  Sets the horizontal corner radius for this SVG {@code <rect>} element.
123     *
124     *  @param  value   The horizontal corner radius.
125     */
126    public void setRx( @SuppressWarnings( "UseOfConcreteClass" ) final SVGNumber value );
127
128    /**
129     *  Sets the vertical corner radius for this SVG {@code <rect>} element.
130     *
131     *  @param  value   The vertical corner radius.
132     */
133    public void setRy( @SuppressWarnings( "UseOfConcreteClass" ) final SVGNumber value );
134
135    /**
136     *  Sets the width for this SVG {@code <rect>} element.
137     *
138     *  @param  value   The width.
139     */
140    public void setWidth( @SuppressWarnings( "UseOfConcreteClass" ) final SVGNumber value );
141
142    /**
143     *  Sets the x coordinate for the upper left corner of the rectangle.
144     *
145     *  @param  value   The x coordinate.
146     */
147    public void setX( @SuppressWarnings( "UseOfConcreteClass" ) final SVGNumber value );
148
149    /**
150     *  Sets the y coordinate for the upper left corner of the rectangle.
151     *
152     *  @param  value   The y coordinate.
153     */
154    public void setY( @SuppressWarnings( "UseOfConcreteClass" ) final SVGNumber value );
155}
156//  interface SVGRectangle
157
158/*
159 *  End of File
160 */