java.awt.datatransfer

クラス Clipboard

java.lang.Object

java.awt.datatransfer.Clipboard

public class Clipboard
extends Object

カット/コピー/ペースト操作を使用してデータを転送するメカニズムを実装するクラスです。

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

関連項目:

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)

クリップボードオブジェクトを作成します。

関連項目:

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