java.awt.dnd
クラス DragSourceContext

java.lang.Object
  java.awt.dnd.DragSourceContext

すべての実装されたインタフェース:

DragSourceListener, DragSourceMotionListener, Serializable, EventListener

public class DragSourceContext
extends Object
implements DragSourceListener, DragSourceMotionListener, Serializable

DragSourceContext クラスは、ドラッグ＆ドロッププロトコルのイニシエータ側を管理します。特に、DragSourceListener と DragSourceMotionListener へのドラッグイベント通知を管理し、ドラッグ操作のソースデータを表す Transferable を提供します。

DragSourceContext 自体は DragSourceListener および DragSourceMotionListener インタフェースを実装していることに注意してください。これは、DragSource で作成されたプラットフォームピア (DragSourceContextPeer インスタンス) が、DragSourceContext に対し、進行中の操作状態に変更があったことを通知できるようにするためです。これにより、DragSourceContext はプラットフォームとドラッグ操作イニシエータで提供されたリスナーの間に、DragSourceContext 自体を挿入できます。

導入されたバージョン:

1.2

関連項目:

DragSourceListener, DragSourceMotionListener, 直列化された形式

フィールドの概要

protected static int	CHANGED ユーザー操作が変更されたことを示す、updateCurrentCursor() で使用される int です。
protected static int	DEFAULT Cursor をデフォルト (ドロップなし) の Cursor に変更するよう指示する、updateCurrentCursor() で使用される int です。
protected static int	ENTER Cursor が DropTarget に入力されたことを示す、updateCurrentCursor() で使用される int です。
protected static int	OVER Cursor が DropTarget の上にあることを示す、updateCurrentCursor() で使用される int です。

コンストラクタの概要

DragSourceContext(java.awt.dnd.peer.DragSourceContextPeer dscp, DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point offset, Transferable t, DragSourceListener dsl)
DragSource から呼び出され、このコンストラクタはこの Drag に DragSourceContextPeer を提供する新しい DragSourceContext を作成します。

メソッドの概要

void	addDragSourceListener(DragSourceListener dsl) まだ 1 つも追加されていない場合、この DragSourceContext に DragSourceListener を追加します。
void	dragDropEnd(DragSourceDropEvent dsde) この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dragDropEnd を呼び出し、指定された DragSourceDropEvent に渡します。
void	dragEnter(DragSourceDragEvent dsde) この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dragEnter を呼び出し、指定された DragSourceDragEvent に渡します。
void	dragExit(DragSourceEvent dse) この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dragExit を呼び出し、指定された DragSourceEvent に渡します。
void	dragMouseMoved(DragSourceDragEvent dsde) この DragSourceContext に関連付けられた DragSource に登録された DragSourceMotionListener で dragMouseMoved を呼び出し、指定された DragSourceDragEvent に渡します。
void	dragOver(DragSourceDragEvent dsde) この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dragOver を呼び出し、指定された DragSourceDragEvent に渡します。
void	dropActionChanged(DragSourceDragEvent dsde) この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dropActionChanged を呼び出し、指定された DragSourceDragEvent に渡します。
Component	getComponent() DragSourceContext に関連した Component を返します。
Cursor	getCursor() 現在のドラッグ Cursor を返します。
DragSource	getDragSource() この DragSourceContext のインスタンスを生成した DragSource を返します。
int	getSourceActions() この DragSourceContext に関連したドラッグ操作のドラッグソースでサポートされている一連のドロップアクションを表す DnDConstants のビット単位のマスクを返します。
Transferable	getTransferable() DragSourceContext に関連した Transferable を返します。
DragGestureEvent	getTrigger() ドラッグを最初にトリガーした DragGestureEvent を返します。
void	removeDragSourceListener(DragSourceListener dsl) 指定された DragSourceListener をこの DragSourceContext から削除します。
void	setCursor(Cursor c) このドラッグ操作のカーソルに指定された Cursor を設定します。
void	transferablesFlavorsChanged() Transferable の DataFlavor が変更されたことをピアに通知します。
protected void	updateCurrentCursor(int sourceAct, int targetAct, int status) デフォルトのドラッグカーソルの動作がアクティブな場合、このメソッドは、ドラッグソースでサポートされる指定されたアクション、ドロップターゲットアクション、およびステータスにデフォルトのドラッグカーソルを設定します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

