JavaTM 2
Platform
Std. Ed. v1.4.0

java.beans
クラス PropertyEditorSupport

java.lang.Object
  |
  +--java.beans.PropertyEditorSupport
すべての実装インタフェース:
PropertyEditor

public class PropertyEditorSupport
extends Object
implements PropertyEditor

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

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


コンストラクタの概要
protected PropertyEditorSupport()
          派生 PropertyEditor クラスが使うコンストラクタです。
protected PropertyEditorSupport(Object source)
          PropertyEditor の委譲時に使うコンストラクタです。
 
メソッドの概要
 void addPropertyChangeListener(PropertyChangeListener listener)
          PropertyChange イベントのリスナーを登録します。
 void firePropertyChange()
          関係のあるリスナーにオブジェクトが変更されていることをレポートします。
 String getAsText()
          ユーザによる編集が可能な文字列の形で、プロパティ値を取得します。
 Component getCustomEditor()
          PropertyEditor は、プロパティ値を編集する完全なカスタムコンポーネントの使用を選択できます。
 String getJavaInitializationString()
          Java コードを生成してプロパティ値を設定するときに使います。
 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 setValue(Object value)
          編集するオブジェクトを設定 (変更) します。
 boolean supportsCustomEditor()
          propertyEditor がカスタムエディタをサポートしているかどうかを判定します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PropertyEditorSupport

protected PropertyEditorSupport()
派生 PropertyEditor クラスが使うコンストラクタです。


PropertyEditorSupport

protected PropertyEditorSupport(Object source)
PropertyEditor の委譲時に使うコンストラクタです。

パラメータ:
source - ユーザが、発生されるイベント用に使うソース
メソッドの詳細

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()
関係のあるリスナーにオブジェクトが変更されていることをレポートします。


JavaTM 2
Platform
Std. Ed. v1.4.0

バグの報告と機能のリクエスト
これ以外の API リファレンスおよび開発者用ドキュメントについては、 Java 2 SDK SE 開発者用ドキュメントを参照してください。 開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、 およびコード実例が含まれています。

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.