ValidatorToolはValidatorフレームワークと連携してフォームバリデーション用の動的javascriptを生成するために使用されます。

<tool>
  <key>validator</key>
  <scope>request</scope>
  <class>org.apache.velocity.tools.struts.ValidatorTool</class>
</tool>

Method Overview

getPage()	Gets the current page number of a multi-part form.
setPage()	Sets the current page number of a multi-part form.
getMethod()	Gets the method name that will be used for the javascript validation method name if it has a value.
setMethod()	Sets the method name that will be used for the javascript validation method name if it has a value.
getHtmlComment()	Gets whether or not to delimit the javascript with html comments.
setHtmlComment()	Sets whether or not to delimit the javascript with html comments.
getSrc()	Gets the src attribute's value when defining the html script element.
setSrc()	Sets the src attribute's value (used to include an external script resource) when defining the html script element.
getCdata()	Returns the cdata setting "true" or "false".
setCdata()	Sets the cdata status.
getJavascript()	Generates javascript to perform validations on a struts-defined form.
getDynamicJavascript()	Generates the dynamic javascript methods to perform validation on a struts-defined form.
getStaticJavascript()	Generates all the static javascript methods from validator-rules.xml.

Method Overview

getPage()	マルチパートフォームの現在のページ番号を取得します。
setPage()	マルチパートフォームの現在のページ番号を設定します。
getMethod()	このメソッドが値を返却する場合、バリデーションを行うjavascriptのメソッド名として使われます。
setMethod()	このメソッドに値を設定した場合、バリデーションを行うjavascriptのメソッド名として使われます。
getHtmlComment()	javascriptをhtmlコメントで囲むかどうかを取得します。
setHtmlComment()	javascriptをhtmlコメントで囲むかどうかを設定します。
getSrc()	htmlのscript要素を定義する時のsrc属性の値を取得します。
setSrc()	htmlのscript要素を定義する時のsrc属性の値を設定します。 これは外部スクリプトリソースを指定する時に使用します。
getCdata()	cdataの設定"true"または"false"を返却します。
setCdata()	cdataステータスを設定します。
getJavascript()	strutsで定義されたフォームのバリデーションを行うjavascriptを生成します。
getDynamicJavascript()	strutsで定義されたフォームのバリデーションを行う動的javascriptを生成します。
getStaticJavascript()	validator-rules.xmlからすべての静的javascriptメソッドを生成します。

マルチパートフォームの現在のページ番号を取得します。

int getPage()

マルチパートフォームの現在のページ番号を取得します。 現在のページ番号と同じページ番号を持つフィールドのみのバリデーションが生成されます。

マルチパートフォームの現在のページ番号を設定します。

void setPage(int page)

Parameters

page

マルチパートフォームの現在のページ番号。

マルチパートフォームの現在のページ番号を設定します。 現在のページ番号と同じページ番号を持つフィールドのみのバリデーションが生成されます。

このメソッドが値を返却する場合、バリデーションを行うjavascriptのメソッド名として使われます。

String getMethod()

このメソッドが値を返却する場合、バリデーションを行うjavascriptのメソッド名として使われます。 これは与えられたキー(フォーム名)から自動生成されるメソッド名をオーバーライドします。

このメソッドに値を設定した場合、バリデーションを行うjavascriptのメソッド名として使われます。

void setMethod(String methodName)

Parameters

methodName

バリデーションjavascriptのメソッド名

このメソッドに値を設定した場合、バリデーションを行うjavascriptのメソッド名として使われます。 これは与えられたキー(フォーム名)から自動生成されるメソッド名をオーバーライドします。

javascriptをhtmlコメントで囲むかどうかを取得します。

boolean getHtmlComment()

javascriptをhtmlコメントで囲むかどうかを取得します。 'true'(デフォルト)の場合、javascriptはhtmlコメントで囲まれます。

javascriptをhtmlコメントで囲むかどうかを設定します。

void setHtmlComment(boolean htmlComment)

Parameters

htmlComment

javascriptをhtmlコメントで囲むかどうか。

javascriptをhtmlコメントで囲むかどうかを設定します。 'true'(デフォルト)の場合、javascriptはhtmlコメントで囲まれます。

htmlのscript要素を定義する時のsrc属性の値を取得します。

String getSrc()

htmlのscript要素を定義する時のsrc属性の値を取得します。

htmlのscript要素を定義する時のsrc属性の値を設定します。 これは外部スクリプトリソースを指定する時に使用します。

void setSrc(String src)

Parameters

src

src属性の値。

htmlのscript要素を定義する時のsrc属性の値を設定します。 これは外部スクリプトリソースを指定する時に使用します。

cdataの設定"true"または"false"を返却します。