DEFAULT

protected static final int DEFAULT

Cursor をデフォルト (ドロップなし) の Cursor に変更するよう指示する、updateCurrentCursor() で使用される int です。

関連項目:

定数フィールド値

ENTER

protected static final int ENTER

Cursor が DropTarget に入力されたことを示す、updateCurrentCursor() で使用される int です。

関連項目:

定数フィールド値

OVER

protected static final int OVER

Cursor が DropTarget の上にあることを示す、updateCurrentCursor() で使用される int です。

関連項目:

定数フィールド値

CHANGED

protected static final int CHANGED

ユーザー操作が変更されたことを示す、updateCurrentCursor() で使用される int です。

関連項目:

定数フィールド値

コンストラクタの詳細

DragSourceContext

public DragSourceContext(java.awt.dnd.peer.DragSourceContextPeer dscp,
                         DragGestureEvent trigger,
                         Cursor dragCursor,
                         Image dragImage,
                         Point offset,
                         Transferable t,
                         DragSourceListener dsl)

DragSource から呼び出され、このコンストラクタはこの Drag に DragSourceContextPeer を提供する新しい DragSourceContext を作成します。また、Drag をトリガーした DragGestureEvent、Drag に使用する初期の Cursor、Drag の実行中に表示する (省略可能な) Image、イベントをトリガーした瞬間でのホットスポットからの Image 起点のオフセット、Transferable サブジェクトデータ、およびドラッグ＆ドロップ操作中に使用する DragSourceListener も作成します。DragSourceContextPeer が null の場合は、NullPointerException がスローされます。
DragGestureEvent が null の場合は、NullPointerException がスローされます。
Cursor が null の場合、例外はスローされず、デフォルトのドラッグカーソルの動作が、このドラッグ操作に対してアクティブになります。
Image が null の場合、例外はスローされません。
Image が null でなく、オフセットが null の場合は、NullPointerException がスローされます。
Transferable が null の場合は、NullPointerException がスローされます。
DragSourceListener が null の場合、例外はスローされません。

パラメータ:

dscp - このドラッグの DragSourceContextPeer

trigger - トリガイベント

dragCursor - 初期の Cursor

dragImage - ドラッグする Image (または null)

offset - トリガーイベントの瞬間での、ホットスポットからのイメージ原点のオフセット

t - Transferable

dsl - DragSourceListener

例外:

IllegalArgumentException - トリガーイベントに関連付けられた Component が null の場合

IllegalArgumentException - トリガーイベントの DragSource が null の場合

IllegalArgumentException - トリガーイベントのドラッグアクションが DnDConstants.ACTION_NONE の場合

IllegalArgumentException - トリガーイベントに関連付けられた DragGestureRecognizer のソースアクションが DnDConstants.ACTION_NONE と等しい場合

NullPointerException - dscp、trigger、または t が null の場合、あるいは、dragImage が null ではなく、オフセットが null の場合

メソッドの詳細

getDragSource

public DragSource getDragSource()

この DragSourceContext のインスタンスを生成した DragSource を返します。

戻り値:

この DragSourceContext のインスタンスを生成した DragSource

getComponent

public Component getComponent()

DragSourceContext に関連した Component を返します。

戻り値:

ドラッグを開始させた Component

getTrigger

public DragGestureEvent getTrigger()

ドラッグを最初にトリガーした DragGestureEvent を返します。

戻り値:

ドラッグをトリガーした Event

getSourceActions

public int getSourceActions()

この DragSourceContext に関連したドラッグ操作のドラッグソースでサポートされている一連のドロップアクションを表す DnDConstants のビット単位のマスクを返します。

戻り値:

ドラッグソースでサポートされているドロップアクション

setCursor

public void setCursor(Cursor c)

