FormTag (Nablarch-API)

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - nablarch.common.web.tag.CustomTagSupport
  - - nablarch.common.web.tag.HtmlTagSupport
    - - nablarch.common.web.tag.GenericAttributesTagSupport
      - nablarch.common.web.tag.FormTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.DynamicAttributes, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally
```
public class FormTag
extends GenericAttributesTagSupport
```
サブミット制御(ボタンとアクションの紐付け、二重サブミット防止)と不正画面遷移チェックを行うformタグを出力するクラス。

See Also:

Serialized Form

Field Summary
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  id, pageContext
- Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN
- Fields inherited from interface javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors
Constructor and Description

FormTag()

Constructors
Constructor and Description
`FormTag()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`doEndTag()`
`int`	`doStartTag()`
`protected java.lang.String`	`getTagName()` タグ名を取得する。
`void`	`setAccept(java.lang.String accept)` XHTMLのaccept属性を設定する。
`void`	`setAcceptCharset(java.lang.String acceptCharset)` XHTMLのaccept-charset属性を設定する。
`void`	`setAction(java.lang.String action)` XHTMLのaction属性を設定する。
`void`	`setAutocomplete(java.lang.String autocomplete)` HTML5のautocomplete属性を設定する。
`void`	`setEnctype(java.lang.String enctype)` XHTMLのenctype属性を設定する。
`void`	`setMethod(java.lang.String method)` XHTMLのmethod属性を設定する。デフォルトはpost。
`void`	`setName(java.lang.String name)` XHTMLのname属性を設定する。
`void`	`setOnreset(java.lang.String onreset)` XHTMLのonreset属性を設定する。
`void`	`setOnsubmit(java.lang.String onsubmit)` XHTMLのonsubmit属性を設定する。
`void`	`setPreventPostResubmit(boolean preventPostResubmit)` POST再送信を防止するか否かを設定する。デフォルトはfalse。
`void`	`setSecure(java.lang.Boolean secure)` URIをhttpsにするか否かを設定する。
`void`	`setTarget(java.lang.String target)` XHTMLのtarget属性を設定する。
`void`	`setUseToken(java.lang.Boolean useToken)` トークンを設定するか否かを設定する。
`void`	`setWindowScopePrefixes(java.lang.String windowScopePrefixes)` ウィンドウスコープ変数のプレフィックスを設定する。

Methods inherited from class nablarch.common.web.tag.GenericAttributesTagSupport
checkChildElementsOfForm, setCssClass, setDir, setId, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setTitle, setXmlLang

Methods inherited from class nablarch.common.web.tag.HtmlTagSupport
doCatch, doFinally, getAttributes, setDynamicAttribute

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- FormTag
```
public FormTag()
```

Method Detail

setWindowScopePrefixes
```
public void setWindowScopePrefixes(java.lang.String windowScopePrefixes)
```
ウィンドウスコープ変数のプレフィックスを設定する。
```
 複数指定する場合はカンマ区切り。
 
