モジュール java.desktop

パッケージ java.beans

クラスPropertyEditorSupport

java.lang.Object

java.beans.PropertyEditorSupport

すべての実装されたインタフェース:

PropertyEditor

public class PropertyEditorSupport extends Object implements PropertyEditor

プロパティ・エディタを構築するためのサポート・クラスです。

基底クラスまたは委譲として使用できます。

導入されたバージョン:

1.1

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

コンストラクタ

コンストラクタ	説明
PropertyEditorSupport()	PropertyEditorSupportオブジェクトを構築します。
PropertyEditorSupport(Object source)	PropertyEditorSupportオブジェクトを構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
void	addPropertyChangeListener(PropertyChangeListener listener)	値変更のリスナーを追加します。
void	firePropertyChange()	関連するすべてのリスナーを変更したことを報告します。
String	getAsText()	編集するユーザーへの表示に適した文字列として、プロパティ値を取得します。
Component	getCustomEditor()	PropertyEditorは、プロパティ値を編集する完全なカスタム・コンポーネントを提供することができます。
String	getJavaInitializationString()	Javaコードを生成してプロパティの値を設定するときに使います。
Object	getSource()	イベントのソースとして使用されるBeanを返します。
String[]	getTags()	プロパティ値が既知のタグ付きの値セットの1つでなければならない場合に、タグ付きの値の配列を返します。
Object	getValue()	プロパティの値を取得します。
boolean	isPaintable()	クラスがpaintValueメソッドを受け取るかどうかを判定します。
void	paintValue(Graphics gfx, Rectangle box)	値の表現を画面の指定された領域に描画します。
void	removePropertyChangeListener(PropertyChangeListener listener)	値変更のリスナーを削除します。
void	setAsText(String text)	指定されたString (文字列)を解析してプロパティ値を設定します。
void	setSource(Object source)	ソースBeanを設定します。
void	setValue(Object value)	編集するオブジェクトを設定または変更します。
boolean	supportsCustomEditor()	propertyEditorがカスタム・エディタをサポートできるかどうかを判定します。

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

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

コンストラクタの詳細

PropertyEditorSupport

public PropertyEditorSupport()

PropertyEditorSupportオブジェクトを構築します。

導入されたバージョン:

1.5

PropertyEditorSupport

public PropertyEditorSupport(Object source)

PropertyEditorSupportオブジェクトを構築します。

パラメータ:

source - イベントをトリガーするために使用されるソース

導入されたバージョン:

1.5

メソッドの詳細

getSource

public Object getSource()

イベントのソースとして使用されるBeanを返します。 ソースが明示的に設定されていない場合、PropertyEditorSupportのインスタンスが返されます。

戻り値:

ソース・オブジェクトまたはこのインスタンス

導入されたバージョン:

1.5

setSource

public void setSource(Object source)

ソースBeanを設定します。

ソースBeanは、プロパティ変更のイベントのソースとして使用されます。 このソースは、情報を提供する目的のみで使用し、PropertyEditorで変更しないでください。

パラメータ:

source - イベントに使用されるソース・オブジェクト

導入されたバージョン:

1.5

setValue

public void setValue(Object value)

編集するオブジェクトを設定または変更します。

定義:

setValue、インタフェースPropertyEditor

パラメータ:

value - 編集対象の新しいターゲット・オブジェクト。 このオブジェクトはPropertyEditorで変更するのではなく、PropertyEditorで新しいオブジェクトを作成して変更された値を保存する。

getValue

public Object getValue()

プロパティの値を取得します。

定義:

getValue、インタフェースPropertyEditor

戻り値:

プロパティの値

isPaintable

public boolean isPaintable()

クラスがpaintValueメソッドを受け取るかどうかを判定します。

定義:

isPaintable、インタフェースPropertyEditor

戻り値:

クラスがpaintValueメソッドを受け取る場合はtrue。

paintValue

public void paintValue(Graphics gfx, Rectangle box)

値の表現を画面の指定された領域に描画します。 propertyEditorは、独自のクリッピングを行い、指定された矩形内に収めます。

