java.awt.dnd
Class DragSourceContext

java.lang.Object
  extended by java.awt.dnd.DragSourceContext
All Implemented Interfaces:
DragSourceListener, DragSourceMotionListener, Serializable, EventListener

public class DragSourceContext
extends Object
implements DragSourceListener, DragSourceMotionListener, Serializable

Since:
1.2
See Also:
Serialized Form

Field Summary
protected static int CHANGED
           
protected static int DEFAULT
           
protected static int ENTER
           
protected static int OVER
           
 
Constructor Summary
DragSourceContext(DragSourceContextPeer peer, DragGestureEvent trigger, Cursor cursor, Image image, Point offset, Transferable trans, DragSourceListener dsl)
          Initializes a drag source context.
 
Method Summary
 void addDragSourceListener(DragSourceListener dsl)
          Adds a DragSourceListener.
 void dragDropEnd(DragSourceDropEvent e)
          Calls dragDropEnd on the listeners registered with this and with the DragSource.
 void dragEnter(DragSourceDragEvent e)
          Calls dragEnter on the listeners registered with this and with the DragSource.
 void dragExit(DragSourceEvent e)
          Calls dragExit on the listeners registered with this and with the DragSource.
 void dragMouseMoved(DragSourceDragEvent e)
          Calls dragMouseMoved on the listeners registered with the DragSource.
 void dragOver(DragSourceDragEvent e)
          Calls dragOver on the listeners registered with this and with the DragSource.
 void dropActionChanged(DragSourceDragEvent e)
          Calls dropActionChanged on the listeners registered with this and with the DragSource.
 Component getComponent()
          Returns the component associated with this.
 Cursor getCursor()
          Returns the current cursor or null if the default drag cursor is used.
 DragSource getDragSource()
          Returns the DragSource object associated with the DragGestureEvent.
 int getSourceActions()
          Returns the source actions for the DragGestureRecognizer.
 Transferable getTransferable()
          Returns the Transferable set with this object.
 DragGestureEvent getTrigger()
          Gets the trigger associated with this.
 void removeDragSourceListener(DragSourceListener dsl)
           
 void setCursor(Cursor cursor)
          Sets the cursor for this drag operation to the specified cursor.
 void transferablesFlavorsChanged()
          This function tells the peer that the DataFlavors have been modified.
protected  void updateCurrentCursor(int dropOp, int targetAct, int status)
          This function sets the drag cursor for the specified operation, actions and status if the default drag cursor is active.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT

protected static final int DEFAULT
See Also:
Constant Field Values

ENTER

protected static final int ENTER
See Also:
Constant Field Values

OVER

protected static final int OVER
See Also:
Constant Field Values

CHANGED

protected static final int CHANGED
See Also:
Constant Field Values
Constructor Detail

DragSourceContext

public DragSourceContext(DragSourceContextPeer peer,
                         DragGestureEvent trigger,
                         Cursor cursor,
                         Image image,
                         Point offset,
                         Transferable trans,
                         DragSourceListener dsl)
Initializes a drag source context.

Throws:
IllegalArgumentException - If Component or DragSource of trigger are null, the drag action for the trigger event is DnDConstants.ACTION_NONE or if the source actions for the DragGestureRecognizer associated with the trigger event are equal to DnDConstants.ACTION_NONE.
NullPointerException - If peer, trans or trigger is null or if the image is not null but the offset is.
Method Detail

getDragSource

public DragSource getDragSource()
Returns the DragSource object associated with the DragGestureEvent.

Returns:
the DragSource associated with the trigger.

getComponent

public Component getComponent()
Returns the component associated with this.

Returns:
the component associated with the trigger.

getTrigger

public DragGestureEvent getTrigger()
Gets the trigger associated with this.

Returns:
the trigger.

getSourceActions

public int getSourceActions()
Returns the source actions for the DragGestureRecognizer.

Returns:
the source actions for DragGestureRecognizer.

setCursor

public void setCursor(Cursor cursor)
Sets the cursor for this drag operation to the specified cursor.

Parameters:
cursor - c - the Cursor to use, or null to use the default drag cursor.

getCursor

public Cursor getCursor()
Returns the current cursor or null if the default drag cursor is used.

Returns:
the current cursor or null.

addDragSourceListener

public void addDragSourceListener(DragSourceListener dsl)
                           throws TooManyListenersException
Adds a DragSourceListener.

Throws:
TooManyListenersException - If a DragSourceListener has already been added.

removeDragSourceListener

public void removeDragSourceListener(DragSourceListener dsl)

transferablesFlavorsChanged

public void transferablesFlavorsChanged()
This function tells the peer that the DataFlavors have been modified.


dragEnter

public void dragEnter(DragSourceDragEvent e)
Calls dragEnter on the listeners registered with this and with the DragSource.

Specified by:
dragEnter in interface DragSourceListener
Parameters:
e - - the DragSourceDragEvent

dragOver

public void dragOver(DragSourceDragEvent e)
Calls dragOver on the listeners registered with this and with the DragSource.

Specified by:
dragOver in interface DragSourceListener
Parameters:
e - - the DragSourceDragEvent

dragExit

public void dragExit(DragSourceEvent e)
Calls dragExit on the listeners registered with this and with the DragSource.

Specified by:
dragExit in interface DragSourceListener
Parameters:
e - - the DragSourceEvent

dropActionChanged

public void dropActionChanged(DragSourceDragEvent e)
Calls dropActionChanged on the listeners registered with this and with the DragSource.

Specified by:
dropActionChanged in interface DragSourceListener
Parameters:
e - - the DragSourceDragEvent

dragDropEnd

public void dragDropEnd(DragSourceDropEvent e)
Calls dragDropEnd on the listeners registered with this and with the DragSource.

Specified by:
dragDropEnd in interface DragSourceListener
Parameters:
e - - the DragSourceDropEvent

dragMouseMoved

public void dragMouseMoved(DragSourceDragEvent e)
Calls dragMouseMoved on the listeners registered with the DragSource.

Specified by:
dragMouseMoved in interface DragSourceMotionListener
Parameters:
e - - the DragSourceDragEvent

getTransferable

public Transferable getTransferable()
Returns the Transferable set with this object.

Returns:
the transferable.

updateCurrentCursor

protected void updateCurrentCursor(int dropOp,
                                   int targetAct,
                                   int status)
This function sets the drag cursor for the specified operation, actions and status if the default drag cursor is active. Otherwise, the cursor is not updated in any way.

Parameters:
dropOp - - the current operation.
targetAct - - the supported actions.
status - - the status of the cursor (constant).