```
Parameters:

windowScopePrefixes - ウィンドウスコープ変数のプレフィックス

setUseToken

public void setUseToken(java.lang.Boolean useToken)

トークンを設定するか否かを設定する。

 デフォルトはfalse。
 confirmationPageタグが指定された場合は、デフォルトがtrueとなる。

Parameters:: useToken - トークンを設定する場合はtrue、設定しない場合はfalse。

setSecure
```
public void setSecure(java.lang.Boolean secure)
```
URIをhttpsにするか否かを設定する。

Parameters:

secure - httpsにする場合はtrue、しない場合はfalse。

setPreventPostResubmit
```
public void setPreventPostResubmit(boolean preventPostResubmit)
```
POST再送信を防止するか否かを設定する。
デフォルトはfalse。

Parameters:

preventPostResubmit - POST再送信を防止する場合はtrue、しない場合はfalse。

setAction
```
public void setAction(java.lang.String action)
```
XHTMLのaction属性を設定する。

Parameters:

action - XHTMLのaction属性

setAutocomplete
```
public void setAutocomplete(java.lang.String autocomplete)
```
HTML5のautocomplete属性を設定する。

Parameters:

autocomplete - HTML5のautocomplete属性

setMethod
```
public void setMethod(java.lang.String method)
```
XHTMLのmethod属性を設定する。
デフォルトはpost。

Parameters:

method - XHTMLのmethod属性

setName
```
public void setName(java.lang.String name)
```
XHTMLのname属性を設定する。

Parameters:

name - XHTMLのname属性

setEnctype
```
public void setEnctype(java.lang.String enctype)
```
XHTMLのenctype属性を設定する。

Parameters:

enctype - XHTMLのenctype属性

setOnsubmit
```
public void setOnsubmit(java.lang.String onsubmit)
```
XHTMLのonsubmit属性を設定する。

Parameters:

onsubmit - XHTMLのonsubmit属性

setOnreset
```
public void setOnreset(java.lang.String onreset)
```
XHTMLのonreset属性を設定する。

Parameters:

onreset - XHTMLのonreset属性

setAccept
```
public void setAccept(java.lang.String accept)
```
XHTMLのaccept属性を設定する。

Parameters:

accept - XHTMLのaccept属性

setAcceptCharset
```
public void setAcceptCharset(java.lang.String acceptCharset)
```
XHTMLのaccept-charset属性を設定する。

Parameters:

acceptCharset - XHTMLのaccept-charset属性

setTarget
```
public void setTarget(java.lang.String target)
```
XHTMLのtarget属性を設定する。

Parameters:

target - XHTMLのtarget属性

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

 開始タグとサブミット制御に使用するJavaScriptのサブミット関数を出力する。
 method属性がpostかつ画面内で1番目のフォームタグの場合のみサブミット関数を出力する。
 サブミット関数が出力される前にサブミットされJavaScriptエラーが発生することを防ぐため、
 JavaScriptのサブミット関数は開始タグの直前に出力する。
 method属性の指定がない場合は、postを設定する。
 name属性の指定がない場合は、値を生成し設定する。
 属性はHTMLエスケープして出力する。

Specified by:: doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:: doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:: javax.servlet.jsp.JspException

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

 閉じタグとサブミット制御に使用するJavaScriptのサブミット情報を出力する。
 
 サブミット制御のJavaScriptの出力が完了する前にサブミットされることを防ぐため、
 サブミット制御のJavaScriptの出力が完了したことを示すマーカを閉じタグの直後に出力する。
 ここで出力したマーカをサブミット関数が参照し、サブミット可否の判定に使用する。

 CSRFトークンがリクエスト属性に存在すればhiddenタグに追加する。

 楽観的ロックで使用するバージョン番号をhiddenタグに追加する。
 
 ウィンドウスコープ変数のプレフィックスが指定されている場合は、リクエストパラメータからhiddenタグを出力する。
 リクエストパラメータからhiddenタグを出力する際は、既に入力項目として出力されているパラメータは除く。
 
 hiddenタグは、改竄や情報漏洩などのセキュリティ上の問題となるケースがあるため、デフォルトで暗号化して出力する。
 ただし、下記のどちらかの条件を満たす場合は暗号化せずに平文でhiddenタグを出力する。
 ・hiddenタグの暗号化機能を「使用しない」に設定している。
 ・フォーム内のリクエストIDが設定された暗号化を行わないリクエストIDに全て含まれる。
 上記設定は、カスタムタグのデフォルト値設定から行う。
 
 useTokenにtrueが指定されている場合、又はuseTokenが未指定で確認画面の場合は、
 トークンを生成しhiddenタグを出力する。
 
 ただし、method属性がgetかつCustomTagConfigのuseGetRequestがtrueの場合は、上記処理は行わずに閉じタグのみを出力して処理を終了する。

Specified by:: doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:: doEndTag in class javax.servlet.jsp.tagext.TagSupport
Throws:: javax.servlet.jsp.JspException

getTagName
```
protected java.lang.String getTagName()
```
タグ名を取得する。

Specified by:

getTagName in class GenericAttributesTagSupport

Returns:

タグ名

Class FormTag

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

Fields inherited from interface javax.servlet.jsp.tagext.Tag

Constructor Summary

Method Summary

Methods inherited from class nablarch.common.web.tag.GenericAttributesTagSupport

Methods inherited from class nablarch.common.web.tag.HtmlTagSupport

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

Methods inherited from class java.lang.Object

Constructor Detail

FormTag

Method Detail

setWindowScopePrefixes

setUseToken

setSecure

setPreventPostResubmit

setAction

setAutocomplete

setMethod

setName

setEnctype

setOnsubmit

setOnreset

setAccept

setAcceptCharset

setTarget

doStartTag

doEndTag

getTagName