DropTargetListener
, Serializable
, EventListener
public class DropTarget extends Object implements DropTargetListener, Serializable
DropTarget
is associated with a Component
when that Component
wishes to accept drops during Drag and Drop operations. Each DropTarget
is associated with a FlavorMap
. The default FlavorMap
hereafter designates the FlavorMap
returned by SystemFlavorMap.getDefaultFlavorMap()
.
Modifier and Type | Class | Description |
---|---|---|
protected static class |
DropTarget.DropTargetAutoScroller |
this protected nested class implements autoscrolling |
Constructor | Description |
---|---|
DropTarget() |
Creates a DropTarget . |
DropTarget |
Creates a DropTarget given the Component to associate itself with, an int representing the default acceptable action(s) to support, and a DropTargetListener to handle event processing. |
DropTarget |
Creates a DropTarget given the Component to associate itself with, an int representing the default acceptable action(s) to support, a DropTargetListener to handle event processing, and a boolean indicating if the DropTarget is currently accepting drops. |
DropTarget |
Creates a new DropTarget given the Component to associate itself with, an int representing the default acceptable action(s) to support, a DropTargetListener to handle event processing, a boolean indicating if the DropTarget is currently accepting drops, and a FlavorMap to use (or null for the default FlavorMap ). |
DropTarget |
Creates a DropTarget given the Component to associate itself with, and the DropTargetListener to handle event processing. |
Modifier and Type | Method | Description |
---|---|---|
void |
addDropTargetListener |
Adds a new DropTargetListener (UNICAST SOURCE). |
void |
addNotify() |
Notify the DropTarget that it has been associated with a Component This method is usually called from java.awt.Component.addNotify() of the Component associated with this DropTarget to notify the DropTarget that a ComponentPeer has been associated with that Component. |
protected void |
clearAutoscroll() |
clear autoscrolling |
protected DropTarget.DropTargetAutoScroller |
createDropTargetAutoScroller |
create an embedded autoscroller |
protected DropTargetContext |
createDropTargetContext() |
Creates the DropTargetContext associated with this DropTarget. |
void |
dragEnter |
Calls dragEnter on the registered DropTargetListener and passes it the specified DropTargetDragEvent . |
void |
dragExit |
Calls dragExit on the registered DropTargetListener and passes it the specified DropTargetEvent . |
void |
dragOver |
Calls dragOver on the registered DropTargetListener and passes it the specified DropTargetDragEvent . |
void |
drop |
Calls drop on the registered DropTargetListener and passes it the specified DropTargetDropEvent if this DropTarget is active. |
void |
dropActionChanged |
Calls dropActionChanged on the registered DropTargetListener and passes it the specified DropTargetDragEvent . |
Component |
getComponent() |
Gets the Component associated with this DropTarget . |
int |
getDefaultActions() |
Gets an int representing the current action(s) supported by this DropTarget . |
DropTargetContext |
getDropTargetContext() |
Gets the DropTargetContext associated with this DropTarget . |
FlavorMap |
getFlavorMap() |
Gets the FlavorMap associated with this DropTarget . |
protected void |
initializeAutoscrolling |
initialize autoscrolling |
boolean |
isActive() |
Reports whether or not this DropTarget is currently active (ready to accept drops). |
void |
removeDropTargetListener |
Removes the current DropTargetListener (UNICAST SOURCE). |
void |
removeNotify() |
Notify the DropTarget that it has been disassociated from a Component This method is usually called from java.awt.Component.removeNotify() of the Component associated with this DropTarget to notify the DropTarget that a ComponentPeer has been disassociated with that Component. |
void |
setActive |
Sets the DropTarget active if true , inactive if false . |
void |
setComponent |
Note: this interface is required to permit the safe association of a DropTarget with a Component in one of two ways, either: component.setDropTarget(droptarget); or droptarget.setComponent(component);
|
void |
setDefaultActions |
Sets the default acceptable actions for this DropTarget
|
void |
setFlavorMap |
Sets the FlavorMap associated with this DropTarget . |
protected void |
updateAutoscroll |
update autoscrolling with current cursor location |
public DropTarget(Component c, int ops, DropTargetListener dtl, boolean act, FlavorMap fm) throws HeadlessException
Component
to associate itself with, an int
representing the default acceptable action(s) to support, a DropTargetListener
to handle event processing, a boolean
indicating if the DropTarget
is currently accepting drops, and a FlavorMap
to use (or null for the default FlavorMap
). The Component will receive drops only if it is enabled.
c
- The Component
with which this DropTarget
is associatedops
- The default acceptable actions for this DropTarget
dtl
- The DropTargetListener
for this DropTarget
act
- Is the DropTarget
accepting drops.fm
- The FlavorMap
to use, or null for the default FlavorMap
HeadlessException
- if GraphicsEnvironment.isHeadless() returns truepublic DropTarget(Component c, int ops, DropTargetListener dtl, boolean act) throws HeadlessException
DropTarget
given the Component
to associate itself with, an int
representing the default acceptable action(s) to support, a DropTargetListener
to handle event processing, and a boolean
indicating if the DropTarget
is currently accepting drops. The Component will receive drops only if it is enabled.
c
- The Component
with which this DropTarget
is associatedops
- The default acceptable actions for this DropTarget
dtl
- The DropTargetListener
for this DropTarget
act
- Is the DropTarget
accepting drops.HeadlessException
- if GraphicsEnvironment.isHeadless() returns truepublic DropTarget() throws HeadlessException
DropTarget
.HeadlessException
- if GraphicsEnvironment.isHeadless() returns truepublic DropTarget(Component c, DropTargetListener dtl) throws HeadlessException
DropTarget
given the Component
to associate itself with, and the DropTargetListener
to handle event processing. The Component will receive drops only if it is enabled.
c
- The Component
with which this DropTarget
is associateddtl
- The DropTargetListener
for this DropTarget
HeadlessException
- if GraphicsEnvironment.isHeadless() returns truepublic DropTarget(Component c, int ops, DropTargetListener dtl) throws HeadlessException
DropTarget
given the Component
to associate itself with, an int
representing the default acceptable action(s) to support, and a DropTargetListener
to handle event processing. The Component will receive drops only if it is enabled.
c
- The Component
with which this DropTarget
is associatedops
- The default acceptable actions for this DropTarget
dtl
- The DropTargetListener
for this DropTarget
HeadlessException
- if GraphicsEnvironment.isHeadless() returns truepublic void setComponent(Component c)
component.setDropTarget(droptarget);
or droptarget.setComponent(component);
The Component will receive drops only if it is enabled.
c
- The new Component
this DropTarget
is to be associated with.public Component getComponent()
Component
associated with this DropTarget
.Component
public void setDefaultActions(int ops)
DropTarget
ops
- the default actionspublic int getDefaultActions()
int
representing the current action(s) supported by this DropTarget
.public void setActive(boolean isActive)
true
, inactive if false
.isActive
- sets the DropTarget
(in)active.public boolean isActive()
DropTarget
is currently active (ready to accept drops).true
if active, false
if notpublic void addDropTargetListener(DropTargetListener dtl) throws TooManyListenersException
DropTargetListener
(UNICAST SOURCE).dtl
- The new DropTargetListener
TooManyListenersException
- if a DropTargetListener
is already added to this DropTarget
.public void removeDropTargetListener(DropTargetListener dtl)
DropTargetListener
(UNICAST SOURCE).dtl
- the DropTargetListener to deregister.public void dragEnter(DropTargetDragEvent dtde)
dragEnter
on the registered DropTargetListener
and passes it the specified DropTargetDragEvent
. Has no effect if this DropTarget
is not active.dragEnter
in interface DropTargetListener
dtde
- the DropTargetDragEvent
NullPointerException
- if this DropTarget
is active and dtde
is null
public void dragOver(DropTargetDragEvent dtde)
dragOver
on the registered DropTargetListener
and passes it the specified DropTargetDragEvent
. Has no effect if this DropTarget
is not active.dragOver
in interface DropTargetListener
dtde
- the DropTargetDragEvent
NullPointerException
- if this DropTarget
is active and dtde
is null
public void dropActionChanged(DropTargetDragEvent dtde)
dropActionChanged
on the registered DropTargetListener
and passes it the specified DropTargetDragEvent
. Has no effect if this DropTarget
is not active.dropActionChanged
in interface DropTargetListener
dtde
- the DropTargetDragEvent
NullPointerException
- if this DropTarget
is active and dtde
is null
public void dragExit(DropTargetEvent dte)
dragExit
on the registered DropTargetListener
and passes it the specified DropTargetEvent
. Has no effect if this DropTarget
is not active. This method itself does not throw any exception for null parameter but for exceptions thrown by the respective method of the listener.
dragExit
in interface DropTargetListener
dte
- the DropTargetEvent
public void drop(DropTargetDropEvent dtde)
drop
on the registered DropTargetListener
and passes it the specified DropTargetDropEvent
if this DropTarget
is active.drop
in interface DropTargetListener
dtde
- the DropTargetDropEvent
NullPointerException
- if dtde
is null and at least one of the following is true: this DropTarget
is not active, or there is no a DropTargetListener
registered.public FlavorMap getFlavorMap()
FlavorMap
associated with this DropTarget
. If no FlavorMap
has been set for this DropTarget
, it is associated with the default FlavorMap
.public void setFlavorMap(FlavorMap fm)
FlavorMap
associated with this DropTarget
.fm
- the new FlavorMap
, or null to associate the default FlavorMap with this DropTarget.public void addNotify()
public void removeNotify()
public DropTargetContext getDropTargetContext()
DropTargetContext
associated with this DropTarget
.DropTargetContext
associated with this DropTarget
.protected DropTargetContext createDropTargetContext()
protected DropTarget.DropTargetAutoScroller createDropTargetAutoScroller(Component c, Point p)
c
- the Component
p
- the Point
protected void initializeAutoscrolling(Point p)
p
- the Point
protected void updateAutoscroll(Point dragCursorLocn)
dragCursorLocn
- the Point
protected void clearAutoscroll()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/dnd/DropTarget.html