クラス TextTag

すべての実装されたインタフェース:
BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable

public class TextTag extends CommonTagSupport
BODY部に記述されたエンジン固有の文字列({@XXXX}など)を、 ユーザー情報のエンコーディングに変換するタグです。 XML形式で 日本語コードのパースが、JSPエンジン(Tomcat)でサポート されるまでの、暫定的なタグです。 なお、このタグの内部に存在するカスタムタグは、先に実行されるため 漢字コードは、変換されません。 ※ 6.3.1.0 (2015/06/28) caseKey、caseVal、caseNN、caseNull、caseIf 属性追加
関連項目:
機能分類
画面部品
形式サンプル:
●形式:<og:text >・・・</og:text> ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します) ●Tag定義: <og:text value 【TAG】value 値に直接書かれたコードを出力します include 【TAG】動的にファイルを include します(初期値:null) usePrintOut 【TAG】デバッグ用に、value 値を System.out.println に 出力するかどうか(初期値:false) 6.9.3.0 (2018/03/26) useStop 【TAG】6.9.9.1 (2018/08/27) BODYを処理後に停止するかどうか[true/false]を指定します(初期値:false) xssCheck 【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=true]) caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) > ... Body ... </og:text> ●使用例 ・<og:text > <p>あいおえお:<input name="PN" value="{@PN}" /> </p> </og:text> ・<og:text value="あいうえお" /> 動的にファイルを include することが出来ます。 ・<og:text include="{@query}.txt" />
導入されたバージョン:
JDK5.0,
  • コンストラクタの詳細

    • TextTag

      public TextTag()
      デフォルトコンストラクター
      変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
  • メソッドの詳細

    • doStartTag

      public int doStartTag()
      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
      doStartTag インタフェース内 Tag
      オーバーライド:
      doStartTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示( EVAL_BODY_BUFFERED )
      変更履歴:
      6.3.1.0 (2015/06/28) caseKey、caseVal、caseNN、caseNull、caseIf 属性追加
    • doAfterBody

      public int doAfterBody()
      Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
      定義:
      doAfterBody インタフェース内 IterationTag
      オーバーライド:
      doAfterBody クラス内 CommonTagSupport
      戻り値:
      後続処理の指示(SKIP_BODY)
      変更履歴:
      2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更, 3.0.0.0 (2002/12/25) StringUtil#changeString 廃止, 3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。, 4.0.0.0 (2007/10/12) 処理中にエラーを発生させないようにしする。, 6.3.1.0 (2015/06/28) caseKey、caseVal、caseNN、caseNull、caseIf 属性追加, 5.9.10.5 (2016/07/22) XSS対策
    • doEndTag

      public int doEndTag()
      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
      doEndTag インタフェース内 Tag
      オーバーライド:
      doEndTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示
      変更履歴:
      3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 6.3.1.0 (2015/06/28) caseKey、caseVal、caseNN、caseNull、caseIf 属性追加, 6.9.0.2 (2018/02/13) debug="true" で、System.out.println( value ) を出します。, 6.9.3.0 (2018/03/26) debug="true" ではなく、専用属性の usePrintOut で出力を制御します。, 6.9.9.1 (2018/08/27) useStop 属性を追加します。, 7.0.1.3 (2018/11/12) useStop 属性は、useTagが有効の場合のみ判定する。
    • release2

      protected void release2()
      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
      release2 クラス内 CommonTagSupport
      変更履歴:
      2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 5.9.10.5 (2016/07/22) xssCheck追加, 6.9.3.0 (2018/03/26) usePrintOut 新規追加, 6.9.9.1 (2018/08/27) useStop 属性を追加します。
    • setValue

      public void setValue(String val)
      【TAG】value 値に設定します。
      パラメータ:
      val - 設定値
      変更履歴:
      2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更, 3.0.0.0 (2002/12/25) StringUtil#changeString 廃止, 4.0.0.0 (2005/12/31) エラー発生時でも異常終了させずに処理を続けます。
      説明:
      ここで、value に設定した場合は、BODY 部は無視されます。 なお、このタグでは、エラー発生時でも継続して処理を続けられるようにします。 error.jsp などのエラー処理画面で、このタグを使用するケースがある為です。 <og:text value="あいうえお" />
    • setInclude

      public void setInclude(String file)
      【TAG】動的にファイルを include します。
      パラメータ:
      file - ファイル名
      変更履歴:
      4.0.0.0 (2007/05/25) 新規追加, 6.4.5.1 (2016/04/28) FileStringのコンストラクター変更, 6.4.5.2 (2016/05/06) fukurou.util.FileString から、fukurou.util.FileUtil に移動。
      説明:
      指定のファイル名は、自身のディレクトリからの相対パスで表されます。
    • setUsePrintOut

      public void setUsePrintOut(String flag)
      【TAG】デバッグ用に、value 値を System.out.println に 出力するかどうか[true/false]を設定します。
      パラメータ:
      flag - System.out.println に 出力するかどうか [true:する/false:しない]
      変更履歴:
      6.9.3.0 (2018/03/26) usePrintOut 新規追加
      説明:
      DOS窓に出力するので、サービス化していない場合のデバッグ用の機能です。 Tomcat内のJSPで、繰返し処理を行っているような場合、処理時間が長い場合、HTMLとしての レスポンスは、すべての処理が完了するまで戻ってこないため、進捗状況がわかりません。 そこで、DOS窓上に、System.out.printlnとして、value値を出力します。 このフラグを true にセットした場合には、debugも、useTag(タグの使用)も効果は無く、 value値も JSPには表示しません。 初期値は、(false:出力しない) です。
    • setXssCheck

      public void setXssCheck(String flag)
      【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=])。
      パラメータ:
      flag - XSSチェック [true:する/false:しない]
      関連項目:
      変更履歴:
      5.9.10.5 (2016/07/22) xssCheck
      説明:
      クロスサイトスクリプティング(XSS)対策の一環としてless/greater than signについてのチェックを行います。 (><) が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。 (初期値:システム定数のUSE_XSS_CHECK[=])。
    • setUseStop

      public void setUseStop(String flag)
      【TAG】BODYを処理後に停止するかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
      flag - 処理後停止 [true:する/それ以外:しない]
      変更履歴:
      6.9.9.1 (2018/08/27) useStop 属性を追加します。
      説明:
      true を指定すると、以下の処理は、行われません。 初期値は、停止しない ("false")
    • toString

      public String toString()
      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
      toString クラス内 CommonTagSupport
      戻り値:
      このクラスの文字列表現
      変更履歴:
      6.9.0.2 (2018/02/13) useTag 属性の値も表示に加えます。
      このメソッドは、nullを返しません