001/* An interface to be implemented by the entities that specifically handle
002 drag-and-drop events.
003
004 Copyright (c) 2008-2014 The Regents of the University of California.
005 All rights reserved.
006 Permission is hereby granted, without written agreement and without
007 license or royalty fees, to use, copy, modify, and distribute this
008 software and its documentation for any purpose, provided that the above
009 copyright notice and the following two paragraphs appear in all copies
010 of this software.
011
012 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
013 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
014 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
015 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
016 SUCH DAMAGE.
017
018 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
019 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
021 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
022 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
023 ENHANCEMENTS, OR MODIFICATIONS.
024
025 PT_COPYRIGHT_VERSION_2
026 COPYRIGHTENDKEY
027
028 */
029package ptolemy.kernel.util;
030
031import java.util.List;
032
033//////////////////////////////////////////////////////////////////////////
034//// DropTargetHandler
035
036/**
037 An interface to be implemented by the entities that specifically handle
038 drag-and-drop events.
039
040 @author Thomas Huining Feng
041 @version $Id$
042 @since Ptolemy II 8.0
043 @Pt.ProposedRating Red (tfeng)
044 @Pt.AcceptedRating Red (tfeng)
045 */
046public interface DropTargetHandler {
047
048    /** React to a list of objects being dropped onto a target.
049     *
050     *  @param target The target on which the objects are dropped.
051     *  @param dropObjects The list of objects dropped onto the target.
052     *  @param moml The moml string generated for the dropped objects.
053     *  @exception IllegalActionException If the handling is unsuccessful.
054     */
055    public void dropObject(NamedObj target, List dropObjects, String moml)
056            throws IllegalActionException;
057}