InternationalFormatter (Java Platform SE 7)

java.lang.Object
- javax.swing.JFormattedTextField.AbstractFormatter
- - javax.swing.text.DefaultFormatter
  - - javax.swing.text.InternationalFormatter

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

Serializable, Cloneable

直系の既知のサブクラス:

DateFormatter, NumberFormatter
```
public class InternationalFormatter
extends DefaultFormatter
```
InternationalFormatter は、String への変換と String からの変換を処理する java.text.Format のインスタンスを使用して、DefaultFormatter を拡張します。
getAllowsInvalid() が false の場合、各編集の現行テキストに書式を付けるよう Format に求めます。
setMinimum メソッドと setMaximum メソッドで最小値と最大値を指定できます。これを有効にするには、stringToValue から返された値が、Comparable インタフェースを介して最大値/最小値と比較可能である必要があります。
特定の値が入力不可になるといった状況を作り出すことがあるため、Format と InternationalFormatter の構成方法には注意が必要です。常に有効な InternationalFormatter (setAllowsInvalid(false)) である日付書式「M/d/yy」が上書きモード (setOverwriteMode(true)) であり、日付は 7/1/99 であるとします。この場合、ユーザーは 2 桁の月および日付を入力できません。これを回避するには、書式を「MM/dd/yy」にする必要があります。
InternationalFormatter が、有効な値 (setAllowsInvalid(false)) だけを許可するように構成されている場合、有効な各編集は、Format から完全にリセットされた JFormattedTextField のテキストになります。またカーソル位置は、リテラル文字が結果として得られる String に対して追加または削除されるように調整されます。
stringToValue の InternationalFormatter の動作は、DefaultTextFormatter の動作とはわずかに違います。この場合は以下を実行します。
1. parseObject は、setFormat で指定された Format 上で呼び出される
2. Class がその値に設定されると (setValueClass)、スーパークラスの実装が呼び出され、parseObject から返された値を適切なクラスに変換する。
3. ParseException がスローされておらず、またその値が最大値、最小値の範囲外である場合、ParseException がスローされる。
4. 値が返される。
Format が返す代替 Class を指定するには、InternationalFormatter がこの方法で stringToValue を実装します。
警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースとの互換性がなくなる予定です。現在の直列化のサポートは、短期間の格納や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。1.4 以降、すべての JavaBeans^TM 用の長期間の格納サポートが java.beans パッケージに追加されています。XMLEncoder を参照してください。
導入されたバージョン:

1.4

関連項目:
Format, Comparable

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

コンストラクタ
コンストラクタと説明
`InternationalFormatter()` `Format` を指定せずに、`InternationalFormatter` を作成します。
`InternationalFormatter(Format format)` 指定した `Format` インスタンスを使用して、`InternationalFormatter` を作成します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`Object`	`clone()` DefaultFormatter のコピーを作成します。
`protected Action[]`	`getActions()` `getSupportsIncrement` が true を返す場合、値の増減に適した 2 つの Action を返します。
`Format.Field[]`	`getFields(int offset)` `offset` 位置のテキストに関連する `Format.Field` 定数を返します。
`Format`	`getFormat()` 編集、表示が可能な正当な値を規定する書式を返します。
`Comparable`	`getMaximum()` 可能な最大値を返します。
`Comparable`	`getMinimum()` 可能な最小値を返します。
`void`	`install(JFormattedTextField ftf)` `DefaultFormatter` を特定の `JFormattedTextField` にインストールします。
`void`	`setFormat(Format format)` 編集および表示が可能な正当な値を規定する書式を設定します。
`void`	`setMaximum(Comparable max)` 可能な最大値を設定します。
`void`	`setMinimum(Comparable minimum)` 可能な最小値を設定します。
`Object`	`stringToValue(String text)` `String` `text` の `Object` 表現を返します。
`String`	`valueToString(Object value)` オブジェクト `value` の文字列表現を返します。

クラス javax.swing.text.DefaultFormatter から継承されたメソッド
getAllowsInvalid, getCommitsOnValidEdit, getDocumentFilter, getNavigationFilter, getOverwriteMode, getValueClass, setAllowsInvalid, setCommitsOnValidEdit, setOverwriteMode, setValueClass

クラス javax.swing.JFormattedTextField.AbstractFormatter から継承されたメソッド
getFormattedTextField, invalidEdit, setEditValid, uninstall

クラス java.lang.Object から継承されたメソッド
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - InternationalFormatter
```
public InternationalFormatter()
```
    Format を指定せずに、InternationalFormatter を作成します。
  - InternationalFormatter
```
public InternationalFormatter(Format format)
```
    指定した Format インスタンスを使用して、InternationalFormatter を作成します。
    
    パラメータ:
    format - String との相互変換に使用される Format インスタンス
- メソッドの詳細
  - setFormat
