java.lang.Object
java.awt.dnd.DropTarget
- All Implemented Interfaces:
- DropTargetListener,- Serializable,- EventListener
The 
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().
- Since:
- 1.2
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionprotected static classthis protected nested class implements autoscrolling
- 
Constructor SummaryConstructorsConstructorDescriptionCreates 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 SummaryModifier and TypeMethodDescriptionvoidAdds a newDropTargetListener(UNICAST SOURCE).voidNotify 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 voidclear autoscrollingprotected DropTarget.DropTargetAutoScrollercreate an embedded autoscrollerprotected DropTargetContextCreates 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.voidCallsdropActionChangedon the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent.Gets theComponentassociated with thisDropTarget.intGets anintrepresenting the current action(s) supported by thisDropTarget.Gets theDropTargetContextassociated with thisDropTarget.Gets theFlavorMapassociated with thisDropTarget.protected voidinitialize autoscrollingbooleanisActive()Reports whether or not thisDropTargetis currently active (ready to accept drops).voidRemoves the currentDropTargetListener(UNICAST SOURCE).voidNotify 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.voidNote: 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 thisDropTargetvoidSets theFlavorMapassociated with thisDropTarget.protected voidupdateAutoscroll(Point dragCursorLocn) update autoscrolling with current cursor location
- 
Constructor Details- 
DropTargetpublic 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- The- Componentwith which this- DropTargetis associated
- ops- The default acceptable actions for this- DropTarget
- dtl- The- DropTargetListenerfor this- DropTarget
- act- Is the- DropTargetaccepting drops.
- fm- The- FlavorMapto use, or null for the default- FlavorMap
- Throws:
- HeadlessException- if GraphicsEnvironment.isHeadless() returns true
- See Also:
 
- 
DropTargetpublic 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- The- Componentwith which this- DropTargetis associated
- ops- The default acceptable actions for this- DropTarget
- dtl- The- DropTargetListenerfor this- DropTarget
- act- Is the- DropTargetaccepting drops.
- Throws:
- HeadlessException- if GraphicsEnvironment.isHeadless() returns true
- See Also:
 
- 
DropTargetCreates aDropTarget.- Throws:
- HeadlessException- if GraphicsEnvironment.isHeadless() returns true
- See Also:
 
- 
DropTargetCreates aDropTargetgiven theComponentto associate itself with, and theDropTargetListenerto handle event processing.The Component will receive drops only if it is enabled. - Parameters:
- c- The- Componentwith which this- DropTargetis associated
- dtl- The- DropTargetListenerfor this- DropTarget
- Throws:
- HeadlessException- if GraphicsEnvironment.isHeadless() returns true
- See Also:
 
- 
DropTargetCreates 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- The- Componentwith which this- DropTargetis associated
- ops- The default acceptable actions for this- DropTarget
- dtl- The- DropTargetListenerfor this- DropTarget
- Throws:
- HeadlessException- if GraphicsEnvironment.isHeadless() returns true
- See Also:
 
 
- 
- 
Method Details- 
setComponentNote: 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 new- Componentthis- DropTargetis to be associated with.
 
- 
getComponentGets theComponentassociated with thisDropTarget.- Returns:
- the current Component
 
- 
setDefaultActionspublic void setDefaultActions(int ops) Sets the default acceptable actions for thisDropTarget- Parameters:
- ops- the default actions
- See Also:
 
- 
getDefaultActionspublic int getDefaultActions()Gets anintrepresenting the current action(s) supported by thisDropTarget.- Returns:
- the current default actions
 
- 
setActivepublic void setActive(boolean isActive) Sets the DropTarget active iftrue, inactive iffalse.- Parameters:
- isActive- sets the- DropTarget(in)active.
 
- 
isActivepublic boolean isActive()Reports whether or not thisDropTargetis currently active (ready to accept drops).- Returns:
- trueif active,- falseif not
 
- 
addDropTargetListenerAdds a newDropTargetListener(UNICAST SOURCE).- Parameters:
- dtl- The new- DropTargetListener
- Throws:
- TooManyListenersException- if a- DropTargetListeneris already added to this- DropTarget.
 
- 
removeDropTargetListenerRemoves the currentDropTargetListener(UNICAST SOURCE).- Parameters:
- dtl- the DropTargetListener to deregister.
 
- 
dragEnterCallsdragEnteron the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent. Has no effect if thisDropTargetis not active.- Specified by:
- dragEnterin interface- DropTargetListener
- Parameters:
- dtde- the- DropTargetDragEvent
- Throws:
- NullPointerException- if this- DropTargetis active and- dtdeis- null
- See Also:
 
- 
dragOverCallsdragOveron the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent. Has no effect if thisDropTargetis not active.- Specified by:
- dragOverin interface- DropTargetListener
- Parameters:
- dtde- the- DropTargetDragEvent
- Throws:
- NullPointerException- if this- DropTargetis active and- dtdeis- null
- See Also:
 
- 
dropActionChangedCallsdropActionChangedon the registeredDropTargetListenerand passes it the specifiedDropTargetDragEvent. Has no effect if thisDropTargetis not active.- Specified by:
- dropActionChangedin interface- DropTargetListener
- Parameters:
- dtde- the- DropTargetDragEvent
- Throws:
- NullPointerException- if this- DropTargetis active and- dtdeis- null
- See Also:
 
- 
dragExitCallsdragExiton 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 interface- DropTargetListener
- Parameters:
- dte- the- DropTargetEvent
- See Also:
 
- 
dropCallsdropon the registeredDropTargetListenerand passes it the specifiedDropTargetDropEventif thisDropTargetis active.- Specified by:
- dropin interface- DropTargetListener
- Parameters:
- dtde- the- DropTargetDropEvent
- Throws:
- NullPointerException- if- dtdeis null and at least one of the following is true: this- DropTargetis not active, or there is no a- DropTargetListenerregistered.
- See Also:
 
- 
getFlavorMapGets theFlavorMapassociated with thisDropTarget. If noFlavorMaphas been set for thisDropTarget, it is associated with the defaultFlavorMap.- Returns:
- the FlavorMap for this DropTarget
 
- 
setFlavorMapSets theFlavorMapassociated with thisDropTarget.- Parameters:
- fm- the new- FlavorMap, or null to associate the default FlavorMap with this DropTarget.
 
- 
addNotifypublic 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.
- 
removeNotifypublic 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.
- 
getDropTargetContextGets theDropTargetContextassociated with thisDropTarget.- Returns:
- the DropTargetContextassociated with thisDropTarget.
 
- 
createDropTargetContextCreates 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
 
- 
createDropTargetAutoScrollercreate an embedded autoscroller- Parameters:
- c- the- Component
- p- the- Point
- Returns:
- an embedded autoscroller
 
- 
initializeAutoscrollinginitialize autoscrolling- Parameters:
- p- the- Point
 
- 
updateAutoscrollupdate autoscrolling with current cursor location- Parameters:
- dragCursorLocn- the- Point
 
- 
clearAutoscrollprotected void clearAutoscroll()clear autoscrolling
 
-