/*
* Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.awt.dnd;
The DragSourceDropEvent is delivered
from the DragSourceContextPeer,
via the DragSourceContext, to the dragDropEnd
method of DragSourceListeners registered with that
DragSourceContext and with its associated
DragSource.
It contains sufficient information for the
originator of the operation
to provide appropriate feedback to the end user
when the operation completes.
Since: 1.2
/**
* The <code>DragSourceDropEvent</code> is delivered
* from the <code>DragSourceContextPeer</code>,
* via the <code>DragSourceContext</code>, to the <code>dragDropEnd</code>
* method of <code>DragSourceListener</code>s registered with that
* <code>DragSourceContext</code> and with its associated
* <code>DragSource</code>.
* It contains sufficient information for the
* originator of the operation
* to provide appropriate feedback to the end user
* when the operation completes.
* <P>
* @since 1.2
*/
public class DragSourceDropEvent extends DragSourceEvent {
private static final long serialVersionUID = -5571321229470821891L;
Construct a DragSourceDropEvent for a drop,
given the
DragSourceContext, the drop action,
and a boolean indicating if the drop was successful.
The coordinates for this DragSourceDropEvent
are not specified, so getLocation will return
null for this event.
The argument action should be one of DnDConstants
that represents a single action.
This constructor does not throw any exception for invalid action.
Params: - dsc – the
DragSourceContext
associated with this DragSourceDropEvent - action – the drop action
- success – a boolean indicating if the drop was successful
Throws: - IllegalArgumentException – if
dsc is null.
See Also:
/**
* Construct a <code>DragSourceDropEvent</code> for a drop,
* given the
* <code>DragSourceContext</code>, the drop action,
* and a <code>boolean</code> indicating if the drop was successful.
* The coordinates for this <code>DragSourceDropEvent</code>
* are not specified, so <code>getLocation</code> will return
* <code>null</code> for this event.
* <p>
* The argument <code>action</code> should be one of <code>DnDConstants</code>
* that represents a single action.
* This constructor does not throw any exception for invalid <code>action</code>.
*
* @param dsc the <code>DragSourceContext</code>
* associated with this <code>DragSourceDropEvent</code>
* @param action the drop action
* @param success a boolean indicating if the drop was successful
*
* @throws IllegalArgumentException if <code>dsc</code> is <code>null</code>.
*
* @see DragSourceEvent#getLocation
*/
public DragSourceDropEvent(DragSourceContext dsc, int action, boolean success) {
super(dsc);
dropSuccess = success;
dropAction = action;
}
Construct a DragSourceDropEvent for a drop, given the
DragSourceContext, the drop action, a boolean
indicating if the drop was successful, and coordinates.
The argument action should be one of DnDConstants
that represents a single action.
This constructor does not throw any exception for invalid action.
Params: - dsc – the
DragSourceContext
associated with this DragSourceDropEvent - action – the drop action
- success – a boolean indicating if the drop was successful
- x – the horizontal coordinate for the cursor location
- y – the vertical coordinate for the cursor location
Throws: - IllegalArgumentException – if
dsc is null.
Since: 1.4
/**
* Construct a <code>DragSourceDropEvent</code> for a drop, given the
* <code>DragSourceContext</code>, the drop action, a <code>boolean</code>
* indicating if the drop was successful, and coordinates.
* <p>
* The argument <code>action</code> should be one of <code>DnDConstants</code>
* that represents a single action.
* This constructor does not throw any exception for invalid <code>action</code>.
*
* @param dsc the <code>DragSourceContext</code>
* associated with this <code>DragSourceDropEvent</code>
* @param action the drop action
* @param success a boolean indicating if the drop was successful
* @param x the horizontal coordinate for the cursor location
* @param y the vertical coordinate for the cursor location
*
* @throws IllegalArgumentException if <code>dsc</code> is <code>null</code>.
*
* @since 1.4
*/
public DragSourceDropEvent(DragSourceContext dsc, int action,
boolean success, int x, int y) {
super(dsc, x, y);
dropSuccess = success;
dropAction = action;
}
Construct a DragSourceDropEvent
for a drag that does not result in a drop.
The coordinates for this DragSourceDropEvent
are not specified, so getLocation will return
null for this event.
Params: - dsc – the
DragSourceContext
Throws: - IllegalArgumentException – if
dsc is null.
See Also:
/**
* Construct a <code>DragSourceDropEvent</code>
* for a drag that does not result in a drop.
* The coordinates for this <code>DragSourceDropEvent</code>
* are not specified, so <code>getLocation</code> will return
* <code>null</code> for this event.
*
* @param dsc the <code>DragSourceContext</code>
*
* @throws IllegalArgumentException if <code>dsc</code> is <code>null</code>.
*
* @see DragSourceEvent#getLocation
*/
public DragSourceDropEvent(DragSourceContext dsc) {
super(dsc);
dropSuccess = false;
}
This method returns a boolean indicating
if the drop was successful.
Returns: true if the drop target accepted the drop and
successfully performed a drop action;
false if the drop target rejected the drop or
if the drop target accepted the drop, but failed to perform
a drop action.
/**
* This method returns a <code>boolean</code> indicating
* if the drop was successful.
*
* @return <code>true</code> if the drop target accepted the drop and
* successfully performed a drop action;
* <code>false</code> if the drop target rejected the drop or
* if the drop target accepted the drop, but failed to perform
* a drop action.
*/
public boolean getDropSuccess() { return dropSuccess; }
This method returns an int representing
the action performed by the target on the subject of the drop.
Returns: the action performed by the target on the subject of the drop
if the drop target accepted the drop and the target drop action
is supported by the drag source; otherwise,
DnDConstants.ACTION_NONE.
/**
* This method returns an <code>int</code> representing
* the action performed by the target on the subject of the drop.
*
* @return the action performed by the target on the subject of the drop
* if the drop target accepted the drop and the target drop action
* is supported by the drag source; otherwise,
* <code>DnDConstants.ACTION_NONE</code>.
*/
public int getDropAction() { return dropAction; }
/*
* fields
*/
true if the drop was successful.
@serial
/**
* <code>true</code> if the drop was successful.
*
* @serial
*/
private boolean dropSuccess;
The drop action.
@serial
/**
* The drop action.
*
* @serial
*/
private int dropAction = DnDConstants.ACTION_NONE;
}