java.awt.dnd
Class DropTargetContext
- java.lang.Object
-
- java.awt.dnd.DropTargetContext
-
- All Implemented Interfaces:
- Serializable
public class DropTargetContext extends Object implements Serializable
ADropTargetContext
is created whenever the logical cursor associated with a Drag and Drop operation coincides with the visible geometry of aComponent
associated with aDropTarget
. TheDropTargetContext
provides the mechanism for a potential receiver of a drop operation to both provide the end user with the appropriate drag under feedback, but also to effect the subsequent data transfer if appropriate.- Since:
- 1.2
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description protected class
DropTargetContext.TransferableProxy
TransferableProxy
is a helper inner class that implementsTransferable
interface and serves as a proxy for anotherTransferable
object which represents data transfer for a particular drag-n-drop operation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description protected void
acceptDrag(int dragOperation)
accept the Drag.protected void
acceptDrop(int dropOperation)
called to signal that the drop is acceptable using the specified operation.void
addNotify(java.awt.dnd.peer.DropTargetContextPeer dtcp)
Called when associated with theDropTargetContextPeer
.protected Transferable
createTransferableProxy(Transferable t, boolean local)
Creates a TransferableProxy to proxy for the specified Transferable.void
dropComplete(boolean success)
This method signals that the drop is completed and if it was successful or not.Component
getComponent()
This method returns theComponent
associated with thisDropTargetContext
.protected DataFlavor[]
getCurrentDataFlavors()
get the available DataFlavors of theTransferable
operand of this operation.protected List<DataFlavor>
getCurrentDataFlavorsAsList()
This method returns a the currently available DataFlavors of theTransferable
operand as ajava.util.List
.DropTarget
getDropTarget()
This method returns theDropTarget
associated with thisDropTargetContext
.protected int
getTargetActions()
This method returns anint
representing the current actions thisDropTarget
will accept.protected Transferable
getTransferable()
get the Transferable (proxy) operand of this operationprotected boolean
isDataFlavorSupported(DataFlavor df)
This method returns aboolean
indicating if the givenDataFlavor
is supported by thisDropTargetContext
.protected void
rejectDrag()
reject the Drag.protected void
rejectDrop()
called to signal that the drop is unacceptable.void
removeNotify()
Called when disassociated with theDropTargetContextPeer
.protected void
setTargetActions(int actions)
This method sets the current actions acceptable to thisDropTarget
.
-
-
-
Method Detail
getDropTarget
public DropTarget getDropTarget()
This method returns theDropTarget
associated with thisDropTargetContext
.- Returns:
-
the
DropTarget
associated with thisDropTargetContext
getComponent
public Component getComponent()
This method returns theComponent
associated with thisDropTargetContext
.- Returns:
- the Component associated with this Context
addNotify
public void addNotify(java.awt.dnd.peer.DropTargetContextPeer dtcp)
Called when associated with theDropTargetContextPeer
.- Parameters:
-
dtcp
- theDropTargetContextPeer
removeNotify
public void removeNotify()
Called when disassociated with theDropTargetContextPeer
.
setTargetActions
protected void setTargetActions(int actions)
This method sets the current actions acceptable to thisDropTarget
.- Parameters:
-
actions
- anint
representing the supported action(s)
getTargetActions
protected int getTargetActions()
This method returns anint
representing the current actions thisDropTarget
will accept.- Returns:
-
the current actions acceptable to this
DropTarget
dropComplete
public void dropComplete(boolean success) throws InvalidDnDOperationException
This method signals that the drop is completed and if it was successful or not.- Parameters:
-
success
- true for success, false if not - Throws:
-
InvalidDnDOperationException
- if a drop is not outstanding/extant
acceptDrag
protected void acceptDrag(int dragOperation)
accept the Drag.- Parameters:
-
dragOperation
- the supported action(s)
rejectDrag
protected void rejectDrag()
reject the Drag.
acceptDrop
protected void acceptDrop(int dropOperation)
called to signal that the drop is acceptable using the specified operation. must be called during DropTargetListener.drop method invocation.- Parameters:
-
dropOperation
- the supported action(s)
rejectDrop
protected void rejectDrop()
called to signal that the drop is unacceptable. must be called during DropTargetListener.drop method invocation.
getCurrentDataFlavors
protected DataFlavor[] getCurrentDataFlavors()
get the available DataFlavors of theTransferable
operand of this operation.- Returns:
-
a
DataFlavor[]
containing the supportedDataFlavor
s of theTransferable
operand.
getCurrentDataFlavorsAsList
protected List<DataFlavor> getCurrentDataFlavorsAsList()
This method returns a the currently available DataFlavors of theTransferable
operand as ajava.util.List
.- Returns:
-
the currently available DataFlavors as a
java.util.List
isDataFlavorSupported
protected boolean isDataFlavorSupported(DataFlavor df)
This method returns aboolean
indicating if the givenDataFlavor
is supported by thisDropTargetContext
.- Parameters:
-
df
- theDataFlavor
- Returns:
-
if the
DataFlavor
specified is supported
getTransferable
protected Transferable getTransferable() throws InvalidDnDOperationException
get the Transferable (proxy) operand of this operation- Returns:
-
the
Transferable
- Throws:
-
InvalidDnDOperationException
- if a drag is not outstanding/extant
createTransferableProxy
protected Transferable createTransferableProxy(Transferable t, boolean local)
Creates a TransferableProxy to proxy for the specified Transferable.- Parameters:
-
t
- the Transferable to be proxied -
local
- true if t represents the result of a local drag-n-drop operation. - Returns:
- the new TransferableProxy instance.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.