org.opengion.hayabusa.taglib

## クラス ValueMapParamTag

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

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

      public class ValueMapParamTag
      extends CommonTagSupport

       ValueMapTag にパラメーターを渡す為のタグクラスです。

       valueMap タグでは、特殊な 処理を行っており、そのMapで未使用のキーワードを
       出力するために、このタグを使用します。
       valueMapParam の BODY部の文字列を、繰り返して、valueMap タグの未使用キーに適用します。
       キーワードは、XXXX 部分を、valueMap の未使用キーに変換します。
       キーワードは、YYYY 部分は、grpKeyClm を使用した場合に、置換される一連のｸﾞﾙｰﾌﾟｶﾗﾑ名を指定します。

       このタグは、ValueMapTag の内部からしか、使用できません。

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

         ●形式：
             <og:valueMapParam clsKey="CLASS_KEY" >
                  <tr><td class="LBL">{@$XXXX 1}</td><td>{@$XXXX 2}</td><td>{@$XXXX 3}</td></tr>
             </og:valueMapParam

         ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)

         ●Tag定義：
           <og:valueMapParam
               noneClassKey       【TAG】繰返し対象が無い場合に、display:none; を出力する class 属性名(初期値:null)
               restMarkClm        【TAG】繰返し対象が無い場合に、DBTableModelにマークするカラム名(初期値:null)
               restMarkVal        【TAG】繰返し対象が無い場合に、DBTableModelにマークする値(初期値:null)
               grpKeyClm          【TAG】繰返し対象が無い場合に、YYYYｷｰﾜｰﾄﾞに置換するｸﾞﾙｰﾌﾟｶﾗﾑ名を指定します(初期値:null) 6.9.9.0 (2018/08/20)
               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:valueMapParam>

         ●使用例
             <og:valueMap ･････ >
                  ･････
                 <table>
                 <og:valueMapParam noneClassKey="AddTokens"  grpKeyClm="TKN_GRP">
                       <tr><td class="LBL">{@$XXXX 1}</td><td>{@@YYYY*}</td><td>{@$XXXX 3}</td></tr>
                 </og:valueMapParam>
                 </table>
             </og:valueMap

             grpKeyClmにTKN_GRP を指定することで、同一共通ﾄｰｸﾝを横に並べる
             YYYYに、TKN_GRP が割りあたり、{@@YYYY*} に、共通ﾄｰｸﾝとﾏｯﾁする場合に、横に並ぶ。

  機能分類
    ファイル出力
  変更履歴:
    6.7.8.0 (2017/04/21) 新規作成
  バージョン
    6.7
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK8.0,

- - ### ネストされたクラスのサマリー

    ネストされたクラス
    修飾子とタイプ | クラスと説明
    --- | ---
    `static class` | `ValueMapParamTag.VMP_KEYS` ValueMapParamTag クラスのキーワードの enum

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

    - ### クラスから継承されたフィールド 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`

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doAfterBody()` Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setGrpKeyClm(java.lang.String clm)` 【TAG】繰返し対象が無い場合に、YYYYｷｰﾜｰﾄﾞに置換するｸﾞﾙｰﾌﾟｶﾗﾑ名を指定します(初期値:null)。
    `void` | `setNoneClassKey(java.lang.String clsKey)` 【TAG】繰返し対象が無い場合に、display:none; を出力する class 名を指定します(初期値:null)。
    `void` | `setRestMarkClm(java.lang.String clm)` 【TAG】繰返し対象が無い場合に、DBTableModelにマークするカラム名(初期値:null)。
    `void` | `setRestMarkVal(java.lang.String val)` 【TAG】繰返し対象が無い場合に、DBTableModelにマークする値(初期値:null)。
    `java.lang.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`

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

    - #### ValueMapParamTag

          public ValueMapParamTag()

      デフォルトコンストラクター

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

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

    - #### doAfterBody

          public int doAfterBody()

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

    - #### doEndTag

          public int doEndTag()

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

    - #### release2

          protected void release2()

      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
        `release2` クラス内 `CommonTagSupport`

    - #### setNoneClassKey

          public void setNoneClassKey(java.lang.String clsKey)

      【TAG】繰返し対象が無い場合に、display:none; を出力する class 名を指定します(初期値:null)。
      パラメータ:
        `clsKey` - display:none; を出力する class 名
      説明:
        valueMap タグで、繰返し処理が無い場合に、このclassキーに対して、display:none; を出力します。 null (未指定) の場合は、display:none; を出力しません。

    - #### setRestMarkClm

          public void setRestMarkClm(java.lang.String clm)

      【TAG】繰返し対象が無い場合に、DBTableModelにマークするカラム名(初期値:null)。
      パラメータ:
        `clm` - DBTableModelにマークするカラム名
      説明:
        valueMap タグで、繰返し処理が無い場合に、DBTableModel の指定のカラムに、 マーク(値の設定)を行うカラムIDを指定します。 例えば、クラス属性に指定しているカラムの値を書き換えれば、対象無しとして 追加されたデータに、色づけなどを行うことが出来ます。

    - #### setRestMarkVal

          public void setRestMarkVal(java.lang.String val)

      【TAG】繰返し対象が無い場合に、DBTableModelにマークする値(初期値:null)。
      パラメータ:
        `val` - DBTableModelにマークする値
      説明:
        valueMap タグで、繰返し処理が無い場合に、DBTableModel の指定のカラムに、 マーク(値の設定)を行うカラムIDに指定する値を指定します。 例えば、クラス属性に指定しているカラムの値を書き換えれば、対象無しとして 追加されたデータに、色づけなどを行うことが出来ます。

    - #### setGrpKeyClm

          public void setGrpKeyClm(java.lang.String clm)

      【TAG】繰返し対象が無い場合に、YYYYｷｰﾜｰﾄﾞに置換するｸﾞﾙｰﾌﾟｶﾗﾑ名を指定します(初期値:null)。
      パラメータ:
        `clm` - YYYYｷｰﾜｰﾄﾞに置換するｸﾞﾙｰﾌﾟｶﾗﾑ名
      説明:
        valueMap タグで、繰返し処理が無い場合に、DBTableModel の指定のカラムを 利用して、YYYYｷｰﾜｰﾄﾞと置換します。 これは、ｸﾞﾙｰﾌﾟｷｰﾜｰﾄﾞが同一のｶﾗﾑを、横持ちに順番に表示させる場合に、有効です。 初期値は、未設定なので、YYYYｷｰﾜｰﾄﾞは、置換されずに、そのまま残ります。
      変更履歴:
        6.9.9.0 (2018/08/20) YYYYｷｰﾜｰﾄﾞに置換するｸﾞﾙｰﾌﾟｶﾗﾑ名

    - #### toString

          public java.lang.String toString()

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

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