NativeDragManager  - AS3

パッケージ	flash.desktop
クラス	public class NativeDragManager
継承	NativeDragManager Object

ランタイムバージョン:

AIR 1.0

NativeDragManager クラスは、ドラッグ＆ドロップ操作を調整します。ネイティブドラッグ＆ドロップ API を使用すると、ユーザーは、AIR アプリケーションとネイティブのオペレーティングシステムとの間、2 つの AIR アプリケーションの間または 1 つのアプリケーション内のコンポーネントの間でデータをドラッグできるようになります。

次の種類のデータを転送できます。

• ビットマップ
• ファイル
• テキスト
• URL ストリング
• 直列化されたオブジェクト
• オブジェクト参照（元のアプリケーション内でのみ有効）

注意：すべての NativeDragManager メンバーが静的メンバーです。このクラスのインスタンスを作成する必要はありません。

ドラッグ＆ドロップ操作は、ユーザーが表示されたアイテムをクリックして別の場所にドラッグすると開始される、ユーザーインターフェイスのジェスチャです。ドラッグジェスチャを実行している間、AIR アプリケーションウィンドウ内を移動するにつれて、表示リスト上のインタラクティブオブジェクトによってネイティブドラッグイベントが送出されます。これらのイベントのハンドラーで NativeDragManager クラスのメソッドを呼び出すと、ドラッグしたアイテムをオブジェクトにドロップできるかどうかを示すことができます。これに応答してマウスポインターが変わり、ユーザーにフィードバックが提供されます。

AIR プロファイルのサポート：この機能は AIR for TV デバイスではサポートされません。また、すべてのモバイルデバイスでサポートされません。NativeDragManager.isSupported プロパティを使用して、サポートされているかどうかを実行時にテストすることができます。複数のプロファイル間での API サポートについて詳しくは、AIR プロファイルのサポートを参照してください。

ドラッグアクション

通常、ドラッグ & ドロップジェスチャは、アクションと呼ばれる 3 種類の操作に使用されます。これらのアクションの意味はアプリケーションのコンテキストに応じて異なるため、ランタイムではアクションに対して特定の動作は適用されません。ただし、アクションを適切に実装すると、アプリケーションに対するユーザーの操作性が向上します。

実行可能なアクションは次のとおりです。

• copy — データのコピーを作成し、元のデータには変更を加えません（1 つのアプリケーション内でオブジェクトをドラッグする場合、元のオブジェクトへの参照ではなくそのオブジェクト自体をコピーするときは注意が必要です）。
• move — アイテムをあるリストから別のリストに移動する場合のように、元のコンテキストから、ドロップターゲットに定義されたコンテキストにデータを移動します。
• link — アイテムを元のコンテキスト内に残したまま、元のデータへの参照またはショートカットを作成します。

allowedActions パラメーターを、ドラッグ操作を開始する NativeDragManager.doDrag() 呼び出しに指定することにより、実行可能なアクションをドラッグジェスチャに設定できます。allowedActions パラメーターを指定しない場合は、すべてのアクションが許可されます。NativeDragEvent オブジェクトの allowedActions プロパティを使用すると、ドラッグ可能ターゲットで実行できるアクションを確認できます。また、実行できるのが互換性のないアクションのみのドロップを受け入れないようにできます（ただし、ランタイムでは適用できません）。

ドロップターゲットが単一のアクションのみを実装している場合、オブジェクトは NativeDragManager の dropAction プロパティを、nativeDragEnter イベントおよび nativeDragOver イベントの両方のハンドラーで設定できます。ドロップの前にプロパティを設定することによって、ドラッグマネージャーはマウスポインターを更新してサポートされるアクションを示すことができ、ユーザーが修飾キーを使用して互換性のないアクションを選択することを防止できます。指定したアクションが許可されるアクションのいずれでもない場合、ターゲットが acceptDrop() メソッドを呼び出しても、ドロップは許可されません。

ドロップを受け入れる場合は、NativeDragManager.dropAction プロパティを設定することにより、ドロップ可能ターゲットが nativeDragDrop イベントに応答して選択したアクションを指定する必要があります。このアクションは、nativeDragComplete イベントで元の開始表示オブジェクトに通知されます。ドロップターゲットにアクションが設定されていない場合、デフォルトのアクションが、許可されたアクションから copy、move、link の優先順位に従って選択されます。開始オブジェクトは、選択されたアクションに応じて内部状態を更新する必要があります。

NativeDragActions クラスにアクション名のストリング定数が定義されます。

イベントの順序

NativeDragManager.doDrag() メソッド（mouseDown イベントハンドラー内または mouseMove イベントハンドラー内）を呼び出すことによりドラッグジェスチャが開始され、ユーザーの操作に応答して次のイベントシーケンスが実行されます。

