- java.lang.Object
-
- java.awt.dnd.DropTarget
-
- All Implemented Interfaces:
DropTargetListener,Serializable,EventListener
public class DropTarget extends Object implements DropTargetListener, Serializable
TheDropTargetis associated with aComponentwhen thatComponentwishes to accept drops during Drag and Drop operations.Each
DropTargetis associated with aFlavorMap. The defaultFlavorMaphereafter designates theFlavorMapreturned bySystemFlavorMap.getDefaultFlavorMap().- Since:
- 1.2
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classDropTarget.DropTargetAutoScrollerthis protected nested class implements autoscrolling
-
Constructor Summary
Constructors Constructor Description DropTarget()Creates aDropTarget.DropTarget(Component c, int ops, DropTargetListener dtl)Creates aDropTargetgiven theComponentto associate itself with, anintrepresenting the default acceptable action(s) to support, and aDropTargetListenerto handle event processing.DropTarget(Component c, int ops, DropTargetListener dtl, boolean act)Creates aDropTargetgiven theComponentto associate itself with, anintrepresenting the default acceptable action(s) to support, aDropTargetListenerto handle event processing, and abooleanindicating if theDropTargetis currently accepting drops.DropTarget(Component c, int ops, DropTargetListener dtl, boolean act, FlavorMap fm)Creates a new DropTarget given theComponentto associate itself with, anintrepresenting the default acceptable action(s) to support, aDropTargetListenerto handle event processing, abooleanindicating if theDropTargetis currently accepting drops, and aFlavorMapto use (or null for the defaultFlavorMap).DropTarget(Component c, DropTargetListener dtl)Creates aDropTargetgiven theComponentto associate itself with, and theDropTargetListenerto handle event processing.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDropTargetListener(DropTargetListener dtl)Adds a newDropTargetListener(UNICAST SOURCE).voidaddNotify()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 voidclearAutoscroll()clear autoscrollingprotected DropTarget.DropTargetAutoScrollercreateDropTargetAutoScroller(Component c, Point p)create an embedded autoscrollerprotected DropTargetContextcreateDropTargetContext()Creates the DropTargetContext associated with this DropTarget.voiddragEnter(DropTargetDragEvent dtde)CallsdragEnteron the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent.voiddragExit(DropTargetEvent dte)CallsdragExiton the registeredDropTargetListenerand passes it the specifiedDropTargetEvent.voiddragOver(DropTargetDragEvent dtde)CallsdragOveron the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent.voiddrop(DropTargetDropEvent dtde)Callsdropon the registeredDropTargetListenerand passes it the specifiedDropTargetDropEventif thisDropTargetis active.voiddropActionChanged(DropTargetDragEvent dtde)CallsdropActionChangedon the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent.ComponentgetComponent()Gets theComponentassociated with thisDropTarget.intgetDefaultActions()Gets anintrepresenting the current action(s) supported by thisDropTarget.DropTargetContextgetDropTargetContext()Gets theDropTargetContextassociated with thisDropTarget.FlavorMapgetFlavorMap()Gets theFlavorMapassociated with thisDropTarget.protected voidinitializeAutoscrolling(Point p)initialize autoscrollingbooleanisActive()Reports whether or not thisDropTargetis currently active (ready to accept drops).voidremoveDropTargetListener(DropTargetListener dtl)Removes the currentDropTargetListener(UNICAST SOURCE).voidremoveNotify()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.voidsetActive(boolean isActive)Sets the DropTarget active iftrue, inactive iffalse.voidsetComponent(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);voidsetDefaultActions(int ops)Sets the default acceptable actions for thisDropTargetvoidsetFlavorMap(FlavorMap fm)Sets theFlavorMapassociated with thisDropTarget.protected voidupdateAutoscroll(Point dragCursorLocn)update autoscrolling with current cursor location
-
-
-
Constructor Detail
-
DropTarget
public DropTarget(Component c, int ops, DropTargetListener dtl, boolean act, FlavorMap fm) throws HeadlessException
Creates a new DropTarget given theComponentto associate itself with, anintrepresenting the default acceptable action(s) to support, aDropTargetListenerto handle event processing, abooleanindicating if theDropTargetis currently accepting drops, and aFlavorMapto use (or null for the defaultFlavorMap).The Component will receive drops only if it is enabled.
- Parameters:
c- TheComponentwith which thisDropTargetis associatedops- The default acceptable actions for thisDropTargetdtl- TheDropTargetListenerfor thisDropTargetact- Is theDropTargetaccepting drops.fm- TheFlavorMapto 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 aDropTargetgiven theComponentto associate itself with, anintrepresenting the default acceptable action(s) to support, aDropTargetListenerto handle event processing, and abooleanindicating if theDropTargetis currently accepting drops.The Component will receive drops only if it is enabled.
- Parameters:
c- TheComponentwith which thisDropTargetis associatedops- The default acceptable actions for thisDropTargetdtl- TheDropTargetListenerfor thisDropTargetact- Is theDropTargetaccepting drops.- Throws:
HeadlessException- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
DropTarget
public DropTarget() throws HeadlessExceptionCreates aDropTarget.- Throws:
HeadlessException- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
DropTarget
public DropTarget(Component c, DropTargetListener dtl) throws HeadlessException
Creates aDropTargetgiven theComponentto associate itself with, and theDropTargetListenerto handle event processing.The Component will receive drops only if it is enabled.
- Parameters:
c- TheComponentwith which thisDropTargetis associateddtl- TheDropTargetListenerfor thisDropTarget- Throws:
HeadlessException- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
DropTarget
public DropTarget(Component c, int ops, DropTargetListener dtl) throws HeadlessException
Creates aDropTargetgiven theComponentto associate itself with, anintrepresenting the default acceptable action(s) to support, and aDropTargetListenerto handle event processing.The Component will receive drops only if it is enabled.
- Parameters:
c- TheComponentwith which thisDropTargetis associatedops- The default acceptable actions for thisDropTargetdtl- TheDropTargetListenerfor 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 newComponentthisDropTargetis to be associated with.
-
getComponent
public Component getComponent()
Gets theComponentassociated 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 anintrepresenting 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 thisDropTargetis currently active (ready to accept drops).- Returns:
trueif active,falseif not
-
addDropTargetListener
public void addDropTargetListener(DropTargetListener dtl) throws TooManyListenersException
Adds a newDropTargetListener(UNICAST SOURCE).- Parameters:
dtl- The newDropTargetListener- Throws:
TooManyListenersException- if aDropTargetListeneris already added to thisDropTarget.
-
removeDropTargetListener
public void removeDropTargetListener(DropTargetListener dtl)
Removes the currentDropTargetListener(UNICAST SOURCE).- Parameters:
dtl- the DropTargetListener to deregister.
-
dragEnter
public void dragEnter(DropTargetDragEvent dtde)
CallsdragEnteron the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent. Has no effect if thisDropTargetis not active.- Specified by:
dragEnterin interfaceDropTargetListener- Parameters:
dtde- theDropTargetDragEvent- Throws:
NullPointerException- if thisDropTargetis active anddtdeisnull- See Also:
isActive()
-
dragOver
public void dragOver(DropTargetDragEvent dtde)
CallsdragOveron the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent. Has no effect if thisDropTargetis not active.- Specified by:
dragOverin interfaceDropTargetListener- Parameters:
dtde- theDropTargetDragEvent- Throws:
NullPointerException- if thisDropTargetis active anddtdeisnull- See Also:
isActive()
-
dropActionChanged
public void dropActionChanged(DropTargetDragEvent dtde)
CallsdropActionChangedon the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent. Has no effect if thisDropTargetis not active.- Specified by:
dropActionChangedin interfaceDropTargetListener- Parameters:
dtde- theDropTargetDragEvent- Throws:
NullPointerException- if thisDropTargetis active anddtdeisnull- See Also:
isActive()
-
dragExit
public void dragExit(DropTargetEvent dte)
CallsdragExiton the registeredDropTargetListenerand passes it the specifiedDropTargetEvent. Has no effect if thisDropTargetis 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:
dragExitin interfaceDropTargetListener- Parameters:
dte- theDropTargetEvent- See Also:
isActive()
-
drop
public void drop(DropTargetDropEvent dtde)
Callsdropon the registeredDropTargetListenerand passes it the specifiedDropTargetDropEventif thisDropTargetis active.- Specified by:
dropin interfaceDropTargetListener- Parameters:
dtde- theDropTargetDropEvent- Throws:
NullPointerException- ifdtdeis null and at least one of the following is true: thisDropTargetis not active, or there is no aDropTargetListenerregistered.- See Also:
isActive()
-
getFlavorMap
public FlavorMap getFlavorMap()
Gets theFlavorMapassociated with thisDropTarget. If noFlavorMaphas been set for thisDropTarget, it is associated with the defaultFlavorMap.- Returns:
- the FlavorMap for this DropTarget
-
setFlavorMap
public void setFlavorMap(FlavorMap fm)
Sets theFlavorMapassociated with thisDropTarget.- Parameters:
fm- the newFlavorMap, or null to associate the default FlavorMap with this DropTarget.
-
addNotify
public 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. 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.
-
removeNotify
public 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. 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.
-
getDropTargetContext
public DropTargetContext getDropTargetContext()
Gets theDropTargetContextassociated with thisDropTarget.- Returns:
- the
DropTargetContextassociated 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.- Returns:
- the DropTargetContext associated with this DropTarget
-
createDropTargetAutoScroller
protected DropTarget.DropTargetAutoScroller createDropTargetAutoScroller(Component c, Point p)
create an embedded autoscroller- Parameters:
c- theComponentp- thePoint- Returns:
- an embedded autoscroller
-
initializeAutoscrolling
protected void initializeAutoscrolling(Point p)
initialize autoscrolling- Parameters:
p- thePoint
-
updateAutoscroll
protected void updateAutoscroll(Point dragCursorLocn)
update autoscrolling with current cursor location- Parameters:
dragCursorLocn- thePoint
-
clearAutoscroll
protected void clearAutoscroll()
clear autoscrolling
-
-