nablarch.common.web.tag

クラス FormContext

java.lang.Object

nablarch.common.web.tag.FormContext

public class FormContext
extends java.lang.Object

フォームのコンテキスト情報を保持するクラス。
このコンテキスト情報はページコンテキストに格納する。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FormContext(java.lang.String name) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addHiddenTagInfo(HtmlAttributes hiddenTagInfo) フォームに含まれるhiddenタグの情報を追加する。
void	addHiddenTagInfo(java.lang.String name, java.lang.String... values) フォームに含まれるhiddenタグの情報を追加する。
void	addInputName(java.lang.String name) フォームに含まれる入力項目のname属性を追加する。
java.lang.String	addSubmissionInfo(SubmissionInfo.SubmissionAction action, HtmlAttributes attributes, java.lang.String uri, boolean allowDoubleSubmission, java.lang.String requestId, java.lang.String popupWindowName, java.lang.String popupOption, DisplayMethod displayMethod) フォームに含まれるサブミット情報を追加する。
SubmissionInfo	getCurrentSubmissionInfo() カレントのカレントのサブミット情報を取得する。
HtmlAttributes	getHiddenTagInfo(java.lang.String name) 指定されたname属性の値を持つhiddenタグの情報を取得する。
java.util.List<HtmlAttributes>	getHiddenTagInfoList() フォームに含まれるhiddenタグの情報を取得する。
java.util.Set<java.lang.String>	getInputNames() フォームに含まれる入力項目のname属性を取得する。
java.lang.String	getName() フォームのname属性を取得する。
java.util.List<java.lang.String>	getRequestIds() フォームに含まれるリクエストIDを取得する。
java.util.List<SubmissionInfo>	getSubmissionInfoList() フォームに含まれるサブミット情報を取得する。
void	setCurrentSubmissionInfo(SubmissionInfo currentSubmissionInfo) カレントのカレントのサブミット情報を設定する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

FormContext

public FormContext(java.lang.String name)

コンストラクタ。

パラメータ:

name - フォームのname属性

メソッドの詳細

getName

public java.lang.String getName()

フォームのname属性を取得する。

戻り値:

フォームのname属性

addInputName

public void addInputName(java.lang.String name)

フォームに含まれる入力項目のname属性を追加する。

パラメータ:

name - 入力項目のname属性

getInputNames

public java.util.Set<java.lang.String> getInputNames()

フォームに含まれる入力項目のname属性を取得する。

戻り値:

フォームに含まれる入力項目のname属性

addSubmissionInfo

public java.lang.String addSubmissionInfo(SubmissionInfo.SubmissionAction action,
                                          HtmlAttributes attributes,
                                          java.lang.String uri,
                                          boolean allowDoubleSubmission,
                                          java.lang.String requestId,
                                          java.lang.String popupWindowName,
                                          java.lang.String popupOption,
                                          DisplayMethod displayMethod)

フォームに含まれるサブミット情報を追加する。

サブミットタグのname属性が指定されていない場合、もしくは 同一FORM内で重複している場合は、FORM内で一意となるname属性値を発番し 返却する。

パラメータ:

action - サブミット時の動作

attributes - タグの属性値

uri - サブミット先のURI

allowDoubleSubmission - 二重サブミットを許可するか否か

requestId - サブミット時のリクエストID

popupWindowName - ポップアップのウィンドウ名

popupOption - ポップアップのオプション情報

displayMethod - 表示制御方法

戻り値:

新規に発番されたname属性(発番の必要が無い場合はnullを返す。)

getSubmissionInfoList

public java.util.List<SubmissionInfo> getSubmissionInfoList()

フォームに含まれるサブミット情報を取得する。

戻り値:

フォームに含まれるサブミット情報

getCurrentSubmissionInfo

public SubmissionInfo getCurrentSubmissionInfo()

カレントのカレントのサブミット情報を取得する。

戻り値:

カレントのカレントのサブミット情報

setCurrentSubmissionInfo

public void setCurrentSubmissionInfo(SubmissionInfo currentSubmissionInfo)

カレントのカレントのサブミット情報を設定する。

パラメータ:

currentSubmissionInfo - カレントのカレントのサブミット情報

getRequestIds

public java.util.List<java.lang.String> getRequestIds()

フォームに含まれるリクエストIDを取得する。

戻り値:

フォームに含まれるリクエストID

addHiddenTagInfo

public void addHiddenTagInfo(HtmlAttributes hiddenTagInfo)

フォームに含まれるhiddenタグの情報を追加する。

パラメータ:

hiddenTagInfo - フォームに含まれるhiddenタグの情報

addHiddenTagInfo

public void addHiddenTagInfo(java.lang.String name,
                             java.lang.String... values)

フォームに含まれるhiddenタグの情報を追加する。

パラメータ:

name - name属性の値

values - value属性の値

getHiddenTagInfoList

public java.util.List<HtmlAttributes> getHiddenTagInfoList()

フォームに含まれるhiddenタグの情報を取得する。

戻り値:

フォームに含まれるhiddenタグの情報

getHiddenTagInfo

public HtmlAttributes getHiddenTagInfo(java.lang.String name)

指定されたname属性の値を持つhiddenタグの情報を取得する。

一番最初に見つかったhiddenタグの情報を返す。

パラメータ:

name - name属性の値

戻り値:

指定されたname属性の値を持つhiddenタグの情報。存在しない場合はnull