Package nablarch.common.web.tag

Class WriteTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
nablarch.common.web.tag.CustomTagSupport
nablarch.common.web.tag.WriteTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, jakarta.servlet.jsp.tagext.TryCatchFinally, Serializable
Direct Known Subclasses:
PrettyPrintTag, RawWriteTag
public class WriteTag extends CustomTagSupport
名前に対応する値を出力するクラス。 このタグで出力された値は必ずHTMLエスケープされる。
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
    WriteTag()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doStartTag()
    void
    setName(String name)
    出力対象の名前を設定する。
    void
    setValue(String value)
    出力する値を設定する。
    void
    setValueFormat(String valueFormat)
    出力時のフォーマットを設定する。
    void
    setWithHtmlFormat(boolean withHtmlFormat)
    HTMLフォーマット(改行と半角スペースの変換)をするか否かを設定する。
    HTMLフォーマットはHTMLエスケープをする場合のみ有効となる。

    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

  • Constructor Details

    • WriteTag

      public WriteTag()

  • Method Details

    • setName

      public void setName(String name)
      出力対象の名前を設定する。
      Parameters:
      name - 出力対象の名前

    • setValue

      public void setValue(String value)
      出力する値を設定する。
      Parameters:
      value - 出力する値

    • setWithHtmlFormat

      public void setWithHtmlFormat(boolean withHtmlFormat)
      HTMLフォーマット(改行と半角スペースの変換)をするか否かを設定する。
      HTMLフォーマットはHTMLエスケープをする場合のみ有効となる。
      Parameters:
      withHtmlFormat - HTMLフォーマット(改行と半角スペースの変換)をする場合はtrue、しない場合はfalse。

    • setValueFormat

      public void setValueFormat(String valueFormat)
      出力時のフォーマットを設定する。 
       フォーマットは、"データタイプ{パターン}"形式で指定する。
 
 フレームワークがデフォルトでサポートしているフォーマットを下記に示す。
 
 dateString:
   日付文字列のフォーマット。
   値は、yyyyMMdd形式の文字列を指定する。
   パターンには、java.text.SimpleDateFormatが規定している構文を指定する。
   CustomTagConfigを使用してパターンのデフォルト値を設定することができる。
   例：dateString{yyyy/MM/dd}
 
 dateTime:
   日時のフォーマット。
   値は、java.util.Date型を指定する。
   パターンには、java.text.SimpleDateFormatが規定している構文を指定する。
   CustomTagConfigを使用してパターンのデフォルト値を設定することができる。
   例：datetime{yy/MM/dd HH:mm:ss}
 
 decimal:
   10進数のフォーマット。
   値は、java.lang.Number型又は数字の文字列を指定する。
   数字の文字列の場合は、カンマを取り除いた後でフォーマットする。
   パターンには、java.text.DecimalFormatが規定している構文を指定する。
   例：decimal{###.##%}
      Parameters:
      valueFormat - 出力時のフォーマット

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspException
       name属性に対応する値もしくはvalue属性の値を出力する。
 name属性とvalue属性両方とも指定された場合は例外を送出する。
 name属性に対応する値は、変数スコープのみから取得する。(リクエストパラメータは取得先に含まない)
 name属性に対応する値が取得できない場合は何も出力しない。
 format属性が指定されている場合は、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