全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス

インタフェース java.beans.PropertyEditor

public interface PropertyEditor

PropertyEditor は、プロパティ値の表示や更新について様々な方法をサポートします。たいていの PropertyEditors は、この API で使える各種オプションのサブセットをサポートするだけで十分です。

単純な PropertyEditors がサポートできるのは getAsText と setAsText メソッドだけで、paintValue や getCustomEditor のサポートは不要です。より複雑なタイプでは、getAsText や setAsText はサポートできませんが、代わりに paintValue と getCustomEditor をサポートします。

各 propertyEditor は、次の 3 つの表示スタイルのうち 1 つ以上を必ずサポートする必要があります。つまり、(1) isPaintable のサポート、(2) getTags() から null でない String[] を返し、かつ getAsText から null でない値を返す、または (3) 単に getAsText() から null でない String を返す、の 3 つです。

各プロパティエディタは、引数オブジェクトが対応する propertyEditor の型である場合に、setValue の呼び出しをサポートする必要があります。さらに、各プロパティエディタはカスタマエディタまたは setAsText のいずれかをサポートすることが必要です。

各 PropertyEditor は、null 構築子を持たなければなりません。

addPropertyChangeListener(PropertyChangeListener)

PropertyChange イベントのリスナを登録する。

getAsText()

getCustomEditor()

PropertyEditor は、プロパティ値を編集する完全なカスタムコンポーネントの使用を選択できる。

getJavaInitializationString()

このメソッドは、Java コードを生成してプロパティ値を設定するときに使う。

getTags()

プロパティ値が認識されるタグ付き値のセットの 1 つでなければならない場合に、このメソッドがタグの配列を返す。

getValue()

isPaintable()

paintValue(Graphics, Rectangle)

値表示を画面の実際の所定領域にペイントする。

removePropertyChangeListener(PropertyChangeListener)

PropertyChange イベントのリスナを削除する。

setAsText(String)

指定の String (文字列) を解析して、プロパティ値を設定する。

setValue(Object)

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

supportsCustomEditor()

  public abstract void setValue(Object value)

編集対象オブジェクトを設定 (または変更) します。「int」 などの組み込み型は、「java.lang.Integer」 などの対応オブジェクト型としてラップする必要があります。

パラメータ:

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

  public abstract Object getValue()

返り値:

プロパティの値。「int」 などの組み込み型は、「java.lang.Integer」 などの対応オブジェクト型としてラップされる。

  public abstract boolean isPaintable()

返り値:

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

  public abstract void paintValue(Graphics gfx,
                                  Rectangle box)

値表示を画面の実際の所定領域にペイントします。propertyEditor は独自のクリッピングを行って、所定の矩形内に収まります。

PropertyEditor がペイント要求を受け取らない場合 (isPaintable を参照)、このメソッドは機能しません。

パラメータ:

gfx - ペイント先のグラフィックオブジェクト

box - ペイント先のグラフィックオブジェクト内の矩形

  public abstract String getJavaInitializationString()

このメソッドは、Java コードを生成してプロパティ値を設定するときに使います。現在のプロパティ値を持つ変数の初期化に使える Java コード断片を返します。

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

返り値:

現在値の初期化子を表す Java コードの断片。

  public abstract String getAsText()

返り値:

ユーザが編集できる文字列のプロパティ値

編集可能文字列として値を表せない場合は null を返す。

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

  public abstract void setAsText(String text) throws IllegalArgumentException

所定の String (文字列) を解析してプロパティ値を設定します。String のフォーマットが不良な場合やプロパティをテキスト表示できない場合は、java.lang.IllegalArgumentException が出されます。

パラメータ:

text - 解析する文字列

  public abstract String[] getTags()

プロパティ値が認識されるタグ付きの値セットの 1 つでなければならない場合に、このメソッドがタグの配列を返します。例えば、これを使って可算値を表示できます。PropertyEditor がタグをサポートする場合、値設定の方法としてタグ付きの値を持つ setAsText を使ったり、現行値を識別するために getAsText を使うことができます。

返り値:

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

  public abstract Component getCustomEditor()

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

getCustomEditor を呼び出す高レベルなコードは、コンポーネントをより大きなプロパティシートに埋め込んだり、独自のダイアログに入れたりできます。

返り値:

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

  public abstract boolean supportsCustomEditor()

返り値:

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

  public abstract void addPropertyChangeListener(PropertyChangeListener listener)

PropertyChange イベントのリスナを登録します。PropertyEditor は値の変更時にプロパティ名を null 値として、イベント自体をソースとして指定し、登録されているすべての PropertyChangeListeners 上で PropertyChange イベントを出します。

パラメータ:

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

  public abstract void removePropertyChangeListener(PropertyChangeListener listener)

PropertyChange イベントからリスナを削除します。

パラメータ:

listener - 削除する PropertyChange リスナ

全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス