java.awt.dnd

Class DragSourceContext

public class DragSourceContext extends Object implements DragSourceListener, DragSourceMotionListener, Serializable

Since: 1.2

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.

Field Detail

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

addDragSourceListener

public void addDragSourceListener(DragSourceListener dsl)

Adds a DragSourceListener.

Throws: TooManyListenersException If a DragSourceListener has already been added.

dragDropEnd

public void dragDropEnd(DragSourceDropEvent e)

Calls dragDropEnd on the listeners registered with this and with the DragSource.

Parameters: e - the DragSourceDropEvent

dragEnter

public void dragEnter(DragSourceDragEvent e)

Calls dragEnter on the listeners registered with this and with the DragSource.

Parameters: e - the DragSourceDragEvent

dragExit

public void dragExit(DragSourceEvent e)

Calls dragExit on the listeners registered with this and with the DragSource.

Parameters: e - the DragSourceEvent

dragMouseMoved

public void dragMouseMoved(DragSourceDragEvent e)

Calls dragMouseMoved on the listeners registered with the DragSource.

Parameters: e - the DragSourceDragEvent

dragOver

public void dragOver(DragSourceDragEvent e)

Calls dragOver on the listeners registered with this and with the DragSource.

Parameters: e - the DragSourceDragEvent

dropActionChanged

public void dropActionChanged(DragSourceDragEvent e)

Calls dropActionChanged on the listeners registered with this and with the DragSource.

Parameters: e - the DragSourceDragEvent

getComponent

public Component getComponent()

Returns the component associated with this.

Returns: the component associated with the trigger.

getCursor

public Cursor getCursor()

Returns the current cursor or null if the default drag cursor is used.

Returns: the current cursor or null.

getDragSource

public DragSource getDragSource()

Returns the DragSource object associated with the DragGestureEvent.

Returns: the DragSource associated with the trigger.

getSourceActions

public int getSourceActions()

Returns the source actions for the DragGestureRecognizer.

Returns: the source actions for DragGestureRecognizer.

getTransferable

public Transferable getTransferable()

Returns the Transferable set with this object.

Returns: the transferable.

getTrigger

public DragGestureEvent getTrigger()

Gets the trigger associated with this.

Returns: the trigger.

removeDragSourceListener

public void removeDragSourceListener(DragSourceListener dsl)

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.

transferablesFlavorsChanged

public void transferablesFlavorsChanged()

This function tells the peer that the DataFlavors have been modified.

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).