Class: MessageOutputController

MessageOutputController

new MessageOutputController()

メッセージ及びvalidate結果から作成したメッセージを出力するコントローラ
Source:

Methods

(static) addMessageSetting(messageSetting)

メッセージ出力先の設定を適用する

メッセージをValidationResultから出力する(appendMessageByValidationResultを使用する)場合の設定を行うメソッド。

プロパティ毎の設定を以下のようなオブジェクトで指定します。既に設定済みのプロパティがある場合、設定は上書かれます。 


addMessageSetting({
	// プロパティ名をキーにして、プロパティ毎のメッセージ定義を記述
	userid: {
		displayName: 'ユーザID', // 表示名
		message: '{displayName}がルール{rule}に違反しています。', // メッセージ。プレースホルダを記述可能(後述)。
	},
	address: {
		message: 'アドレスが不正です'
	}
});

message,displayName設定プロパティについてはh5.ui.FormController.setSettingをご覧ください。

Parameters:
Name Type Description
messageSetting Object プロパティ毎のメッセージ定義。{プロパティ名: {message:..., displayName:...}} のようなオブジェクト
Source:

(static) appendMessageByValidationResult(validationResult, namesopt)

ValidationResultからメッセージを作成してコンテナに追加表示する

ValidationResultが非同期バリデート待ちの場合は、結果が返ってきたタイミングでメッセージを表示します。

setContainerで設定済みコンテナにメッセージを出力します。コンテナ未設定の場合は何もしません。

メッセージはsetWrapperで設定したラッパーで包んで出力します。ラッパー未設定の場合はテキストノードとしてしゅつりょくします。

Parameters:
Name Type Attributes Description
validationResult ValidationResult
names string | Array.<string> <optional>
 出力対象のプロパティ名。指定しない場合は全てが対象
Source:

(static) clearMessage()

コンテナからメッセージを削除

setContainerで設定した出力先からメッセージを削除します。出力先未設定の場合は何もしません。

Source:

(static) getMessageByValidationResult(validationResult, name) → {string}

ValidationResultからエラーメッセージを作成して返す

第1引数に指定されたプロパティ名についてのエラーメッセージを作成して返します

指定されたプロパティがエラーでない場合はnullを返します。

Parameters:
Name Type Description
validationResult ValidationResult
name string 対象のプロパティ名
Returns:
エラーメッセージ
Type
string
Source:

(static) setContainer(container)

メッセージ出力先要素をコンテナとして設定する
Parameters:
Name Type Description
container DOM | jQuery | string デフォルト出力先(コンテナ)要素をDOM要素、jQueryオブジェクト、セレクタ文字列の何れかで指定
Source:

(static) setWrapper(wrapper)

メッセージ出力時にメッセージをラップする要素の設定

タグまたはタグ生成文字列をラッパーとして設定します。

タグ名を指定した場合、指定されたタグで生成した要素でメッセージをラップします。

'<span class="hoge">'のようなタグ生成文字列も設定でき、指定された文字列から作成した要素でメッセージをラップします。

ラッパーの指定がない場合は、このコントローラはメッセージをテキストノードとして出力します。

Parameters:
Name Type Description
wrapper string メッセージをラップするタグまたはタグ生成文字列
Source: