Package nablarch.common.web.tag

Class ListSelectTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
nablarch.common.web.tag.CustomTagSupport
nablarch.common.web.tag.HtmlTagSupport
nablarch.common.web.tag.GenericAttributesTagSupport
nablarch.common.web.tag.SelectTagSupport
nablarch.common.web.tag.ListSelectTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.DynamicAttributes, jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, jakarta.servlet.jsp.tagext.TryCatchFinally, Serializable
public class ListSelectTag extends SelectTagSupport
入力データ復元とHTMLエスケープを行う選択項目(selectタグ)を出力するクラス。
See Also:

  • Constructor Details

    • ListSelectTag

      public ListSelectTag()

  • Method Details

    • setListName

      public void setListName(String listName)
      リストを取得するための名前を設定する。
      Parameters:
      listName - リストを取得するための名前

    • setElementValueProperty

      public void setElementValueProperty(String elementValueProperty)
      リスト要素から値を取得するためのプロパティ名を設定する。
      Parameters:
      elementValueProperty - リスト要素から値を取得するためのプロパティ名

    • setElementLabelProperty

      public void setElementLabelProperty(String elementLabelProperty)
      リスト要素からラベルを取得するためのプロパティ名を設定する。
      Parameters:
      elementLabelProperty - リスト要素からラベルを取得するためのプロパティ名

    • setElementLabelPattern

      public void setElementLabelPattern(String elementLabelPattern)
      リスト要素のラベルを整形するためのパターンを設定する。 
       プレースホルダを下記に示す。
 $LABEL$: ラベル
 $VALUE$: 値
 
 "$VALUE$ - $LABEL$"と指定した場合、ラベル＝グループ1、値＝G001とすると、整形後のラベルは"G001 - グループ1"となる。
 デフォルトは"$LABEL$"。
      Parameters:
      elementLabelPattern - リスト要素のラベルを整形するためのパターン

    • setListFormat

      public void setListFormat(String listFormat)
      リスト表示時に使用するフォーマットを設定する。 
       下記のいずれかを指定する。
 br(brタグ)
 div(divタグ)
 span(spanタグ)
 ul(ulタグ)
 ol(olタグ)
 sp(スペース区切り)
 
 デフォルトはbr。
      Parameters:
      listFormat - リスト表示時に使用するフォーマット

    • setWithNoneOption

      public void setWithNoneOption(boolean withNoneOption)
      リスト先頭に選択なしのオプションを追加するか否かを設定する。
      デフォルトはfalse。
      Parameters:
      withNoneOption - 追加する場合はtrue、追加しない場合はfalse

    • setNoneOptionLabel

      public void setNoneOptionLabel(String noneOptionLabel)
      リスト先頭に選択なしのオプションを追加する場合に使用するラベルを設定する。 
       この属性は、withNoneOptionにtrueを指定した場合のみ有効となる。
 デフォルトは""。
      Parameters:
      noneOptionLabel - リスト先頭に選択なしのオプションを追加する場合に使用するラベル

    • setErrorCss

      public void setErrorCss(String errorCss)
      エラーレベルのメッセージに使用するCSSクラス名を設定する。
      デフォルトは"nablarch_error"。
      Parameters:
      errorCss - エラーレベルのメッセージに使用するCSSクラス名

    • setNameAlias

      public void setNameAlias(String nameAlias)
      name属性のエイリアスを設定する。
      複数指定する場合はカンマ区切り。
      Parameters:
      nameAlias - name属性のエイリアス

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspException
       入力画面と確認画面で出力内容が異なる。
 
 入力画面：
 リストをoptionタグに展開したselectタグを出力する。
 
 selectタグ：
 指定された属性を使用してselectタグを出力する。
 属性はHTMLエスケープして出力する。
 選択なしオプションが指定された場合は、選択なしのoptionタグを出力する。
 選択なしオプションのvalue属性は常に空文字となる。
 
 optionタグ：
 リストから取得した値とラベルを使用してoptionタグを出力する。
 name属性に対応する入力データが存在する場合はselected属性を設定する。
 属性とラベルはHTMLエスケープして出力する。
 
 FormContextにname属性を設定する。
 
 確認画面：
 name属性に対応する入力データが存在する場合は指定されたフォーマットで出力する。
 ラベルはHTMLエスケープして出力する。
      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class jakarta.servlet.jsp.tagext.TagSupport
      Throws:
      jakarta.servlet.jsp.JspException