このドラッグ操作のカーソルに指定された Cursor を設定します。指定された Cursor が null の場合は、デフォルトのドラッグカーソルの動作が、このドラッグ操作に対してアクティブになります。 null 以外の場合は、デフォルトのドラッグカーソルの動作が非アクティブになります。

パラメータ:

c - 表示する Cursor。デフォルトのドラッグカーソルの動作をアクティブにする場合は null

getCursor

public Cursor getCursor()

現在のドラッグ Cursor を返します。

戻り値:

現在のドラッグ Cursor

addDragSourceListener

public void addDragSourceListener(DragSourceListener dsl)
                           throws TooManyListenersException

まだ 1 つも追加されていない場合、この DragSourceContext に DragSourceListener を追加します。DragSourceListener がすでに存在する場合、このメソッドは TooManyListenersException をスローします。

パラメータ:

dsl - 追加する DragSourceListener。null は禁止されていないが、パラメータとして受け付けられない

例外:

TooManyListenersException - DragSourceListener がすでに追加されている場合

TooManyListenersException

removeDragSourceListener

public void removeDragSourceListener(DragSourceListener dsl)

指定された DragSourceListener をこの DragSourceContext から削除します。

パラメータ:

dsl - 削除する DragSourceListener。null は禁止されていないが、パラメータとして受け付けられない

transferablesFlavorsChanged

public void transferablesFlavorsChanged()

Transferable の DataFlavor が変更されたことをピアに通知します。

dragEnter

public void dragEnter(DragSourceDragEvent dsde)

この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dragEnter を呼び出し、指定された DragSourceDragEvent に渡します。

定義:

インタフェース DragSourceListener 内の dragEnter

パラメータ:

dsde - DragSourceDragEvent

dragOver

public void dragOver(DragSourceDragEvent dsde)

この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dragOver を呼び出し、指定された DragSourceDragEvent に渡します。

定義:

インタフェース DragSourceListener 内の dragOver

パラメータ:

dsde - DragSourceDragEvent

dragExit

public void dragExit(DragSourceEvent dse)

この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dragExit を呼び出し、指定された DragSourceEvent に渡します。

定義:

インタフェース DragSourceListener 内の dragExit

パラメータ:

dse - DragSourceEvent

dropActionChanged

public void dropActionChanged(DragSourceDragEvent dsde)

この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dropActionChanged を呼び出し、指定された DragSourceDragEvent に渡します。

定義:

インタフェース DragSourceListener 内の dropActionChanged

パラメータ:

dsde - DragSourceDragEvent

dragDropEnd

public void dragDropEnd(DragSourceDropEvent dsde)

この DragSourceContext、および関連する DragSource に登録された DragSourceListener で dragDropEnd を呼び出し、指定された DragSourceDropEvent に渡します。

定義:

インタフェース DragSourceListener 内の dragDropEnd

パラメータ:

dsde - DragSourceDropEvent

dragMouseMoved

public void dragMouseMoved(DragSourceDragEvent dsde)

この DragSourceContext に関連付けられた DragSource に登録された DragSourceMotionListener で dragMouseMoved を呼び出し、指定された DragSourceDragEvent に渡します。

定義:

インタフェース DragSourceMotionListener 内の dragMouseMoved

パラメータ:

dsde - DragSourceDragEvent

導入されたバージョン:

1.4

getTransferable

public Transferable getTransferable()

DragSourceContext に関連した Transferable を返します。

戻り値:

Transferable

updateCurrentCursor

protected void updateCurrentCursor(int sourceAct,
                                   int targetAct,
                                   int status)

デフォルトのドラッグカーソルの動作がアクティブな場合、このメソッドは、ドラッグソースでサポートされる指定されたアクション、ドロップターゲットアクション、およびステータスにデフォルトのドラッグカーソルを設定します。 そうでない場合、このメソッドは何も行いません。

パラメータ:

sourceAct - ドラッグソースでサポートされているアクション

targetAct - ドロップターゲットアクション

status - 次のフィールドのいずれか。DEFAULT、ENTER、OVER、CHANGED