java.awt.dnd
クラス DragSource

java.lang.Object
  |
  +--java.awt.dnd.DragSource

public class DragSource

extends Object

DragSource は、ドラッグ＆ドロップ操作の開始を担当するエンティティで、次のようないくつかのシナリオで使用できます。

• JVM ごとに、その JVM の寿命の間 1 デフォルトインスタンス
• 潜在的なドラッグイニシエータオブジェクト (TextField など) のクラスごとに 1 インスタンス。実装により異なる
• GUI の特定の Component のインスタンス、または Component インスタンスに関連付けられているアプリケーション固有のオブジェクトごとに 1 つ。実装により異なる
• その他任意の関連付け。実装により異なる

DragSource を取得した場合は、DragGestureRecognizer も取得して、DragSource を特定の Component と関連付けます。

ユーザのジェスチャーの最初の実装、およびその後のドラッグ操作の開始は、通常 DragGestureRecognizer が実装する実装 Component が担当します。

ドラッグジェスチャーが発生すると、ユーザのナビゲーションジェスチャーの処理およびドラッグ＆ドロッププロトコル通知の送達のため、DragSource の startDrag() メソッドが呼び出されます。DragSource は、どの時点でも現在のドラッグ＆ドロップ操作として操作を 1 つだけ許可し、その操作が完了する時点まで、IllegalDnDOperationException をスローすることによって他の startDrag() 要求を拒否します。

startDrag() メソッドは、createDragSourceContext() メソッドを呼び出して適切な DragSourceContext をインスタンス化し、DragSourceContextPeer をそれに関連付けます。

ドラッグ＆ドロップシステムが何らかの理由でドラッグ操作を開始できない場合、startDrag() メソッドは java.awt.dnd.InvalidDnDOperationException をスローしてその状態を通知します。この例外は通常、基礎になるプラットフォームシステムがドラッグを開始する状態にないか、あるいは指定されたパラメータが無効な場合にスローされます。

ドラッグ中は、ドラッグ操作の開始時点に転送元によって明らかにされた一連の操作は、その操作が完了するまで変更できません。DragSource に関して、操作中はその操作は一定しています。

導入されたバージョン:

1.2

フィールドの概要

static Cursor	DefaultCopyDrop コピー操作とともに使用して、ドロップが現在許可されていることを示すデフォルトの Cursor です。
static Cursor	DefaultCopyNoDrop コピー操作とともに使用して、ドロップが現在許可されていないことを示すデフォルトの Cursor です。
static Cursor	DefaultLinkDrop リンク操作とともに使用して、ドロップが現在許可されていることを示すデフォルトの Cursor です。
static Cursor	DefaultLinkNoDrop リンク操作とともに使用して、ドロップが現在許可されていないことを示すデフォルトの Cursor です。
static Cursor	DefaultMoveDrop 移動操作とともに使用して、ドロップが現在許可されていることを示すデフォルトの Cursor です。
static Cursor	DefaultMoveNoDrop 移動操作とともに使用して、ドロップが現在許可されていないことを示すデフォルトの Cursor です。

コンストラクタの概要

DragSource()
新しい DragSource を構築します。

メソッドの概要

DragGestureRecognizer	createDefaultDragGestureRecognizer(Component c, int actions, DragGestureListener dgl) DragGestureRecognizer のデフォルト抽象サブクラスを実装する新しい DragSourceRecognizer をこの DragSource に作成し、新しく作成されたオブジェクトに、指定された Component および DragGestureListener を設定します。
DragGestureRecognizer	createDragGestureRecognizer(Class recognizerAbstractClass, Component c, int actions, DragGestureListener dgl) DragGestureRecognizer の指定された抽象サブクラスを実装する新しい DragGestureRecognizer を作成し、新しく作成されたオブジェクトに、指定された Component および DragGestureListener を設定します。
protected DragSourceContext	createDragSourceContext(java.awt.dnd.peer.DragSourceContextPeer dscp, DragGestureEvent dgl, Cursor dragCursor, Image dragImage, Point imageOffset, Transferable t, DragSourceListener dsl) このドラッグを処理する DragSourceContext を作成します。
static DragSource	getDefaultDragSource() このメソッドは、基礎になるプラットフォームに関連した DragSource オブジェクトを返します。
FlavorMap	getFlavorMap() このメソッドは、この DragSource の FlavorMap を返します。
static boolean	isDragImageSupported() このメソッドは、基本となるプラットフォームでドラッグ Image のサポートが可能かどうかを示す boolean を返します。
void	startDrag(DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point dragOffset, Transferable transferable, DragSourceListener dsl) ドラッグを開始した DragGestureEvent、使用する初期 Cursor、ドラッグする Image、トリガーの瞬間における Cursor のホットスポットからの Image 原点のオフセット、ドラッグの対象データ、および DragSourceListener を受けて、ドラッグを開始します。
void	startDrag(DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point imageOffset, Transferable transferable, DragSourceListener dsl, FlavorMap flavorMap) ドラッグを開始した DragGestureEvent、使用する初期 Cursor、ドラッグする Image、トリガーの瞬間における Cursor のホットスポットからの Image 原点のオフセット、ドラッグの Transferable 対象データ、DragSourceListener、および FlavorMap を受けて、ドラッグを開始します。
void	startDrag(DragGestureEvent trigger, Cursor dragCursor, Transferable transferable, DragSourceListener dsl) ドラッグを開始した DragGestureEvent、使用する初期 Cursor ドラッグの Transferable 対象データ、および DragSourceListener を受けて、ドラッグを開始します。
void	startDrag(DragGestureEvent trigger, Cursor dragCursor, Transferable transferable, DragSourceListener dsl, FlavorMap flavorMap) ドラッグを開始した DragGestureEvent、使用する初期 Cursor、ドラッグの Transferable 対象データ、DragSourceListener、および FlavorMap を受けて、ドラッグを開始します。

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

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

