モジュール java.datatransfer
パッケージ java.awt.datatransfer

クラスClipboard

java.lang.Object
java.awt.datatransfer.Clipboard
public class Clipboard extends Object
カット/コピー/ペースト操作を使用してデータを転送するメカニズムを実装するクラスです。

ClipboardクラスのインスタンスにFlavorListenerを登録すると、このクリップボードで使用可能なDataFlavorのセットへの変更に関する通知を受けることができます(addFlavorListener(java.awt.datatransfer.FlavorListener)を参照してください)。

導入されたバージョン:
1.1
関連項目:
Toolkit.getSystemClipboard(), Toolkit.getSystemSelection()

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    protected Transferable
    contents
    クリップボードの内容。
    protected ClipboardOwner
    owner
    クリップボードの所有者。

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

    コンストラクタ
    コンストラクタ
    説明
    Clipboard​(String name)
    クリップボード・オブジェクトを作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    addFlavorListener​(FlavorListener listener)
    このクリップボードからFlavorEventを受信するために、指定されたFlavorListenerを登録します。
    DataFlavor[]
    getAvailableDataFlavors()
    このクリップボードの現在の内容を提供できるDataFlavorの配列を返します。
    Transferable
    getContents​(Object requestor)
    クリップボードの現在の内容を表現する転送可能なオブジェクトを返します。
    Object
    getData​(DataFlavor flavor)
    指定されたDataFlavorでこのクリップボードの現在の内容を表すオブジェクトを返します。
    FlavorListener[]
    getFlavorListeners()
    このClipboardに現在登録されているすべてのFlavorListenerの配列を返します。
    String
    getName()
    クリップボード・オブジェクトの名前を返します。
    boolean
    isDataFlavorAvailable​(DataFlavor flavor)
    指定されたDataFlavorでこのクリップボードの現在の内容を提供できるかどうかを返します。
    void
    removeFlavorListener​(FlavorListener listener)
    指定されたFlavorListenerを削除して、このClipboardからFlavorEventが受信されなくなるようにします。
    void
    setContents​(Transferable contents, ClipboardOwner owner)
    クリップボードの現在の内容を指定された転送可能なオブジェクトに設定し、指定されたクリップボード・オーナーを新しい内容のオーナーとして登録します。

    クラス java.lang.Objectで宣言されたメソッド

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

  • フィールド詳細

    • owner

      protected ClipboardOwner owner
      クリップボードの所有者。

    • contents

      protected Transferable contents
      クリップボードの内容。

  • コンストラクタの詳細

    • Clipboard

      public Clipboard​(String name)
      クリップボード・オブジェクトを作成します。
      パラメータ:
      name - クリップボード用
      関連項目:
      Toolkit.getSystemClipboard()

  • メソッドの詳細

    • getName

      public String getName()
      クリップボード・オブジェクトの名前を返します。
      戻り値:
      このクリップボード・オブジェクトの名前
      関連項目:
      Toolkit.getSystemClipboard()

    • setContents

      public void setContents​(Transferable contents, ClipboardOwner owner)
      クリップボードの現在の内容を指定された転送可能なオブジェクトに設定し、指定されたクリップボード・オーナーを新しい内容のオーナーとして登録します。

      引数ownerとは異なる既存のオーナーが存在する場合、そのオーナーには、そのオーナーのClipboardOwner.lostOwnership()の呼出しによって、クリップボードの内容の所有権を失ったことが通知されます。 setContents()の実装は、このメソッドから直接lostOwnership()を呼び出す必要はありません。 たとえば、あとで別のスレッドでlostOwnership()を呼び出すことができます。 このクリップボードに登録されたFlavorListenerにも同じことがあてはまります。

      このメソッドは、クリップボードが現在使用できない場合にIllegalStateExceptionをスローします。 たとえば、プラットフォームによっては、ほかのアプリケーションがアクセスしている間はシステム・クリップボードが利用できない場合があります。

      パラメータ:
      contents - クリップボードの内容を表す転送可能なオブジェクト
      owner - クリップボードの内容を所有するオブジェクト
      例外:
      IllegalStateException - クリップボードが現在使用できない場合
      関連項目:
      Toolkit.getSystemClipboard()

    • getContents

      public Transferable getContents​(Object requestor)
      クリップボードの現在の内容を表現する転送可能なオブジェクトを返します。 現在クリップボードに内容がない場合は、nullを返します。 パラメータObject要求者は現在使用されていません。 このメソッドは、クリップボードが現在使用できない場合にIllegalStateExceptionをスローします。 たとえば、プラットフォームによっては、ほかのアプリケーションがアクセスしている間はシステム・クリップボードが利用できない場合があります。
      パラメータ:
      requestor - クリップ・データを要求しているオブジェクト(未使用)
      戻り値:
      クリップボード上の現在の転送可能なオブジェクト
      例外:
      IllegalStateException - クリップボードが現在使用できない場合
      関連項目:
      Toolkit.getSystemClipboard()

    • getAvailableDataFlavors

      public DataFlavor[] getAvailableDataFlavors()
      このクリップボードの現在の内容を提供できるDataFlavorの配列を返します。 使用可能なDataFlavorが存在しない場合、このメソッドは長さゼロの配列を返します。
      戻り値:
      このクリップボードの現在の内容を提供できるDataFlavorの配列
      例外:
      IllegalStateException - このクリップボードが現在使用できない場合
      導入されたバージョン:
      1.5

    • isDataFlavorAvailable

      public boolean isDataFlavorAvailable​(DataFlavor flavor)
      指定されたDataFlavorでこのクリップボードの現在の内容を提供できるかどうかを返します。
      パラメータ:
      flavor - 内容をリクエストされたDataFlavor
      戻り値:
      このクリップボードの現在の内容を指定されたDataFlavorで提供できる場合はtrue。それ以外の場合はfalse
      例外:
      NullPointerException - flavorがnullである場合
      IllegalStateException - このクリップボードが現在使用できない場合
      導入されたバージョン:
      1.5

    • getData

      public Object getData​(DataFlavor flavor) throws UnsupportedFlavorException, IOException
      指定されたDataFlavorでこのクリップボードの現在の内容を表すオブジェクトを返します。 返されるオブジェクトのクラスは、flavorの表現クラスで定義されます。
      パラメータ:
      flavor - 内容をリクエストされたDataFlavor
      戻り値:
      指定されたDataFlavorでこのクリップボードの現在の内容を表すオブジェクト
      例外:
      NullPointerException - flavorがnullである場合
      IllegalStateException - このクリップボードが現在使用できない場合
      UnsupportedFlavorException - 要求されたDataFlavorが使用できない場合
      IOException - 要求されたDataFlavor内のデータを取得できない場合
      導入されたバージョン:
      1.5
      関連項目:
      DataFlavor.getRepresentationClass()

    • addFlavorListener

      public void addFlavorListener​(FlavorListener listener)
      このクリップボードからFlavorEventを受信するために、指定されたFlavorListenerを登録します。 listenerがnullである場合、例外はスローされず、何も処理は行われません。
      パラメータ:
      listener - 追加されるリスナー
      導入されたバージョン:
      1.5
      関連項目:
      removeFlavorListener(java.awt.datatransfer.FlavorListener)、getFlavorListeners()、FlavorListener、FlavorEvent

    • removeFlavorListener

      public void removeFlavorListener​(FlavorListener listener)
      指定されたFlavorListenerを削除して、このClipboardからFlavorEventが受信されなくなるようにします。 引数で指定されたリスナーが以前にこのClipboardに追加されていない場合、このメソッドは何も実行せず、例外もスローしません。 listenerがnullである場合、例外はスローされず、何も処理は行われません。
      パラメータ:
      listener - 削除されるリスナー
      導入されたバージョン:
      1.5
      関連項目:
      addFlavorListener(java.awt.datatransfer.FlavorListener)、getFlavorListeners()、FlavorListener、FlavorEvent

    • getFlavorListeners

      public FlavorListener[] getFlavorListeners()
      このClipboardに現在登録されているすべてのFlavorListenerの配列を返します。
      戻り値:
      このクリップボードのすべてのFlavorListener。または現在リスナーが登録されていない場合は空の配列
      導入されたバージョン:
      1.5
      関連項目:
      addFlavorListener(java.awt.datatransfer.FlavorListener)、removeFlavorListener(java.awt.datatransfer.FlavorListener)、FlavorListener、FlavorEvent