Package nablarch.common.web.tag

Class CodeSelectTag

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.CodeSelectTag
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 CodeSelectTag extends SelectTagSupport
入力データ復元とHTMLエスケープを行うコード値の選択項目(selectタグ)を出力するクラス。
See Also:

  • Constructor Details

    • CodeSelectTag

      public CodeSelectTag()

  • Method Details

    • setCodeId

      public void setCodeId(String codeId)
      コードIDを設定する。
      Parameters:
      codeId - コードID

    • setPattern

      public void setPattern(String pattern)
      使用するパターンのカラム名を設定する。
      Parameters:
      pattern - 使用するパターンのカラム名

    • setOptionColumnName

      public void setOptionColumnName(String optionColumnName)
      取得するオプション名称のカラム名を設定する。
      Parameters:
      optionColumnName - 取得するオプション名称のカラム名

    • setLabelPattern

      public void setLabelPattern(String labelPattern)
      ラベルを整形するパターンを設定する。 
       プレースホルダを下記に示す。
 
 $NAME$: コード値に対応するコード名称
 $SHORTNAME$: コード値に対応するコードの略称
 $OPTIONALNAME$: コード値に対応するコードのオプション名称
                 $OPTIONALNAME$を使用する場合は、optionColumnName属性の指定が必須となる。
 $VALUE$: コード値
 
 デフォルトは"$NAME$"。
      Parameters:
      labelPattern - ラベルを整形するパターン

    • 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

    • getTagName

      protected String getTagName()
      タグ名を取得する。
      Overrides:
      getTagName in class SelectTagSupport
      Returns:
      タグ名