Apex 開発者ガイド
jNewer Version Available
Message クラス
名前空間
使用方法
標準コントローラを使用している場合、エンドユーザがページを保存したときに発生するすべての入力規則エラー (標準およびカスタム) が自動的にページのエラーコレクションに追加されます。inputField コンポーネントがバインドされた項目にエラーが発生すると、そのコンポーネントのエラーコレクションにメッセージが追加されます。そのページのエラーコレクションにすべてのメッセージが追加されます。詳細は、『Visualforce 開発者ガイド』の「標準コントローラ」を参照してください。
アプリケーションでカスタムコントローラや拡張を使用する場合は、エラーを収集するための message クラスを使用する必要があります。
インスタンス化
カスタムコントローラまたはコントローラ拡張では、次のいずれかの方法でメッセージをインスタンス化できます。
-
1ApexPages.Message myMsg = new ApexPages.Message(ApexPages.severity, summary);ここで、ApexPages.severity はメッセージの重要度を指定する enum で、summary はメッセージを要約するために使用する String です。次に例を示します。
1ApexPages.Message myMsg = new ApexPages.Message(ApexPages.Severity.FATAL, 'my error msg'); -
1ApexPages.Message myMsg = new ApexPages.Message(ApexPages.severity, summary, detail);ここで、ApexPages.severity はメッセージの重要度を指定する enum、summary はメッセージを要約するために使用する String、detail はエラーに関する詳細情報を示す String です。
- CONFIRM
- ERROR
- FATAL
- INFO
- WARNING
すべての enum は、name や value などの標準メソッドにアクセスできます。
Message のコンストラクタ
Message のコンストラクタは次のとおりです。
Message(severity, summary)
署名
public Message(ApexPages.Severity severity, String summary)
パラメータ
- severity
- 型: ApexPages.Severity
- Visualforce メッセージの重要度。
- summary
- 型: String
- Visualforce の概要メッセージ。
Message(severity, summary, detail)
署名
public Message(ApexPages.Severity severity, String summary, String detail)
パラメータ
- severity
- 型: ApexPages.Severity
- Visualforce メッセージの重要度。
- summary
- 型: String
- Visualforce の概要メッセージ。
- detail
- 型: String
- Visualforce の詳細メッセージ。
Message(severity, summary, detail, id)
署名
public Message(ApexPages.Severity severity, String summary, String detail, String id)
パラメータ
- severity
- 型: ApexPages.Severity
- Visualforce メッセージの重要度。
- summary
- 型: String
- Visualforce の概要メッセージ。
- detail
- 型: String
- Visualforce の詳細メッセージ。
- id
- 型: String
- メッセージに関連付ける Visualforce コンポーネントの ID (エラーのあるフォーム項目など)。
Message のメソッド
Message のメソッドは次のとおりです。すべてインスタンスメソッドです。
getComponentLabel()
署名
public String getComponentLabel()
戻り値
型: String
getDetail()
署名
public String getDetail()
戻り値
型: String