Package nablarch.common.web.tag

Class ErrorTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
nablarch.common.web.tag.CustomTagSupport
nablarch.common.web.tag.ErrorTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, jakarta.servlet.jsp.tagext.TryCatchFinally, Serializable
public class ErrorTag extends CustomTagSupport
エラーメッセージを出力するクラス。
エラーの原因となった入力項目の近くにエラーメッセージを個別に表示する場合に使用する。
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Set<String>
    MESSAGE_FORMATS
    メッセージ表示時に使用するフォーマットの種類

    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
    ErrorTag()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doStartTag()
    void
    setErrorCss(String errorCss)
    エラーレベルのメッセージに使用するCSSクラス名を設定する。
    void
    setMessageFormat(String messageFormat)
    メッセージ表示時に使用するフォーマットを設定する。
    void
    setName(String name)
    エラーメッセージを表示する入力項目のname属性を設定する。

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

    doCatch, doFinally

    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

  • Field Details

    • MESSAGE_FORMATS

      public static final Set<String> MESSAGE_FORMATS
      メッセージ表示時に使用するフォーマットの種類

  • Constructor Details

    • ErrorTag

      public ErrorTag()

  • Method Details

    • setName

      public void setName(String name)
      エラーメッセージを表示する入力項目のname属性を設定する。
      Parameters:
      name - エラーメッセージを表示する入力項目のname属性

    • setErrorCss

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

    • setMessageFormat

      public void setMessageFormat(String messageFormat)
      メッセージ表示時に使用するフォーマットを設定する。 
       span(spanタグ)、div(divタグ)のいずれかを指定する。
      
 デフォルトはdiv。
      Parameters:
      messageFormat - メッセージ表示時に使用するフォーマット

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspException
       name属性に対応するエラーメッセージが存在しない場合は何も出力しない。
 エラーメッセージを指定されたフォーマットで出力する。
      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class jakarta.servlet.jsp.tagext.TagSupport
      Throws:
      jakarta.servlet.jsp.JspException