```
public void setFormat(Format format)
```
    編集および表示が可能な正当な値を規定する書式を設定します。
    
    パラメータ:
    format - String との相互変換に使用される Format インスタンス
  - getFormat
```
public Format getFormat()
```
    編集、表示が可能な正当な値を規定する書式を返します。
    
    戻り値:
    String との相互変換に使用される Format インスタンス
  - setMinimum
```
public void setMinimum(Comparable minimum)
```
    可能な最小値を設定します。valueClass が未指定で、minimum が null 以外の場合、valueClass は minimum クラスの valueClass に設定されます。
    
    パラメータ:
    minimum - 入力可能な最小適正値
    関連項目:
    DefaultFormatter.setValueClass(java.lang.Class<?>)
  - getMinimum
```
public Comparable getMinimum()
```
    可能な最小値を返します。
    
    戻り値:
    入力可能な最小適正値
  - setMaximum
```
public void setMaximum(Comparable max)
```
    可能な最大値を設定します。valueClass が未指定で、max が null 以外の場合、valueClass は max クラスの valueClass に設定されます。
    
    パラメータ:
    max - 入力可能な最大適正値
    関連項目:
    DefaultFormatter.setValueClass(java.lang.Class<?>)
  - getMaximum
```
public Comparable getMaximum()
```
    可能な最大値を返します。
    
    戻り値:
    入力可能な最大適正値
  - install
```
public void install(JFormattedTextField ftf)
```
    DefaultFormatter を特定の JFormattedTextField にインストールします。これにより valueToString が呼び出されて、現在の値が JFormattedTextField から String へ変換されます。次に、getActions からの Action、getDocumentFilter から返された DocumentFilter、getNavigationFilter から返された NavigationFilter が、JFormattedTextField にインストールされます。
    通常、サブクラスでのオーバーライドが必要になるのは、JFormattedTextField に追加リスナーをインストールする場合だけです。
    現在の値を String に変換するときに ParseException が発生した場合は、テキストとして空の String が設定され、JFormattedTextField に不正な状態を示す値が設定されます。
    これは public メソッドですが、通常は JFormattedTextField のサブクラスに対してだけ有効です。値が変更されるか、内部状態が変更される場合、JFormattedTextField によりこのメソッドが適切なタイミングで呼び出されます。
    
    オーバーライド:
    
    install、クラス: DefaultFormatter
    
    パラメータ:
    ftf - フォーマット対象の JformattedTextField。null の場合は、現在の JFormattedTextField からのアンインストールを示す。
  - valueToString
```
public String valueToString(Object value)
                     throws ParseException
```
    オブジェクト value の文字列表現を返します。これにより、現在の Format 上で format が呼び出されます。
    
    オーバーライド:
    
    valueToString、クラス: DefaultFormatter
    
    パラメータ:
    value - 変換対象の値
    
    戻り値:
    値の文字列表現
    
    例外:
    
    ParseException - 変換でエラーが発生した場合
  - 使用するクラス
```
public Object stringToValue(String text)
                     throws ParseException
```
    String text の Object 表現を返します。
    
    オーバーライド:
    
    stringToValue、クラス: DefaultFormatter
    
    パラメータ:
    text - 変換対象の String
    
    戻り値:
    テキストの Object 表現
    
    例外:
    
    ParseException - 変換でエラーが発生した場合
  - getFields
```
public Format.Field[] getFields(int offset)
```
    offset 位置のテキストに関連する Format.Field 定数を返します。offset の位置が現在のテキスト内で不正である場合は、空の配列が返されます。
    
    パラメータ:
    offset - 検査するテキストへのオフセット
    
    戻り値:
    指定された位置のテキストに関連した Format.Field 定数
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    DefaultFormatter のコピーを作成します。
    
    オーバーライド:
    
    clone、クラス: DefaultFormatter
    
    戻り値:
    DefaultFormatter のコピー
    
    例外:
    
    CloneNotSupportedException - オブジェクトのクラスが Cloneable インタフェースをサポートしていない場合。clone メソッドをオーバーライドしたサブクラスも、インスタンスを複製できないことを示すためにこの例外をスローすることがある。
    関連項目:
    Cloneable
  - getActions
```
protected Action[] getActions()
```
    getSupportsIncrement が true を返す場合、値の増減に適した 2 つの Action を返します。
    
    オーバーライド:
    
    getActions、クラス: JFormattedTextField.AbstractFormatter
    
    戻り値:
    JformattedTextField にインストールするアクションの配列

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス InternationalFormatter

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

メソッドのサマリー

クラス javax.swing.text.DefaultFormatter から継承されたメソッド

クラス javax.swing.JFormattedTextField.AbstractFormatter から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクタの詳細

InternationalFormatter

InternationalFormatter

メソッドの詳細

setFormat

getFormat

setMinimum

getMinimum

setMaximum

getMaximum

install

valueToString

使用するクラス

getFields

clone

getActions