ValidatorTool Marino A. Jonsson xdocs-ja/struts/menu.xml Shinobu Kawai 木村 貴由 ValidatorTool

The ValidatorTool is used to interact with the Validator framework to generate dynamic javascript for form validation.

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

@@@version@@@, @@@date@@@ org.apache.velocity.tools.struts.ValidatorTool $validator Marino A. Jonsson <tool> <key>validator</key> <scope>request</scope> <class>org.apache.velocity.tools.struts.ValidatorTool</class> </tool>
Gets the current page number of a multi-part form. int getPage()

Gets the current page number of a multi-part form. Only field validations with a matching page number will be generated that match the current page number.

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

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

Sets the current page number of a multi-part form. void setPage(int page) the current page number of a multi-part form.

Sets the current page number of a multi-part form. Only field validations with a matching page number will be generated that match the current page number.

 マルチパートフォームの現在のページ番号を設定します。 void setPage(int page) マルチパートフォームの現在のページ番号。

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

Gets the method name that will be used for the javascript validation method name if it has a value. String getMethod()

Gets the method name that will be used for the javascript validation method name if it has a value. This overrides the auto-generated method name based on the key (form name) passed in.

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

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

Sets the method name that will be used for the javascript validation method name if it has a value. void setMethod(String methodName) the method name that will be used for the javascript validation method name.

Sets the method name that will be used for the javascript validation method name if it has a value. This overrides the auto-generated method name based on the key (form name) passed in.

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

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

Gets whether or not to delimit the javascript with html comments. boolean getHtmlComment()

Gets whether or not to delimit the javascript with html comments. If this is set to 'true', which is the default, html comments will surround the javascript.

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

javascriptをhtmlコメントで囲むかどうかを取得します。 'true'(デフォルト)の場合、javascriptはhtmlコメントで囲まれます。
Sets whether or not to delimit the javascript with html comments. void setHtmlComment(boolean htmlComment) whether or not to delimit the javascript with html comments.

Sets whether or not to delimit the javascript with html comments. If this is set to 'true', which is the default, html comments will surround the javascript.

 javascriptをhtmlコメントで囲むかどうかを設定します。 void setHtmlComment(boolean htmlComment) javascriptをhtmlコメントで囲むかどうか。

javascriptをhtmlコメントで囲むかどうかを設定します。 'true'(デフォルト)の場合、javascriptはhtmlコメントで囲まれます。
Gets the src attribute's value when defining the html script element. String getSrc()

Gets the src attribute's value when defining the html script element.

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

htmlのscript要素を定義する時のsrc属性の値を取得します。
Sets the src attribute's value (used to include an external script resource) when defining the html script element. void setSrc(String src) the src attribute's value.

Sets the src attribute's value (used to include an external script resource) when defining the html script element.

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

htmlのscript要素を定義する時のsrc属性の値を設定します。 これは外部スクリプトリソースを指定する時に使用します。
Returns the cdata setting "true" or "false". boolean getCdata()

Returns the cdata setting "true" or "false".

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

cdataの設定"true"または"false"を返却します。
Sets the cdata status. void setCdata(boolean cdata) The cdata to set

Sets the cdata status.

 cdataステータスを設定します。 void setCdata(boolean cdata) 設定するcdata

cdataステータスを設定します。
Generates javascript to perform validations on a struts-defined form. String getJavascript() String getJavascript(String formName) The name of a struts-defined form.

Generates both dynamic and static javascript to perform validations on a struts-defined form. By default it uses the form associated with the action. A form name can also be supplied as a parameter to generate javascript for a struts-defined form that is not associated with this particular action.

Assuming that the name of a form associated with a given action is myForm, the following Velocity script:

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

produces something like this output (heavily abbreviated):

<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) 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>
Generates the dynamic javascript methods to perform validation on a struts-defined form. String getDynamicJavascript() String getDynamicJavascript(String formName) The name of a struts-defined form.

Generates the dynamic javascript to perform validations on a struts-defined form. By default it uses the form associated with the action. A form name can also be supplied as a parameter to generate javascript for a struts-defined form that is not associated with this particular action. This method does not work by itself - it requires that the relevant static methods be accessible i.e. in a seperate .js file.

Assuming that the name of a form associated with a given action is myForm, the following Velocity script:

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

produces something like this output (heavily abbreviated):

<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) 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>
Generates all the static javascript methods from validator-rules.xml. String getStaticJavascript()

Generates the static javascript methods from validator-rules.xml to perform validations on a any form. Useful i.e. if the static methods should be located in a seperate .js file.

The following Velocity script:

$validator.getStaticJavascript()

produces something like this output (heavily abbreviated):

<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>