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_OnCopy;
022import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_OnCut;
023import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_OnPaste;
024
025import java.util.List;
026
027import org.apiguardian.api.API;
028import org.tquadrat.foundation.annotation.ClassVersion;
029
030/**
031 *  SVG elements that allow the document element event attributes
032 *  {@value SVGUtils#SVGATTRIBUTE_OnCopy},
033 *  {@value SVGUtils#SVGATTRIBUTE_OnCut},
034 *  and
035 *  {@value SVGUtils#SVGATTRIBUTE_OnPaste}
036 *  will implement this interface.
037 *
038 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
039 *  @version $Id: AllowsDocumentElementEventAttributes.java 1074 2023-10-02 12:05:06Z tquadrat $
040 *  @since 0.0.5
041 *
042 *  @UMLGraph.link
043 */
044@ClassVersion( sourceVersion = "$Id: AllowsDocumentElementEventAttributes.java 1074 2023-10-02 12:05:06Z tquadrat $" )
045@API( status = STABLE, since = "0.0.5" )
046public sealed interface AllowsDocumentElementEventAttributes
047    permits SVG, SVGElementAdapter
048{
049        /*------------------------*\
050    ====** Static Initialisations **===========================================
051        \*------------------------*/
052    /**
053     *  The document element event attributes.
054     */
055    @SuppressWarnings( "StaticCollection" )
056    public static final List<String> DOCUMENTELEMENTEVENT_ATTRIBUTES = List.of(
057        SVGATTRIBUTE_OnCopy,
058        SVGATTRIBUTE_OnCut,
059        SVGATTRIBUTE_OnPaste
060    );
061
062        /*---------*\
063    ====** Methods **==========================================================
064        \*---------*/
065    /**
066     *  Sets the copy handler for this SVG element.
067     *
068     *  @param  value   The copy handler.
069     *
070     *  @see SVGUtils#SVGATTRIBUTE_OnCopy
071     */
072    public void setCopyHandler( final String value );
073
074    /**
075     *  Sets the cut handler for this SVG element.
076     *
077     *  @param  value   The cut handler.
078     *
079     *  @see SVGUtils#SVGATTRIBUTE_OnCut
080     */
081    public void setCutHandler( final String value );
082
083    /**
084     *  Sets the paste handler for this SVG element.
085     *
086     *  @param  value   The paste handler.
087     *
088     *  @see SVGUtils#SVGATTRIBUTE_OnPaste
089     */
090    public void setPasteHandler( final String value );
091}
092//  interface AllowsDocumentElementEventAttributes
093
094/*
095 *  End of File
096 */