- java.lang.Object
-
- java.awt.dnd.DropTarget
-
- All Implemented Interfaces:
- DropTargetListener, Serializable, EventListener
public class DropTarget extends Object implements DropTargetListener, Serializable
TheDropTarget
is associated with aComponent
when thatComponent
wishes to accept drops during Drag and Drop operations.Each
DropTarget
is associated with aFlavorMap
. The defaultFlavorMap
hereafter designates theFlavorMap
returned bySystemFlavorMap.getDefaultFlavorMap()
.- Since:
- 1.2
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description protected static class
DropTarget.DropTargetAutoScroller
this protected nested class implements autoscrolling
-
Constructor Summary
Constructors Constructor and Description DropTarget()
Creates aDropTarget
.DropTarget(Component c, DropTargetListener dtl)
Creates aDropTarget
given theComponent
to associate itself with, and theDropTargetListener
to handle event processing.DropTarget(Component c, int ops, DropTargetListener dtl)
Creates aDropTarget
given theComponent
to associate itself with, anint
representing the default acceptable action(s) to support, and aDropTargetListener
to handle event processing.DropTarget(Component c, int ops, DropTargetListener dtl, boolean act)
Creates aDropTarget
given theComponent
to associate itself with, anint
representing the default acceptable action(s) to support, aDropTargetListener
to handle event processing, and aboolean
indicating if theDropTarget
is currently accepting drops.DropTarget(Component c, int ops, DropTargetListener dtl, boolean act, FlavorMap fm)
Creates a new DropTarget given theComponent
to associate itself with, anint
representing the default acceptable action(s) to support, aDropTargetListener
to handle event processing, aboolean
indicating if theDropTarget
is currently accepting drops, and aFlavorMap
to use (or null for the defaultFlavorMap
).
-
Method Summary
Methods Modifier and Type Method and Description void
addDropTargetListener(DropTargetListener dtl)
Adds a newDropTargetListener
(UNICAST SOURCE).void
addNotify(java.awt.peer.ComponentPeer peer)
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 autoscrollingprotected DropTarget.DropTargetAutoScroller
createDropTargetAutoScroller(Component c, Point p)
create an embedded autoscrollerprotected DropTargetContext
createDropTargetContext()
Creates the DropTargetContext associated with this DropTarget.void
dragEnter(DropTargetDragEvent dtde)
CallsdragEnter
on the registeredDropTargetListener
and passes it the specifiedDropTargetDragEvent
.void
dragExit(DropTargetEvent dte)
CallsdragExit
on the registeredDropTargetListener
and passes it the specifiedDropTargetEvent
.void
dragOver(DropTargetDragEvent dtde)
CallsdragOver
on the registeredDropTargetListener
and passes it the specifiedDropTargetDragEvent
.void
drop(DropTargetDropEvent dtde)
Callsdrop
on the registeredDropTargetListener
and passes it the specifiedDropTargetDropEvent
if thisDropTarget
is active.void
dropActionChanged(DropTargetDragEvent dtde)
CallsdropActionChanged
on the registeredDropTargetListener
and passes it the specifiedDropTargetDragEvent
.Component
getComponent()
Gets theComponent
associated with thisDropTarget
.int
getDefaultActions()
Gets anint
representing the current action(s) supported by thisDropTarget
.DropTargetContext
getDropTargetContext()
Gets theDropTargetContext
associated with thisDropTarget
.FlavorMap
getFlavorMap()
Gets theFlavorMap
associated with thisDropTarget
.protected void
initializeAutoscrolling(Point p)
initialize autoscrollingboolean
isActive()
Reports whether or not thisDropTarget
is currently active (ready to accept drops).void
removeDropTargetListener(DropTargetListener dtl)
Removes the currentDropTargetListener
(UNICAST SOURCE).void
removeNotify(java.awt.peer.ComponentPeer peer)
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(boolean isActive)
Sets the DropTarget active iftrue
, inactive iffalse
.void
setComponent(Component c)
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);
ordroptarget.setComponent(component);
void
setDefaultActions(int ops)
Sets the default acceptable actions for thisDropTarget
void
setFlavorMap(FlavorMap fm)
Sets theFlavorMap
associated with thisDropTarget
.protected void
updateAutoscroll(Point dragCursorLocn)
update autoscrolling with current cursor locn
-
-
-
Constructor Detail
-
DropTarget
public DropTarget(Component c, int ops, DropTargetListener dtl, boolean act, FlavorMap fm) throws HeadlessException
Creates a new DropTarget given theComponent
to associate itself with, anint
representing the default acceptable action(s) to support, aDropTargetListener
to handle event processing, aboolean
indicating if theDropTarget
is currently accepting drops, and aFlavorMap
to use (or null for the defaultFlavorMap
).The Component will receive drops only if it is enabled.
- Parameters:
c
- TheComponent
with which thisDropTarget
is associatedops
- The default acceptable actions for thisDropTarget
dtl
- TheDropTargetListener
for thisDropTarget
act
- Is theDropTarget
accepting drops.fm
- TheFlavorMap
to use, or null for the defaultFlavorMap
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
DropTarget
public DropTarget(Component c, int ops, DropTargetListener dtl, boolean act) throws HeadlessException
Creates aDropTarget
given theComponent
to associate itself with, anint
representing the default acceptable action(s) to support, aDropTargetListener
to handle event processing, and aboolean
indicating if theDropTarget
is currently accepting drops.The Component will receive drops only if it is enabled.
- Parameters:
c
- TheComponent
with which thisDropTarget
is associatedops
- The default acceptable actions for thisDropTarget
dtl
- TheDropTargetListener
for thisDropTarget
act
- Is theDropTarget
accepting drops.- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
DropTarget
public DropTarget() throws HeadlessException
Creates aDropTarget
.- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
DropTarget
public DropTarget(Component c, DropTargetListener dtl) throws HeadlessException
Creates aDropTarget
given theComponent
to associate itself with, and theDropTargetListener
to handle event processing.The Component will receive drops only if it is enabled.
- Parameters:
c
- TheComponent
with which thisDropTarget
is associateddtl
- TheDropTargetListener
for thisDropTarget
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
DropTarget
public DropTarget(Component c, int ops, DropTargetListener dtl) throws HeadlessException
Creates aDropTarget
given theComponent
to associate itself with, anint
representing the default acceptable action(s) to support, and aDropTargetListener
to handle event processing.The Component will receive drops only if it is enabled.
- Parameters:
c
- TheComponent
with which thisDropTarget
is associatedops
- The default acceptable actions for thisDropTarget
dtl
- TheDropTargetListener
for thisDropTarget
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
-
Method Detail
-
setComponent
public void setComponent(Component c)
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);
ordroptarget.setComponent(component);
The Component will receive drops only if it is enabled.
- Parameters:
c
- The newComponent
thisDropTarget
is to be associated with.
-
getComponent
public Component getComponent()
Gets theComponent
associated with thisDropTarget
.- Returns:
- the current
Component
-
setDefaultActions
public void setDefaultActions(int ops)
Sets the default acceptable actions for thisDropTarget
- Parameters:
ops
- the default actions- See Also:
DnDConstants
-
getDefaultActions
public int getDefaultActions()
Gets anint
representing the current action(s) supported by thisDropTarget
.- Returns:
- the current default actions
-
setActive
public void setActive(boolean isActive)
Sets the DropTarget active iftrue
, inactive iffalse
.- Parameters:
isActive
- sets theDropTarget
(in)active.
-
isActive
public boolean isActive()
Reports whether or not thisDropTarget
is currently active (ready to accept drops).- Returns:
true
if active,false
if not
-
addDropTargetListener
public void addDropTargetListener(DropTargetListener dtl) throws TooManyListenersException
Adds a newDropTargetListener
(UNICAST SOURCE).- Parameters:
dtl
- The newDropTargetListener
- Throws:
- if aTooManyListenersException
DropTargetListener
is already added to thisDropTarget
.TooManyListenersException
-
removeDropTargetListener
public void removeDropTargetListener(DropTargetListener dtl)
Removes the currentDropTargetListener
(UNICAST SOURCE).- Parameters:
dtl
- the DropTargetListener to deregister.
-
dragEnter
public void dragEnter(DropTargetDragEvent dtde)
CallsdragEnter
on the registeredDropTargetListener
and passes it the specifiedDropTargetDragEvent
. Has no effect if thisDropTarget
is not active.- Specified by:
dragEnter
in interfaceDropTargetListener
- Parameters:
dtde
- theDropTargetDragEvent
- Throws:
NullPointerException
- if thisDropTarget
is active anddtde
isnull
- See Also:
isActive()
-
dragOver
public void dragOver(DropTargetDragEvent dtde)
CallsdragOver
on the registeredDropTargetListener
and passes it the specifiedDropTargetDragEvent
. Has no effect if thisDropTarget
is not active.- Specified by:
dragOver
in interfaceDropTargetListener
- Parameters:
dtde
- theDropTargetDragEvent
- Throws:
NullPointerException
- if thisDropTarget
is active anddtde
isnull
- See Also:
isActive()
-
dropActionChanged
public void dropActionChanged(DropTargetDragEvent dtde)
CallsdropActionChanged
on the registeredDropTargetListener
and passes it the specifiedDropTargetDragEvent
. Has no effect if thisDropTarget
is not active.- Specified by:
dropActionChanged
in interfaceDropTargetListener
- Parameters:
dtde
- theDropTargetDragEvent
- Throws:
NullPointerException
- if thisDropTarget
is active anddtde
isnull
- See Also:
isActive()
-
dragExit
public void dragExit(DropTargetEvent dte)
CallsdragExit
on the registeredDropTargetListener
and passes it the specifiedDropTargetEvent
. Has no effect if thisDropTarget
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.
- Specified by:
dragExit
in interfaceDropTargetListener
- Parameters:
dte
- theDropTargetEvent
- See Also:
isActive()
-
drop
public void drop(DropTargetDropEvent dtde)
Callsdrop
on the registeredDropTargetListener
and passes it the specifiedDropTargetDropEvent
if thisDropTarget
is active.- Specified by:
drop
in interfaceDropTargetListener
- Parameters:
dtde
- theDropTargetDropEvent
- Throws:
NullPointerException
- ifdtde
is null and at least one of the following is true: thisDropTarget
is not active, or there is no aDropTargetListener
registered.- See Also:
isActive()
-
getFlavorMap
public FlavorMap getFlavorMap()
Gets theFlavorMap
associated with thisDropTarget
. If noFlavorMap
has been set for thisDropTarget
, it is associated with the defaultFlavorMap
.- Returns:
- the FlavorMap for this DropTarget
-
setFlavorMap
public void setFlavorMap(FlavorMap fm)
Sets theFlavorMap
associated with thisDropTarget
.- Parameters:
fm
- the newFlavorMap
, or null to associate the default FlavorMap with this DropTarget.
-
addNotify
public void addNotify(java.awt.peer.ComponentPeer peer)
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. Calling this method, other than to notify this DropTarget of the association of the ComponentPeer with the Component may result in a malfunction of the DnD system.- Parameters:
peer
- The Peer of the Component we are associated with!
-
removeNotify
public void removeNotify(java.awt.peer.ComponentPeer peer)
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. Calling this method, other than to notify this DropTarget of the disassociation of the ComponentPeer from the Component may result in a malfunction of the DnD system.- Parameters:
peer
- The Peer of the Component we are being disassociated from!
-
getDropTargetContext
public DropTargetContext getDropTargetContext()
Gets theDropTargetContext
associated with thisDropTarget
.- Returns:
- the
DropTargetContext
associated with thisDropTarget
.
-
createDropTargetContext
protected DropTargetContext createDropTargetContext()
Creates the DropTargetContext associated with this DropTarget. Subclasses may override this method to instantiate their own DropTargetContext subclass. This call is typically *only* called by the platform's DropTargetContextPeer as a drag operation encounters this DropTarget. Accessing the Context while no Drag is current has undefined results.
-
createDropTargetAutoScroller
protected DropTarget.DropTargetAutoScroller createDropTargetAutoScroller(Component c, Point p)
create an embedded autoscroller- Parameters:
c
- theComponent
p
- thePoint
-
initializeAutoscrolling
protected void initializeAutoscrolling(Point p)
initialize autoscrolling- Parameters:
p
- thePoint
-
updateAutoscroll
protected void updateAutoscroll(Point dragCursorLocn)
update autoscrolling with current cursor locn- Parameters:
dragCursorLocn
- thePoint
-
clearAutoscroll
protected void clearAutoscroll()
clear autoscrolling
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
24/11/2024 13:26:28 Cette version de la page est en cache (à la date du 24/11/2024 13:26:28) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 29/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/awt/dnd/DropTarget.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.