フィールドの詳細

DefaultCopyDrop

public static final Cursor DefaultCopyDrop

コピー操作とともに使用して、ドロップが現在許可されていることを示すデフォルトの Cursor です。

DefaultMoveDrop

public static final Cursor DefaultMoveDrop

移動操作とともに使用して、ドロップが現在許可されていることを示すデフォルトの Cursor です。

DefaultLinkDrop

public static final Cursor DefaultLinkDrop

リンク操作とともに使用して、ドロップが現在許可されていることを示すデフォルトの Cursor です。

DefaultCopyNoDrop

public static final Cursor DefaultCopyNoDrop

コピー操作とともに使用して、ドロップが現在許可されていないことを示すデフォルトの Cursor です。

DefaultMoveNoDrop

public static final Cursor DefaultMoveNoDrop

移動操作とともに使用して、ドロップが現在許可されていないことを示すデフォルトの Cursor です。

DefaultLinkNoDrop

public static final Cursor DefaultLinkNoDrop

リンク操作とともに使用して、ドロップが現在許可されていないことを示すデフォルトの Cursor です。

コンストラクタの詳細

DragSource

public DragSource()

新しい DragSource を構築します。

メソッドの詳細

getDefaultDragSource

public static DragSource getDefaultDragSource()

このメソッドは、基礎になるプラットフォームに関連した DragSource オブジェクトを返します。

戻り値:

プラットフォーム DragSource

isDragImageSupported

public static boolean isDragImageSupported()

このメソッドは、基本となるプラットフォームでドラッグ Image のサポートが可能かどうかを示す boolean を返します。

戻り値:

このプラットフォームでドラッグイメージサポートが可能な場合

startDrag

public void startDrag(DragGestureEvent trigger,
                      Cursor dragCursor,
                      Image dragImage,
                      Point imageOffset,
                      Transferable transferable,
                      DragSourceListener dsl,
                      FlavorMap flavorMap)
               throws InvalidDnDOperationException

ドラッグを開始した DragGestureEvent、使用する初期 Cursor、ドラッグする Image、トリガーの瞬間における Cursor のホットスポットからの Image 原点のオフセット、ドラッグの Transferable 対象データ、DragSourceListener、および FlavorMap を受けて、ドラッグを開始します。

パラメータ:

trigger - ドラッグを開始させた DragGestureEvent

dragCursor - 初期 Cursor、またはデフォルトの場合 null

dragImage - ドラッグするイメージ、または null

imageOffset - トリガーの瞬間における、Cursor のホットスポットからの Image 原点のオフセット

transferable - ドラッグの対象データ

dsl - DragSourceListener

flavorMap - 使用する FlavorMap、または null

例外:

java.awt.dnd.InvalidDnDOperationException - ドラッグ＆ドロップシステムがドラッグ操作を開始できない場合、または既存のドラッグ操作を実行中にユーザがドラッグを開始しようとした場合

startDrag

public void startDrag(DragGestureEvent trigger,
                      Cursor dragCursor,
                      Transferable transferable,
                      DragSourceListener dsl,
                      FlavorMap flavorMap)
               throws InvalidDnDOperationException

ドラッグを開始した DragGestureEvent、使用する初期 Cursor、ドラッグの Transferable 対象データ、DragSourceListener、および FlavorMap を受けて、ドラッグを開始します。

パラメータ:

trigger - ドラッグを開始させた DragGestureEvent

dragCursor - 初期 Cursor、またはデフォルトの場合 null

transferable - ドラッグの対象データ

dsl - DragSourceListener

flavorMap - 使用する FlavorMap、または null

例外:

