Package nablarch.common.web.tag

Class FormContext

java.lang.Object
nablarch.common.web.tag.FormContext
public class FormContext extends Object
フォームのコンテキスト情報を保持するクラス。
このコンテキスト情報はページコンテキストに格納する。

  • Constructor Details

    • FormContext

      public FormContext(String name)
      コンストラクタ。
      Parameters:
      name - フォームのname属性

  • Method Details

    • getName

      public String getName()
      フォームのname属性を取得する。
      Returns:
      フォームのname属性

    • addInputName

      public void addInputName(String name)
      フォームに含まれる入力項目のname属性を追加する。
      Parameters:
      name - 入力項目のname属性

    • getInputNames

      public Set<String> getInputNames()
      フォームに含まれる入力項目のname属性を取得する。
      Returns:
      フォームに含まれる入力項目のname属性

    • addSubmissionInfo

      public String addSubmissionInfo(SubmissionInfo.SubmissionAction action, HtmlAttributes attributes, String uri, boolean allowDoubleSubmission, String requestId, String popupWindowName, String popupOption, DisplayMethod displayMethod)
      フォームに含まれるサブミット情報を追加する。

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

      Parameters:
      action - サブミット時の動作
      attributes - タグの属性値
      uri - サブミット先のURI
      allowDoubleSubmission - 二重サブミットを許可するか否か
      requestId - サブミット時のリクエストID
      popupWindowName - ポップアップのウィンドウ名
      popupOption - ポップアップのオプション情報
      displayMethod - 表示制御方法
      Returns:
      新規に発番されたname属性(発番の必要が無い場合はnullを返す。)

    • getSubmissionInfoList

      public List<SubmissionInfo> getSubmissionInfoList()
      フォームに含まれるサブミット情報を取得する。
      Returns:
      フォームに含まれるサブミット情報

    • getCurrentSubmissionInfo

      public SubmissionInfo getCurrentSubmissionInfo()
      カレントのカレントのサブミット情報を取得する。
      Returns:
      カレントのカレントのサブミット情報

    • setCurrentSubmissionInfo

      public void setCurrentSubmissionInfo(SubmissionInfo currentSubmissionInfo)
      カレントのカレントのサブミット情報を設定する。
      Parameters:
      currentSubmissionInfo - カレントのカレントのサブミット情報

    • getRequestIds

      public List<String> getRequestIds()
      フォームに含まれるリクエストIDを取得する。
      Returns:
      フォームに含まれるリクエストID

    • addHiddenTagInfo

      public void addHiddenTagInfo(HtmlAttributes hiddenTagInfo)
      フォームに含まれるhiddenタグの情報を追加する。
      Parameters:
      hiddenTagInfo - フォームに含まれるhiddenタグの情報

    • addHiddenTagInfo

      public void addHiddenTagInfo(String name, String... values)
      フォームに含まれるhiddenタグの情報を追加する。
      Parameters:
      name - name属性の値
      values - value属性の値

    • getHiddenTagInfoList

      public List<HtmlAttributes> getHiddenTagInfoList()
      フォームに含まれるhiddenタグの情報を取得する。
      Returns:
      フォームに含まれるhiddenタグの情報

    • getHiddenTagInfo

      public HtmlAttributes getHiddenTagInfo(String name)
      指定されたname属性の値を持つhiddenタグの情報を取得する。

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

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

    • addInlineSubmissionScript

      public void addInlineSubmissionScript(String script)
      サブミット用のスクリプトを登録する。
      Parameters:
      script - サブミット用のスクリプト

    • getInlineSubmissionScripts

      public List<String> getInlineSubmissionScripts()
      これまでに登録されたサブミット用のスクリプト群を返却する。
      Returns:
      サブミット用のスクリプト群