書式付きテキストフィールド

getNextVisualPositionFrom は View 内に定義されており、一貫性を保つために、NavigationFilter 内のメソッドと同じ名前が付けられています。

DocumentFilter と同様に、NavigationFilter は、実際の変更を処理するために呼び出される FilterBypass に渡されます。NavigationFilter.FilterBypass は、次のように定義されています。

    public abstract Caret getCaret();
    public abstract void setDot(int dot, Position.Bias bias);
    public abstract void moveDot(int dot, Position.Bias bias);

JFormattedTextField.AbstractFormatter

前述したように、AbstractFormatter のインスタンスは特定の Object 値の書式を設定するために使用されます。AbstractFormatter は、DocumentFilter を定義して編集ポリシーを指定したり、NavigationFilter を定義してナビゲーションポリシーを指定したりすることもできます。AbstractFormatter は、次のように定義されています。

    public void install(JFormattedTextField ftf);
    public void uninstall();
    public abstract Object stringToValue(String text) throws ParseException;
    public abstract String valueToString(Object value) throws ParseException;
    protected JFormattedTextField getFormattedTextField();
    protected void setEditValid(boolean valid);
    protected void invalidEdit();
    protected Action[] getActions();
    protected DocumentFilter getDocumentFilter();
    protected NavigationFilter getNavigationFilter();

JFormattedTextField で AbstractFormatter を使用する準備ができると、install を呼び出します。AbstractFormatter.install は、次の作業を実行します。

1. JFormattedTextField のテキストを valueToString の戻り値に設定する (ParseException がスローされた場合は空の文字列が使用され、setEditValid(false) が呼び出される)。
2. getDocumentFilter から返された DocumentFilter を JFormattedTextField の Document にインストールする。
3. getNavigationFilter から返された NavigationFilter を JFormattedTextField にインストールする。
4. getActions から返された Action を JFormattedTextField の ActionMap にインストールする。

サブクラスで DocumentFilter および NavigationFilter の範囲を超えた追加の Listener をインストールする必要がある場合は、サブクラスは install をオーバーライドするだけか、または最初の位置にキャレットを配置することがあります。

ある種の AbstractFormatter では、JFormattedTextField が編集中に無効な値を含むことが許容されます。JFormattedTextField で無効な値を含んでいることを示すことができるように、AbstractFormatter は、ユーザーが無効な値を入力したときに setEditValid(false) を呼び出します。有効な値が入力されると、 setEditValid(true) が呼び出されます。

JFormattedTextField が AbstractFormatter で処理される場合は、uninstall を呼び出します。 uninstall によって、以前にインストールされた Listener が削除されます。

JFormattedTextField.AbstractFormatterFactory

JFormattedTextField は、AbstractFormatter の作成を AbstractFormatterFactory (JFormattedTextField の公開されている static の内部クラス) のインスタンスに委譲します。この委譲によって、開発者がさまざまな状態の JFormattedTextField に多様なフォーマッタを提供することが簡単になります。たとえば、現在の値が null の場合は特殊な AbstractFormatter、または編集中にはあるフォーマッタ、表示中には別のフォーマッタを提供することができます。AbstractFormatterFactory は、次のように定義されています。

    public abstract AbstractFormatter getFormatter(JFormattedTextField ftf);

開発者が AbstractFormatterFactory を供給しなかった場合は、値の Class に基づいたフォーマッタが作成されます。

DefaultFormatter

DefaultFormatter は JFormattedTextField.AbstractFormatter を拡張します。これは、提供されたフォーマッタ実装のすべてに対応するスーパークラスです。DefaultFormatter は toString を使用して Object の書式を設定し、String をとるコンストラクタを使用して Object を作成します。DefaultFormatter では、多数の構成オプションを使用できます。

AbstractFormatter の実装

次の表に、使用されることを目的として提供する AbstractFormatter の実装を示します。

java.text.Format の変更

Swing では、java.text パッケージ内の Format クラスの拡張使用が可能な、書式付きの日付と数値がサポートされています。以前の API では、次のような問題点がありました。

• 一度に 1 フィールドしか取得できない。複数のフィールドが必要な場合は、format を繰り返し呼び出す必要があった。
• 以前のフィールド定数は、書式付き文字列のテキスト全体を記述するには不十分だった。もっとも目立つ脱落部分は、書式付き数値の指数部を抜かしたことだった。
• 拡張可能にすることを意図した定数セットに対する整数の ID の使用法が洗練されていなかった。新しい定数が追加されると、予期しない Format のサブクラスと競合する可能性が、潜在的にあった。DateFormat と NumberFormat の定数がすでに重なり合っているので、NumberFormat では幸いなことに、YEAR_FIELD が FRACTION_FIELD として解釈されることに留意する。問題点が、多様な形式を持つ Format.format(Object, StringBuffer, FieldPosition) メソッドの存在によって悪化した。
• 仕様書には、書式付き文字列内にフィールドがない場合の動作が定義されておらず、実際の結果はリリースごとに異なっていた。
• 仕様書には、フィールドがフォーマッタに認識されない場合の動作が定義されていなかった。たとえば、MONTH_FIELD 用に NumberFormat を要求した場合など (この例の実装では、開始インデックスと終了インデックスの両方に 0 が返された)。
• そのため、呼び出し側では、特定のサブクラスを知っていない限り、どのフィールドが Format のサブクラスでサポートされるかがわからなかった。書式付き文字列内ですべての文字がフィールドの一部ではないという事実に加え、このことが、すべてのフィールドを返す総称メソッドの実装を不可能にした。

これらの問題点は、以下のメソッドを java.text.Format に追加することで、大幅に対処されました。

    public AttributedCharacterIterator formatToCharacterIterator(Object obj);

各 Format クラスでは、サポートする定数のために型保証された列挙を使用しています。

JavaDoc

新しいクラス

以下のクラスが 1.4 リリースでの新規クラスです。

• JFormattedTextField
• DocumentFilter
• NavigationFilter
• JFormattedTextField.AbstractFormatter
• JFormattedTextField.AbstractFormatterFactory
• DefaultFormatterFactory
• DefaultFormatter
• MaskFormatter
• InternationalFormatter
• NumberFormatter
• DateFormatter

Java の命名規則に準拠するよう定数の名前が変更された

この変更に関連するバグ追跡レポート: 4468474.

次の定数の名前は、Java の命名規則に準拠するように変更されました。

• CommitValueOnFocusLost を COMMIT に変更
• CommitOrRevertValueOnFocusLost を COMMIT_OR_REVERT に変更
• RevertValueOnFocusLost を REVERT に変更
• PersistValueOnFocusLost を PERSIST に変更