java.awt.dnd.InvalidDnDOperationException - ドラッグ＆ドロップシステムがドラッグ操作を開始できない場合、または既存のドラッグ操作を実行中にユーザがドラッグを開始しようとした場合

startDrag

public void startDrag(DragGestureEvent trigger,
                      Cursor dragCursor,
                      Image dragImage,
                      Point dragOffset,
                      Transferable transferable,
                      DragSourceListener dsl)
               throws InvalidDnDOperationException

ドラッグを開始した DragGestureEvent、使用する初期 Cursor、ドラッグする Image、トリガーの瞬間における Cursor のホットスポットからの Image 原点のオフセット、ドラッグの対象データ、および DragSourceListener を受けて、ドラッグを開始します。

パラメータ:

trigger - ドラッグを開始させた DragGestureEvent

dragCursor - 初期 Cursor、またはデフォルトの場合 null

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

imageOffset - トリガーの瞬間における、Cursor のホットスポットからの Image 原点のオフセット

transferable - ドラッグの対象データ

dsl - DragSourceListener

例外:

java.awt.dnd.InvalidDnDOperationException - ドラッグ＆ドロップシステムがドラッグ操作を開始できない場合、または既存のドラッグ操作を実行中にユーザがドラッグを開始しようとした場合

startDrag

public void startDrag(DragGestureEvent trigger,
                      Cursor dragCursor,
                      Transferable transferable,
                      DragSourceListener dsl)
               throws InvalidDnDOperationException

ドラッグを開始した DragGestureEvent、使用する初期 Cursor ドラッグの Transferable 対象データ、および DragSourceListener を受けて、ドラッグを開始します。

パラメータ:

trigger - ドラッグを開始させた DragGestureEvent

dragCursor - 初期 Cursor、またはデフォルトの場合 null

transferable - ドラッグの対象データ

dsl - DragSourceListener

例外:

java.awt.dnd.InvalidDnDOperationException - ドラッグ＆ドロップシステムがドラッグ操作を開始できない場合、または既存のドラッグ操作を実行中にユーザがドラッグを開始しようとした場合

createDragSourceContext

protected DragSourceContext createDragSourceContext(java.awt.dnd.peer.DragSourceContextPeer dscp,
                                                    DragGestureEvent dgl,
                                                    Cursor dragCursor,
                                                    Image dragImage,
                                                    Point imageOffset,
                                                    Transferable t,
                                                    DragSourceListener dsl)

このドラッグを処理する DragSourceContext を作成します。 新しい DragSourceContext サブクラスを組み込むには、DragSource をサブクラス化し、このメソッドをオーバーライドします。

パラメータ:

dscp - このドラッグの DragSourceContextPeer

trigger - ドラッグをトリガーした DragGestureEvent

dragCursor - 表示する初期 Cursor

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

imageOffset - トリガーの瞬間における、カーソルのホットスポットからの Image 原点のオフセット

transferable - ドラッグの対象データ

dsl - DragSourceListener

戻り値:

DragSourceContext

getFlavorMap

public FlavorMap getFlavorMap()

このメソッドは、この DragSource の FlavorMap を返します。

戻り値:

この DragSource の FlavorMap

createDragGestureRecognizer

public DragGestureRecognizer createDragGestureRecognizer(Class recognizerAbstractClass,
                                                         Component c,
                                                         int actions,
                                                         DragGestureListener dgl)

DragGestureRecognizer の指定された抽象サブクラスを実装する新しい DragGestureRecognizer を作成し、新しく作成されたオブジェクトに、指定された Component および DragGestureListener を設定します。

パラメータ:

recognizerAbstractClass - 要求された抽象型

actions - 許可されたソースドラッグアクション

c - Component ターゲット

dgl - 通知する DragGestureListener

戻り値:

新しい DragGestureRecognizer。または Toolkit.createDragGestureRecognizer() メソッドが要求された DragGestureRecognizer サブクラスに使用可能な実装を持たず null を返した場合、null

createDefaultDragGestureRecognizer

public DragGestureRecognizer createDefaultDragGestureRecognizer(Component c,
                                                                int actions,
                                                                DragGestureListener dgl)

DragGestureRecognizer のデフォルト抽象サブクラスを実装する新しい DragSourceRecognizer をこの DragSource に作成し、新しく作成されたオブジェクトに、指定された Component および DragGestureListener を設定します。 この DragSource の場合、デフォルトは MouseDragGestureRecognizer です。

パラメータ:

c - レコグナイザの Component ターゲット

actions - 許可されたソースアクション

dgl - 通知する DragGestureListener

戻り値:

新しい DragGestureRecognizer。または Toolkit.createDragGestureRecognizer() メソッドが要求された DragGestureRecognizer サブクラスに使用可能な実装を持たず null を返した場合、null