java.beans
クラス PropertyEditorSupport

java.lang.Object
  java.beans.PropertyEditorSupport

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

PropertyEditor

public class PropertyEditorSupport
extends Object
implements PropertyEditor

プロパティエディタの構築に役立つサポートクラスです。

基底クラスまたは委譲される側として使用可能です。

コンストラクタの概要

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

PropertyEditorSupport(Object source)
PropertyEditorSupport オブジェクトを構築します。

メソッドの概要

void	addPropertyChangeListener(PropertyChangeListener listener) PropertyChange イベントのリスナーを登録します。
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) PropertyChange イベントのリスナーを削除します。
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)

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

定義:

インタフェース PropertyEditor 内の setValue

パラメータ:

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

getValue

public Object getValue()

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

定義:

インタフェース PropertyEditor 内の getValue

戻り値:

プロパティの値

isPaintable

public boolean isPaintable()

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

定義:

インタフェース PropertyEditor 内の isPaintable

戻り値:

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

paintValue

public void paintValue(Graphics gfx,
                       Rectangle box)

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

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

定義:

インタフェース PropertyEditor 内の paintValue

パラメータ:

gfx - 描画されるグラフィックスオブジェクト

box - グラフィックスオブジェクトを描画する矩形

getJavaInitializationString

public String getJavaInitializationString()

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

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

定義:

インタフェース PropertyEditor 内の getJavaInitializationString

戻り値:

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

getAsText

public String getAsText()

プロパティ値を、人間が編集するのに適した文字列の形式で取得します。

定義:

インタフェース PropertyEditor 内の getAsText

戻り値:

人間が編集するのに適した文字列の形式のプロパティ値

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

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

setAsText

public void setAsText(String text)
               throws IllegalArgumentException

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

定義:

インタフェース PropertyEditor 内の setAsText

パラメータ:

text - 解析される文字列

例外:

IllegalArgumentException

getTags

public String[] getTags()

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

定義:

インタフェース PropertyEditor 内の getTags

戻り値:

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

getCustomEditor

public Component getCustomEditor()

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

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

定義:

インタフェース PropertyEditor 内の getCustomEditor

戻り値:

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

supportsCustomEditor

public boolean supportsCustomEditor()

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

定義:

インタフェース PropertyEditor 内の supportsCustomEditor

戻り値:

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

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

PropertyChange イベントのリスナーを登録します。クラスは、値が更新されるたびに PropertyChange 値を破棄します。

定義:

インタフェース PropertyEditor 内の addPropertyChangeListener

パラメータ:

listener - PropertyChange イベントがトリガされたときに呼び出されるオブジェクト

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

PropertyChange イベントのリスナーを削除します。

定義:

インタフェース PropertyEditor 内の removePropertyChangeListener

パラメータ:

listener - 削除される PropertyChange リスナー

firePropertyChange

public void firePropertyChange()

関連リスナーがすべて削除されたことを報告します。