PropertyEditorが描画要求を受け取らない場合(isPaintableを参照)、このメソッドは何も行いません。

定義:

paintValue、インタフェースPropertyEditor

パラメータ:

gfx - 描画するグラフィックス・オブジェクト。

box - 描画するべきグラフィックス・オブジェクト内の矩形。

getJavaInitializationString

public String getJavaInitializationString()

Javaコードを生成してプロパティの値を設定するときに使います。 現在のプロパティ値を持つ変数の初期化に使えるJavaコードのフラグメントを返します。

結果例として「2」、「new Color(127,127,34)」、「Color.orange」などがあります。

定義:

getJavaInitializationString、インタフェースPropertyEditor

戻り値:

現在値の初期化子を表すJavaコードのフラグメント。

getAsText

public String getAsText()

編集するユーザーへの表示に適した文字列として、プロパティ値を取得します。

定義:

getAsText、インタフェースPropertyEditor

戻り値:

編集するユーザーへの表示に適した文字列としてのプロパティ値。

文字列として値を表現できない場合はnullを返します。

null以外の値が返されると、PropertyEditorはその文字列を解析してsetAsText()に戻す。

setAsText

public void setAsText(String text) throws IllegalArgumentException

指定されたString (文字列)を解析してプロパティ値を設定します。 Stringの書式が不正な場合、あるいはプロパティをテキスト表示できない場合は、java.lang.IllegalArgumentExceptionがスローされます。

定義:

setAsText、インタフェースPropertyEditor

パラメータ:

text - 解析される文字列。

例外:

IllegalArgumentException

getTags

public String[] getTags()

プロパティ値が既知のタグ付きの値セットの1つでなければならない場合に、タグ付きの値の配列を返します。 たとえば、これを使って列挙値を表示できます。 PropertyEditorでタグをサポートする場合は、値を設定する方法として、タグ付きの値をsetAsTextで使用できるようにしてください。

定義:

getTags、インタフェースPropertyEditor

戻り値:

このプロパティのタグ付きの値。 このプロパティをタグ付きの値として表示できない場合はnull。

getCustomEditor

public Component getCustomEditor()

PropertyEditorは、プロパティ値を編集する完全なカスタム・コンポーネントを提供することができます。 PropertyEditorは、エディタのコンポーネントと連携し、PropertyChangeイベントをトリガーしてプロパティ値の変更を通知します。

getCustomEditorを呼び出す高レベルなコードでは、コンポーネントをより大きなプロパティ・シートに組み込んだり、独自のダイアログに配置したりすることができます。

定義:

getCustomEditor、インタフェースPropertyEditor

戻り値:

ユーザーが現在のプロパティ値を直接編集できるようにするjava.awt.Component。 サポートされない場合はnull。

supportsCustomEditor

public boolean supportsCustomEditor()

propertyEditorがカスタム・エディタをサポートできるかどうかを判定します。

定義:

supportsCustomEditor、インタフェースPropertyEditor

戻り値:

propertyEditorがカスタム・エディタをサポートできる場合はtrue。

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

値変更のリスナーを追加します。 プロパティ・エディタが値を変更する場合は、プロパティ名にnull値を指定して、登録されているすべてのPropertyChangeListenerに対してPropertyChangeEventをトリガーする必要があります。 ソース・プロパティが設定されている場合は、イベントのソースとして使用してください。

同じリスナー・オブジェクトを複数回追加でき、追加した回数だけリスナー・オブジェクトが呼び出されます。 listenerがnullの場合、例外はスローされず、何も処理は行われません。

定義:

addPropertyChangeListener、インタフェースPropertyEditor

パラメータ:

listener - 追加するPropertyChangeListener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

値変更のリスナーを削除します。

同じリスナーが2回以上追加された場合は、削除されたあとに1回少ない通知が行われます。 listenerがnullの場合、または追加されなかった場合、例外はスローされず、何も処理は行われません。

定義:

removePropertyChangeListener、インタフェースPropertyEditor

パラメータ:

listener - 削除するPropertyChangeListener

firePropertyChange

public void firePropertyChange()

関連するすべてのリスナーを変更したことを報告します。