boolean getCdata()

cdataの設定"true"または"false"を返却します。

cdataステータスを設定します。

void setCdata(boolean cdata)

Parameters

cdata

設定するcdata

cdataステータスを設定します。

<form action="/someAction.do" onsubmit="return validateMyForm(this)">
...
...
</form>

$validator.getJavascript()

<form action="/someAction.do" onsubmit="return validateMyForm(this)">
...
...
</form>

<script type="text/javascript" language="Javascript1.1">
<!-- Begin

var bCancel = false;

function validateMyForm(form) {
	// call the relevant static methods to validate this form
	...
}

// some more dynamic functions dependent on which validations to perform.
...
...

// finally come all the static validator methods defined in validator-rules.xml
...
...

//End -->
</script>

strutsで定義されたフォームのバリデーションを行うjavascriptを生成します。

String getJavascript()

String getJavascript(String formName)

Parameters

formName

strutsで定義されたフォームの名前。

strutsで定義されたフォームのバリデーションを行う動的、 静的両方のjavascriptを生成します。 デフォルトではアクションと関連付けられたフォームを使用します。 フォーム名を与えることによって、 このアクションと関連付けられていないフォームのためのjavascriptを生成することもできます。

アクションと関連付けられたフォーム名がmyFormとして、 次のVelocityスクリプト:

<form action="/someAction.do" onsubmit="return validateMyForm(this)">
...
...
</form>

$validator.getJavascript()

は以下のような出力を生成します(かなり短縮されています):

<form action="/someAction.do" onsubmit="return validateMyForm(this)">
...
...
</form>

<script type="text/javascript" language="Javascript1.1">
<!-- Begin

var bCancel = false;

function validateMyForm(form) {
	// フォームのバリデーションに必要な静的メソッドを呼び出します
	...
}

// どのバリデーションを行うかに依存する動的function。
...
...

// 最後に、validator-rules.xmlに定義されたバリデーションの静的メソッドが来ます。
...
...

//End -->
</script>

<form action="/someAction.do" onsubmit="return validateMyForm(this)">
...
...
</form>

$validator.getDynamicJavascript()

<form action="/someAction.do" onsubmit="return validateMyForm(this)">
...
...
</form>

<script type="text/javascript" language="Javascript1.1">
<!-- Begin

var bCancel = false;

function validateMyForm(form) {
	// call the relevant static methods to validate this form
	...
}

// some more dynamic functions dependent on which validations to perform.
...
...

//End -->
</script>

strutsで定義されたフォームのバリデーションを行う動的javascriptを生成します。

String getDynamicJavascript()

String getDynamicJavascript(String formName)

Parameters

formName

strutsで定義されたフォームの名前。

strutsで定義されたフォームのバリデーションを行う動的javascriptを生成します。 デフォルトではアクションと関連付けられたフォームを使用します。 フォーム名を与えることによって、 このアクションと関連付けられていないフォームのためのjavascriptを生成することもできます。 このメソッドが単独では動きません。 必要な静的メソッドがアクセスできること(i.e. 別の.jsファイルにて)を要求します。

アクションと関連付けられたフォーム名がmyFormとして、 次のVelocityスクリプト:

<form action="/someAction.do" onsubmit="return validateMyForm(this)">
...
...
</form>

$validator.getDynamicJavascript()

は以下のような出力を生成します(かなり短縮されています):

<form action="/someAction.do" onsubmit="return validateMyForm(this)">
...
...
</form>

<script type="text/javascript" language="Javascript1.1">
<!-- Begin

var bCancel = false;

function validateMyForm(form) {
	// フォームのバリデーションに必要な静的メソッドを呼び出します
	...
}

// どのバリデーションを行うかに依存する動的function。
...
...

//End -->
</script>

$validator.getStaticJavascript()

<script type="text/javascript" language="Javascript1.1">
<!-- Begin

function validateFloatRange(form) {
	...
    	...
}

function validateByte(form) {
	...
    	...
}

// and a bunch more ...
...

//End -->
</script>

validator-rules.xmlからすべての静的javascriptメソッドを生成します。

String getStaticJavascript()

どのフォームに対してもバリデーションを行えるよう、 validator-rules.xmlからすべての静的javascriptメソッドを生成します。 静的メソッドが別の.jsファイルに置かれるべき場合に便利です。

次のVelocityスクリプト:

$validator.getStaticJavascript()

は以下のような出力を生成します(かなり短縮されています):

<script type="text/javascript" language="Javascript1.1">
<!-- Begin

function validateFloatRange(form) {
	...
    	...
}

function validateByte(form) {
	...
    	...
}

// そしてもっとたくさん ...
...

//End -->
</script>