report
インタフェース FieldFormat
public interface FieldFormat
ユーザが定義した編集フィールドのフォーマッタが実装するインタフェース
format
FieldFormatResult format(java.lang.String value,
Field field,
Context context)
throws ReportUserException
- パッケージ・ユーザが、テキスト編集レイアウトで編集フィールドとして指定されたフィールドの置換文字列をフォーマットするためのハンドラを、パッケージが呼び出すメソッド。
編集データ・セットの辞書から検索された文字列は引数 value に渡され、対応するフィールドのレイアウト指定は引数 field に渡される。
ユーザによる置換文字列のフォーマット結果は、FieldFormatResult#setValue() で指定し、このメソッドから戻った後でパッケージによる日本語志向の折り返し処理を行う場合には FieldFormatResult#setNeedFoldJP(true) で指定する。
- パラメータ:
value
- 編集データ・セットで指定された置換文字列が渡される。field
- レイアウトで指定されたフィールドの設定が渡される。context
- フィールドを保持するレコードと編集データを保持する辞書構造などのコンテクストが渡される。
- 戻り値:
- フォーマット結果を設定した FieldFormatResut を返す。null を返した場合は、パッケージにより置換文字列の日本語志向の折り返し処理が行われる。
- 例外:
パッケージ・ユーザは、フォーマット処理中に異常が発生したならば、ReportUserException
- を投げることができる。
ReportUserException