Package nablarch.common.web.tag

Class CodeTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
nablarch.common.web.tag.CustomTagSupport
nablarch.common.web.tag.HtmlTagSupport
nablarch.common.web.tag.CodeTag
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 CodeTag extends HtmlTagSupport
コード値を出力するクラス。
See Also:

  • Field Summary

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

    id, pageContext

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

    EVAL_BODY_AGAIN

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

    EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CodeTag()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doStartTag()
    void
    setCodeId(String codeId)
    コードIDを設定する。
    void
    setLabelPattern(String labelPattern)
    ラベルを整形するパターンを設定する。
    void
    setListFormat(String listFormat)
    リスト表示時に使用するフォーマットを設定する。
    void
    setName(String name)
    XHTMLのname属性を設定する。
    void
    setOptionColumnName(String optionColumnName)
    取得するオプション名称のカラム名を設定する。
    void
    setPattern(String pattern)
    使用するパターンのカラム名を設定する。

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

    doCatch, doFinally, getAttributes, setDynamicAttribute

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

    doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CodeTag

      public CodeTag()

  • Method Details

    • setName

      public void setName(String name)
      XHTMLのname属性を設定する。
      Parameters:
      name - XHTMLのname属性

    • 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 - リスト表示時に使用するフォーマット

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspException
       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