org.opengion.hayabusa.taglib

## クラス MessageTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.opengion.hayabusa.taglib.CommonTagSupport
      - - org.opengion.hayabusa.taglib.MessageTag

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

      public class MessageTag
      extends CommonTagSupport

       画面にラベルリソース等のメッセージを表示させるタグです。

       lbl 属性に ラベルリソース のキーを与えることで、 ロケールにあわせたリソースを使用して、
       画面に表示します。
       違う値をセットした場合は、 セットした値が、そのまま出力されます。これは、ロケールが
       見つからなかった場合の標準の対応方法です。
       ロケールは、ユーザー情報の lang 属性を初期値で使用し、 セットされていない場合は、
       リクエスト情報のロケールから取得します。
       lbl 属性を使用する場合、val0 ～ val9 までの引数を使用することができます。これは、
       メッセージフォーマットの、引数 {0} ～ {9} に対応して割り付けられます。

  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:message lbl="…" val0=[…] … />
         ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)

         ●Tag定義：
           <og:message
               lbl                【TAG】ラベルリソースのラベルIDを指定します
               language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
               command            【TAG】コマンド (INSERT,COPY,MODIFY,DELETE)をセットします
               comment            【TAG】コメントを指定します
               type               【TAG】タイプを(Label,Short,Tips,Description)から指定します(初期値:Label)
               val0               【TAG】メッセージの引数{0}を指定します
               val1               【TAG】メッセージの引数{1}を指定します
               val2               【TAG】メッセージの引数{2}を指定します
               val3               【TAG】メッセージの引数{3}を指定します
               val4               【TAG】メッセージの引数{4}を指定します
               val5               【TAG】メッセージの引数{5}を指定します
               val6               【TAG】メッセージの引数{6}を指定します
               val7               【TAG】メッセージの引数{7}を指定します
               val8               【TAG】メッセージの引数{8}を指定します
               val9               【TAG】メッセージの引数{9}を指定します
               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:message>

         ●使用例
             <og:message lbl="MSG0032" language="ja" />

                lbl       : MessageResource.properties のキー
                language  : ロケール(オプション)

             例１)
                 <og:message lbl="MSG0032" >検索条件</og:message>

                BODY 部分は、無視されます。コメント等に使用できます。
                HTMLファイルには、コメント部分は出力されません。

  機能分類
    画面部品
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドのサマリー

    - ### クラスから継承されたフィールド org.opengion.hayabusa.taglib.CommonTagSupport

      `BR, BUFFER_MIDDLE, CR`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.BodyTagSupport

      `bodyContent`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.TagSupport

      `id, pageContext`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.BodyTag

      `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.IterationTag

      `EVAL_BODY_AGAIN`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.Tag

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `MessageTag()` デフォルトコンストラクター

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doAfterBody()` Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setCommand(String cmd)` 【TAG】コマンド (INSERT,COPY,MODIFY,DELETE)をセットします。
    `void` | `setComment(String cmnt)` 【TAG】コメントを指定します。
    `void` | `setType(String tp)` 【TAG】タイプ[Label/Short/Tips/Description]を指定します(初期値:Label)。
    `void` | `setVal0(String value)` 【TAG】メッセージの引数{0}を指定します。
    `void` | `setVal1(String value)` 【TAG】メッセージの引数{1}を指定します。
    `void` | `setVal2(String value)` 【TAG】メッセージの引数{2}を指定します。
    `void` | `setVal3(String value)` 【TAG】メッセージの引数{3}を指定します。
    `void` | `setVal4(String value)` 【TAG】メッセージの引数{4}を指定します。
    `void` | `setVal5(String value)` 【TAG】メッセージの引数{5}を指定します。
    `void` | `setVal6(String value)` 【TAG】メッセージの引数{6}を指定します。
    `void` | `setVal7(String value)` 【TAG】メッセージの引数{7}を指定します。
    `void` | `setVal8(String value)` 【TAG】メッセージの引数{8}を指定します。
    `void` | `setVal9(String value)` 【TAG】メッセージの引数{9}を指定します。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

    - ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.CommonTagSupport

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, getTagName, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.BodyTagSupport

      `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.TagSupport

      `findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

    - ### クラスから継承されたメソッド java.lang.Object

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

    - ### インタフェースから継承されたメソッド javax.servlet.jsp.tagext.Tag

      `getParent, setPageContext, setParent`

- - ### コンストラクタの詳細

    - #### MessageTag

          public MessageTag()

      デフォルトコンストラクター
      変更履歴:

        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 )
      変更履歴:

        5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応

    - #### doAfterBody

          public int doAfterBody()

      Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
      定義:
        `doAfterBody` インタフェース内 `IterationTag`
      オーバーライド:
        `doAfterBody` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示(SKIP_BODY)
      変更履歴:

        3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。

    - #### doEndTag

          public int doEndTag()

      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
        `doEndTag` インタフェース内 `Tag`
      オーバーライド:
        `doEndTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:

        3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
        5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応

    - #### 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()で呼ぶ。

    - #### setComment

          public void setComment(String cmnt)

      【TAG】コメントを指定します。
      パラメータ:
        `cmnt` - コメント文字列
      説明:

             msg 属性でメッセージリソースから読み取りますが,開発途中で
             リソース登録を済ましていない状態でコメントを入れる場合に、
             直接コメントをかけるようにします。

      変更履歴:

        2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
        3.0.0.0 (2002/12/25) StringUtil#changeString 廃止

    - #### setType

          public void setType(String tp)

      【TAG】タイプ[Label/Short/Tips/Description]を指定します(初期値:Label)。
      パラメータ:
        `tp` - タイプ文字列 [Label/Short/Tips/Description]
      説明:

             タイプは、ラベル／メッセージリソースのどの情報を取得したいかを指定できます。
             従来のラベル／メッセージは、Label に相当します。
             なお、指定は、それぞれの頭文字('L','S','T','D')のみでも可能です。
             初期値は、"Label" です。
             ・Label  : ラベル／メッセージ表示
             ・Short  : 表形式で使用する短いラベル表示
             ・Tips   : ラベルの上にTips表示
             ・Description : 概要説明を表示

      変更履歴:

        4.0.0.0 (2005/01/31) 新規登録

    - #### setVal0

          public void setVal0(String value)

      【TAG】メッセージの引数{0}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal1

          public void setVal1(String value)

      【TAG】メッセージの引数{1}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal2

          public void setVal2(String value)

      【TAG】メッセージの引数{2}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal3

          public void setVal3(String value)

      【TAG】メッセージの引数{3}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal4

          public void setVal4(String value)

      【TAG】メッセージの引数{4}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal5

          public void setVal5(String value)

      【TAG】メッセージの引数{5}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal6

          public void setVal6(String value)

      【TAG】メッセージの引数{6}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal7

          public void setVal7(String value)

      【TAG】メッセージの引数{7}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal8

          public void setVal8(String value)

      【TAG】メッセージの引数{8}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数を指定します。

    - #### setVal9

          public void setVal9(String value)

      【TAG】メッセージの引数{9}を指定します。
      パラメータ:
        `value` - メッセージの引数
      説明:

             メッセージの引数{9}を指定します。

    - #### setCommand

          public void setCommand(String cmd)

      【TAG】コマンド (INSERT,COPY,MODIFY,DELETE)をセットします。
      パラメータ:
        `cmd` - コマンド (public static final 宣言されている文字列)
      説明:

             コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される
             フィールド定数値のいづれかを、指定できます。
             コマンド (INSERT,COPY,MODIFY,DELETE)に対応したメッセージを表示します。
             INSERT : MSG0044  追加処理を行います。
             COPY   : MSG0045  複写処理を行います。
             MODIFY : MSG0046  変更処理を行います。
             DELETE : MSG0047  削除処理を行います。

             なお、command によるメッセージの自動選択は、lbl ともにセットされていない
             場合にのみ有効になります。

      変更履歴:

        4.0.0.0 (2006/11/31) 新規登録

    - #### toString

          public String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `CommonTagSupport`
      戻り値:
        このクラスの文字列表現
      このメソッドは、nullを返しません

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.