• nativeDragStart イベント：NativeDragManager.doDrag() が呼び出されると、このメソッドにパラメーターとして渡されたインタラクティブオブジェクトが開始元オブジェクトとなって、nativeDragStart イベントが送出されます。
• nativeDragUpdate イベント：ドラッグが進行している間、開始元オブジェクトによって継続的に nativeDragUpdate イベントが送出されます。
• nativeDragEnter イベント、nativeDragOver イベント：ドラッグジェスチャがインタラクティブオブジェクトの上を通ると、nativeDragEnter イベントが送出されます。ドラッグジェスチャがインタラクティブオブジェクトの上で止まっている間、継続的に nativeDragOver イベントが送出されます。これらのイベントのいずれかに応答して、ドロップ可能ターゲットとして機能するオブジェクトがイベントオブジェクトのプロパティをチェックし、ドロップを受け入れ可能かどうかを判断します。データ形式と許可されたアクションが適切な場合、これらのイベントのイベントハンドラーで NativeDragManager.acceptDrop() を呼び出し、ドラッグターゲットとして機能する表示オブジェクト（通常、nativeDragEnter または nativeDragOver イベントを送出したオブジェクト）に参照を渡す必要があります。これで、ユーザーはドラッグしたアイテムをターゲットにドロップすることができます。
• nativeDragExit イベント — ドラッグジェスチャがインタラクティブオブジェクトからなくなると、オブジェクトによって nativeDragExit イベントが送出されます。オブジェクトが NativeDragManager.acceptDrop() メソッドに対する前の呼び出しでドラッグターゲットとして指定されていた場合、その呼び出しは無効になり、ジェスチャが再びインタラクティブオブジェクトに入った場合は acceptDrop() をもう一度呼び出す必要があります。
• nativeDragDrop イベント — オブジェクトの上でユーザーがマウスボタンを離すと、ターゲット表示オブジェクトによって nativeDragDrop イベントが送出されます。このイベントのハンドラーは、イベントオブジェクトの transferable プロパティのデータにアクセスできます。開始元オブジェクトで実行する必要のあるアクションを通知するには、NativeDragManager.dropAction プロパティを設定します。
• nativeDragComplete — ドラッグジェスチャの最後でユーザーがマウスボタンを離すと、開始元オブジェクトによって nativeDragComplete イベントが送出されます（ドロップ自体が完了したかどうか）。このイベントのハンドラーは、イベントオブジェクトの dropAction プロパティをチェックして、リストからドラッグされたアイテムの削除など、内部のデータ状態に対して実行する必要のある変更があるかどうかを確認できます。 dropAction が NativeDragActions.NONE の場合、ドラッグしたアイテムが適切なターゲットにドロップされなかったことを示します。

アプリケーション間のジェスチャ

ドラッグジェスチャが AIR 以外のアプリケーションから AIR アプリケーションウィンドウに入った場合、nativeDragStart イベントまたは nativeDragComplete イベントを送出する開始元オブジェクトはありません。その他の点では、ジェスチャを実行中のイベントは、同じ AIR アプリケーション内で開始および終了するジェスチャと同じパターンに従って送出されます。

ドラッグジェスチャが AIR アプリケーションウィンドウの外に移動すると、nativeDragEnter、nativeDragOver または nativeDragDrop イベントを送出するターゲットオブジェクトはなくなります。開始元オブジェクトは引き続き nativeDragComplete イベントを送出し、ネイティブオペレーティングシステムによって設定されたドラッグアクションを通知します（ドロップが受け入れられなかった場合は none）。

ドラッグジェスチャがある AIR アプリケーションから別の AIR アプリケーションに移動すると、開始元オブジェクトとターゲット表示オブジェクトは、それぞれのアプリケーション内で通常と同じイベントを送出します。

情報の転送

ドラッグ & ドロップジェスチャの実行中に転送されるデータは Clipboard オブジェクトに格納されます。このデータオブジェクトは、NativeDragManager.doDrag() メソッドを使用して、ドラッグジェスチャを開始したドラッグ操作に追加されます。ドロップ可能ターゲットは、ネイティブドラッグイベントオブジェクトの clipboard プロパティを使用して Clipboard オブジェクトにアクセスできます。ドラッグ操作が一旦開始されると、Clipboard オブジェクトにアクセスできるのは NativeDragEvent のイベントハンドラーだけになります。その他のハンドラーからこのオブジェクトにアクセスすると、ランタイムエラーが生成されます。

セキュリティについての考慮事項

開始元オブジェクトおよびターゲットオブジェクトのセキュリティサンドボックスに応じて、ドラッグされているデータへのアクセス方法が決まります。両方のオブジェクトが同じサンドボックス内にある場合は、すべての NativeDragEvent オブジェクトからデータにアクセスできます。一方、開始元オブジェクトとターゲットオブジェクトが異なるサンドボックス内にある場合、データにアクセスできるのは nativeDragDrop イベントのイベントハンドラー内のターゲットサンドボックスだけです。他のネイティブドラッグイベントハンドラーは、イベントの clipboard プロパティで参照される Clipboard オブジェクトに引き続きアクセスし、利用可能なデータ形式を確認できますが、clipboard.getData() メソッドを呼び出すとセキュリティエラーが生成されます。

関連する API エレメント

---