モジュール java.desktop
パッケージ java.awt.dnd

クラスDropTarget

  • すべての実装されたインタフェース:
    DropTargetListener, Serializable, EventListener

    public class DropTarget
extends Object
implements DropTargetListener, Serializable
    DropTargetは、ドラッグ&ドロップ操作中にComponentがドロップを受け入れようとするときに、そのComponentに関連付けられます。

    各DropTargetはFlavorMapに関連付けられます。 これ以降、デフォルトのFlavorMapは、SystemFlavorMap.getDefaultFlavorMap()によって返されたFlavorMapを示します。

    導入されたバージョン:
    1.2
    関連項目:
    直列化された形式

    • ネストされたクラスのサマリー

      ネストされたクラス 
      修飾子と型 クラス 説明
      protected static class  DropTarget.DropTargetAutoScroller
      この保護されたネスト・クラスは、自動スクロールを実装します。

    • コンストラクタのサマリー

      コンストラクタ 
      コンストラクタ 説明
      DropTarget​()
      DropTargetを作成します。
      DropTarget​(Component c, int ops, DropTargetListener dtl)
      自身を関連付けるComponent、サポートするデフォルトの許容アクションを表すint、およびイベント処理を扱うDropTargetListenerを使用して、DropTargetを作成します。
      DropTarget​(Component c, int ops, DropTargetListener dtl, boolean act)
      自身を関連付けるComponent、サポートするデフォルトの許容アクションを表すint、イベント処理を扱うDropTargetListener、およびDropTargetが現在ドロップを受け入れているかどうかを示すbooleanを使用して、DropTargetを作成します。
      DropTarget​(Component c, int ops, DropTargetListener dtl, boolean act, FlavorMap fm)
      自身を関連付けるComponent、サポートするデフォルトの許容アクションを表すint、イベント処理を扱うDropTargetListener、DropTargetが現在ドロップを受け入れているかどうかを示すboolean、および使用するFlavorMap (または、デフォルトのFlavorMapの場合はnull)を使用して、新しいDropTargetを作成します。
      DropTarget​(Component c, DropTargetListener dtl)
      自身を関連付けるComponent、およびイベント処理を扱うDropTargetListenerを使用して、DropTargetを作成します。

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 具象メソッド 
      修飾子と型 メソッド 説明
      void addDropTargetListener​(DropTargetListener dtl)
      新しいDropTargetListener (UNICAST SOURCE)を追加します。
      void addNotify​()
      DropTargetがComponentに関連付けられていることをそのDropTargetに通知します。通常、このメソッドはこのDropTargetに関連したComponentのjava.awt.Component.addNotify()から呼び出され、ComponentPeerがそのComponentに関連付けられていることをDropTargetに通知します。
      protected void clearAutoscroll​()
      自動スクロールをクリアします。
      protected DropTarget.DropTargetAutoScroller createDropTargetAutoScroller​(Component c, Point p)
      組込み自動スクローラを作成します
      protected DropTargetContext createDropTargetContext​()
      このDropTargetに関連したDropTargetContextを作成します。
      void dragEnter​(DropTargetDragEvent dtde)
      登録されたDropTargetListenerでdragEnterを呼び出し、指定されたDropTargetDragEventをそれに渡します。
      void dragExit​(DropTargetEvent dte)
      登録されたDropTargetListenerでdragExitを呼び出し、指定されたDropTargetEventをそれに渡します。
      void dragOver​(DropTargetDragEvent dtde)
      登録されたDropTargetListenerでdragOverを呼び出し、指定されたDropTargetDragEventをそれに渡します。
      void drop​(DropTargetDropEvent dtde)
      このDropTargetがアクティブである場合は、登録されたDropTargetListenerでdropを呼び出し、指定されたDropTargetDropEventをそれに渡します。
      void dropActionChanged​(DropTargetDragEvent dtde)
      登録されたDropTargetListenerでdropActionChangedを呼び出し、指定されたDropTargetDragEventをそれに渡します。
      Component getComponent​()
      このDropTargetに関連付けられているComponentを取得します。
      int getDefaultActions​()
      このDropTargetでサポートされている現在のアクションを表すintを取得します。
      DropTargetContext getDropTargetContext​()
      このDropTargetに関連付けられているDropTargetContextを取得します。
      FlavorMap getFlavorMap​()
      このDropTargetに関連付けられているFlavorMapを取得します。
      protected void initializeAutoscrolling​(Point p)
      自動スクロールを初期化します
      boolean isActive​()
      このDropTargetが現在アクティブである(ドロップを受け入れる準備ができている)かどうかを報告します。
      void removeDropTargetListener​(DropTargetListener dtl)
      現在のDropTargetListener (UNICAST SOURCE)を削除します。
      void removeNotify​()
      DropTargetとComponentの関連付けが解除されたことをそのDropTargetに通知します。通常、このメソッドはこのDropTargetに関連したComponentのjava.awt.Component.removeNotify()から呼び出され、ComponentPeerとそのComponentの関連付けが解除されたことをDropTargetに通知します。
      void setActive​(boolean isActive)
      trueの場合はDropTargetをアクティブに、falseの場合は非アクティブに設定します。
      void setComponent​(Component c)
      ノート: このインタフェースは、DropTargetとComponentの安全な関連付けを、次の2つの方法のいずれかで許可するために必要です: component.setDropTarget(droptarget);またはdroptarget.setComponent(component);
      void setDefaultActions​(int ops)
      このDropTargetのデフォルトの許容アクションを設定します。
      void setFlavorMap​(FlavorMap fm)
      このDropTargetに関連付けられたFlavorMapを設定します。
      protected void updateAutoscroll​(Point dragCursorLocn)
      現在のカーソル位置で自動スクロールを更新します

    • コンストラクタの詳細

      • DropTarget

        public DropTarget​(Component c,
                  int ops,
                  DropTargetListener dtl,
                  boolean act,
                  FlavorMap fm)
           throws HeadlessException
        自身を関連付けるComponent、サポートするデフォルトの許容アクションを表すint、イベント処理を扱うDropTargetListener、DropTargetが現在ドロップを受け入れているかどうかを示すboolean、および使用するFlavorMap (または、デフォルトのFlavorMapの場合はnull)を使用して、新しいDropTargetを作成します。

        Componentは、使用可能な場合だけドロップを受け取ります。

        パラメータ:
        c - このDropTargetが関連付けられているComponent
        ops - これのデフォルトの許容アクション: DropTarget
        dtl - このDropTargetのDropTargetListener
        act - DropTargetがドロップを受け入れているかどうか
        fm - 使用するFlavorMap。デフォルトのFlavorMapの場合はnull
        例外:
        HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合
        関連項目:
        GraphicsEnvironment.isHeadless()

      • DropTarget

        public DropTarget​(Component c,
                  int ops,
                  DropTargetListener dtl,
                  boolean act)
           throws HeadlessException
        自身を関連付けるComponent、サポートするデフォルトの許容アクションを表すint、イベント処理を扱うDropTargetListener、およびDropTargetが現在ドロップを受け入れているかどうかを示すbooleanを使用して、DropTargetを作成します。

        Componentは、使用可能な場合だけドロップを受け取ります。

        パラメータ:
        c - このDropTargetが関連付けられているComponent
        ops - これのデフォルトの許容アクション: DropTarget
        dtl - このDropTargetのDropTargetListener
        act - DropTargetがドロップを受け入れているかどうか
        例外:
        HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合
        関連項目:
        GraphicsEnvironment.isHeadless()

      • DropTarget

        public DropTarget​(Component c,
                  DropTargetListener dtl)
           throws HeadlessException
        自身を関連付けるComponent、およびイベント処理を扱うDropTargetListenerを使用して、DropTargetを作成します。

        Componentは、使用可能な場合だけドロップを受け取ります。

        パラメータ:
        c - このDropTargetが関連付けられているComponent
        dtl - このDropTargetのDropTargetListener
        例外:
        HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合
        関連項目:
        GraphicsEnvironment.isHeadless()

      • DropTarget

        public DropTarget​(Component c,
                  int ops,
                  DropTargetListener dtl)
           throws HeadlessException
        自身を関連付けるComponent、サポートするデフォルトの許容アクションを表すint、およびイベント処理を扱うDropTargetListenerを使用して、DropTargetを作成します。

        Componentは、使用可能な場合だけドロップを受け取ります。

        パラメータ:
        c - このDropTargetが関連付けられているComponent
        ops - これのデフォルトの許容アクション: DropTarget
        dtl - このDropTargetのDropTargetListener
        例外:
        HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合
        関連項目:
        GraphicsEnvironment.isHeadless()

    • メソッドの詳細

      • setComponent

        public void setComponent​(Component c)
        ノート: このインタフェースは、DropTargetとComponentの安全な関連付けを、次の2つの方法のいずれかで許可するために必要です: component.setDropTarget(droptarget);またはdroptarget.setComponent(component);

        Componentは、使用可能な場合だけドロップを受け取ります。

        パラメータ:
        c - このDropTargetが関連付けられる新しいComponent。

      • getComponent

        public Component getComponent​()
        このDropTargetに関連付けられているComponentを取得します。
        戻り値:
        現在のComponent

      • setDefaultActions

        public void setDefaultActions​(int ops)
        このDropTargetのデフォルトの許容アクションを設定します。
        パラメータ:
        ops - デフォルトのアクション
        関連項目:
        DnDConstants

      • getDefaultActions

        public int getDefaultActions​()
        このDropTargetでサポートされている現在のアクションを表すintを取得します。
        戻り値:
        現在のデフォルトのアクション

      • setActive

        public void setActive​(boolean isActive)
        trueの場合はDropTargetをアクティブに、falseの場合は非アクティブに設定します。
        パラメータ:
        isActive - DropTargetをアクティブまたは非アクティブに設定する。

      • isActive

        public boolean isActive​()
        このDropTargetが現在アクティブである(ドロップを受け入れる準備ができている)かどうかを報告します。
        戻り値:
        アクティブな場合はtrue、そうでない場合はfalse

      • addDropTargetListener

        public void addDropTargetListener​(DropTargetListener dtl)
                           throws TooManyListenersException
        新しいDropTargetListener (UNICAST SOURCE)を追加します。
        パラメータ:
        dtl - 新しいDropTargetListener
        例外:
        TooManyListenersException - DropTargetListenerがすでにこのDropTargetに追加されている場合。

      • removeDropTargetListener

        public void removeDropTargetListener​(DropTargetListener dtl)
        現在のDropTargetListener (UNICAST SOURCE)を削除します。
        パラメータ:
        dtl - 登録を解除するDropTargetListener。

      • dragEnter

        public void dragEnter​(DropTargetDragEvent dtde)
        登録されたDropTargetListenerでdragEnterを呼び出し、指定されたDropTargetDragEventをそれに渡します。 このDropTargetがアクティブでない場合は、何の効果もありません。
        定義:
        dragEnter、インタフェース: DropTargetListener
        パラメータ:
        dtde - DropTargetDragEvent
        例外:
        NullPointerException - このDropTargetがアクティブであり、dtdeがnullの場合
        関連項目:
        isActive()

      • dragOver

        public void dragOver​(DropTargetDragEvent dtde)
        登録されたDropTargetListenerでdragOverを呼び出し、指定されたDropTargetDragEventをそれに渡します。 このDropTargetがアクティブでない場合は、何の効果もありません。
        定義:
        dragOver、インタフェース: DropTargetListener
        パラメータ:
        dtde - DropTargetDragEvent
        例外:
        NullPointerException - このDropTargetがアクティブであり、dtdeがnullの場合
        関連項目:
        isActive()

      • dropActionChanged

        public void dropActionChanged​(DropTargetDragEvent dtde)
        登録されたDropTargetListenerでdropActionChangedを呼び出し、指定されたDropTargetDragEventをそれに渡します。 このDropTargetがアクティブでない場合は、何の効果もありません。
        定義:
        dropActionChanged、インタフェース: DropTargetListener
        パラメータ:
        dtde - DropTargetDragEvent
        例外:
        NullPointerException - このDropTargetがアクティブであり、dtdeがnullの場合
        関連項目:
        isActive()

      • dragExit

        public void dragExit​(DropTargetEvent dte)
        登録されたDropTargetListenerでdragExitを呼び出し、指定されたDropTargetEventをそれに渡します。 このDropTargetがアクティブでない場合は、何の効果もありません。

        このメソッド自体はnullのパラメータに対して例外をスローしませんが、リスナーの各メソッドによってスローされる例外に対しては例外をスローします。

        定義:
        dragExit、インタフェース: DropTargetListener
        パラメータ:
        dte - DropTargetEvent
        関連項目:
        isActive()

      • drop

        public void drop​(DropTargetDropEvent dtde)
        このDropTargetがアクティブである場合は、登録されたDropTargetListenerでdropを呼び出し、指定されたDropTargetDropEventをそれに渡します。
        定義:
        drop、インタフェース: DropTargetListener
        パラメータ:
        dtde - DropTargetDropEvent
        例外:
        NullPointerException - dtdeがnullで次のいずれか1つがtrueの場合: このDropTargetがアクティブでないか、または登録されているDropTargetListenerが存在しない場合。
        関連項目:
        isActive()

      • getFlavorMap

        public FlavorMap getFlavorMap​()
        このDropTargetに関連付けられているFlavorMapを取得します。 このDropTargetに対してFlavorMapが設定されていない場合は、デフォルトのFlavorMapに関連付けられます。
        戻り値:
        このDropTargetのFlavorMap

      • setFlavorMap

        public void setFlavorMap​(FlavorMap fm)
        このDropTargetに関連付けられたFlavorMapを設定します。
        パラメータ:
        fm - 新しいFlavorMap。このDropTargetにデフォルトのFlavorMapを関連付ける場合はnull。

      • addNotify

        public void addNotify​()
        DropTargetがComponentに関連付けられていることをそのDropTargetに通知します。通常、このメソッドはこのDropTargetに関連したComponentのjava.awt.Component.addNotify()から呼び出され、ComponentPeerがそのComponentに関連付けられていることをDropTargetに通知します。 ComponentPeerとComponentとの関連付けをこのDropTargetに通知する以外の目的でこのメソッドを呼び出すと、DnDシステムが正常に動作しなくなることがあります。

      • removeNotify

        public void removeNotify​()
        DropTargetとComponentの関連付けが解除されたことをそのDropTargetに通知します。通常、このメソッドはこのDropTargetに関連したComponentのjava.awt.Component.removeNotify()から呼び出され、ComponentPeerとそのComponentの関連付けが解除されたことをDropTargetに通知します。 ComponentPeerとComponentとの関連付けが解除されたことをこのDropTargetに通知する以外の目的でこのメソッドを呼び出すと、DnDシステムが正常に動作しなくなることがあります。

      • getDropTargetContext

        public DropTargetContext getDropTargetContext​()
        このDropTargetに関連付けられているDropTargetContextを取得します。
        戻り値:
        このDropTargetに関連付けられているDropTargetContext。

      • createDropTargetContext

        protected DropTargetContext createDropTargetContext​()
        このDropTargetに関連したDropTargetContextを作成します。 サブクラスは、このメソッドをオーバーライドして独自のDropTargetContextサブクラスをインスタンス化できます。 通常、この呼出しは、ドラッグ操作がこのDropTargetを検出したときにプラットフォームのDropTargetContextPeerによってだけ呼び出されます。 ドラッグのないときにContextにアクセスすると、結果は保証されません。
        戻り値:
        このDropTargetに関連付けられているDropTargetContext

      • createDropTargetAutoScroller

        protected DropTarget.DropTargetAutoScroller createDropTargetAutoScroller​(Component c,
                                                                         Point p)
        組込み自動スクローラを作成します
        パラメータ:
        c - Component
        p - Point
        戻り値:
        組み込みオート・スキャン装置

      • initializeAutoscrolling

        protected void initializeAutoscrolling​(Point p)
        自動スクロールを初期化します
        パラメータ:
        p - Point

      • updateAutoscroll

        protected void updateAutoscroll​(Point dragCursorLocn)
        現在のカーソル位置で自動スクロールを更新します
        パラメータ:
        dragCursorLocn - Point

      • clearAutoscroll

        protected void clearAutoscroll​()
        自動スクロールをクリアします。