org.opengion.hayabusa.taglib

## クラス ViewAjaxTreeParamTag

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

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

      public class ViewAjaxTreeParamTag
      extends ViewParamImpl

       viewタグの viewFormType が HTMLAjaxTreeTable の場合にパラメータを設定します。

       ツリービューを表示する、ViewForm_HTMLAjaxTreeTable クラスに対して、各種パラメータを
       設定します。
       パラメータが設定されていない場合は、ViewAjaxTreeTableParam の初期値が使用されます。
       (パラメータを使用するには、viewタグのuseParam 属性をtrueに設定する必要があります。)

       ここで定義された子データを取得するためのJSPは、別に作成する必要があります。

       また、levelClmに設定されたカラムは、レベルと展開を表示するための画像イメージが表示されます。
       展開レベルに応じて階層を視覚的に表示する場合は、levelClmに設定されたカラムのレンデラーを
       定義して下さい。
       (例:LVLのコードリソースとして、1→- 2→-- 3→--- 等)

       各属性は、{@XXXX} 変数が使用できます。
       これは、ServletRequest から、XXXX をキーに値を取り出し,この変数に割り当てます。
       つまり、このXXXXをキーにリクエストすれば、この変数に値をセットすることができます。

       http://localhost/query.jsp?KEY1=VLA1&KEY2=VAL2

       のようなリクエストで、{@KEY1} とすれば、 VAL1 がセットされます。

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

         ●形式：<og:ajaxTreeParam keys="YYY,XXX,ZZZ" childJsp="getChildTag.jsp" />
         ●body：なし

         ●Tag定義：
           <og:ajaxTreeParam
               childSearchKeys    【TAG】子データを取得するためのJSPに渡す引数のカラム名をセットします(初期値:"")
               childSearchJsp     【TAG】子データを取得するためのJSPをセットします(初期値:"getChildTag.jsp")
               levelClm           【TAG】階層レベルとして処理(展開を制御するための画像イメージを表示)するカラム名をセットします(初期値:"LVL")
               imgCollapsed       【TAG】折りたたまれた状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/collapsed.gif")
               imgExpanded        【TAG】展開された状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/expanded.gif")
               imgNoSub           【TAG】展開後子データが存在しない状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/nosub.gif")
               expandAll          【TAG】初期状態で全展開を行うかを指定します(初期値:false=全展開しない)
               childViewStartNo   【TAG】子データを表示するためのStartNoを指定します(初期値:-1)
               expCtrlClm         【TAG】初期全展開した際に最下位の要素の状態(展開済 or 下位あり)を制御するためのカラムを指定します(初期値:EXPAND_CONTROL)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
             ViewFormTag の viewFormType が、HTMLAjaxTreeTable の場合に使用します。
             useParam 属性を設定しておかないと、使用されません。
             <og:view
                 viewFormType = "HTMLAjaxTreeTable"
                 command      = "{@command}"
                 startNo      = "0"
                 pageSize     = "20"
                 useParam     = "true"
             >
                 <og:ajaxTreeParam
                     childSearchkeys = "YYY,XXX,ZZZ"
                     childSearchJsp  = "getChildTag.jsp"
                     levelClm        = "LVL"
                     imgCollapsed    = "collapsed.gif"
                     imgExpanded     = "expanded.gif"
                     imgNoSub        = "nosub.gif"
                />
             </og:view >

  機能分類
    画面表示
  バージョン
    4.0
  作成者
    Hiroki Nakamura
  導入されたバージョン:
    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`

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `protected java.lang.String` | `getTagName()` タグの名称を、返します。
    `void` | `setChildSearchJsp(java.lang.String jsp)` 【TAG】子データを取得するためのJSPをセットします(初期値:"getChildTag.jsp")。
    `void` | `setChildSearchKeys(java.lang.String keys)` 【TAG】子データを取得するためのJSPに渡す引数のカラム名をセットします(初期値:"")。
    `void` | `setChildViewStartNo(java.lang.String no)` 【TAG】子データを表示するためのStartNoを指定します(初期値:-1)。
    `void` | `setExpandAll(java.lang.String flag)` 【TAG】初期状態で全展開を行うかを指定します(初期値:false=全展開しない)。
    `void` | `setExpCtrlClm(java.lang.String key)` 【TAG】初期全展開した際に最下位の要素の状態(展開済 or 下位あり)を制御するためのカラムを指定します(初期値:EXPAND_CONTROL)。
    `void` | `setImgCollapsed(java.lang.String img)` 【TAG】折りたたまれた状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/collapsed.gif")。
    `void` | `setImgExpanded(java.lang.String img)` 【TAG】展開された状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/expanded.gif")。
    `void` | `setImgNoSub(java.lang.String img)` 【TAG】展開後子データが存在しない状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/nosub.gif")。
    `void` | `setLevelClm(java.lang.String clm)` 【TAG】階層レベルとして処理(展開を制御するための画像イメージを表示)するカラム名をセットします(初期値:"LVL")。

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

      `doEndTag, initParam, putParam, release2, toString`

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

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, 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, 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`

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

    - #### ViewAjaxTreeParamTag

          public ViewAjaxTreeParamTag()

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

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### setChildSearchKeys

          public void setChildSearchKeys(java.lang.String keys)

      【TAG】子データを取得するためのJSPに渡す引数のカラム名をセットします(初期値:"")。
      パラメータ:
        `keys` - 子データ検索カラム
      説明:

             子データを取得するためのJSPに渡す引数のカラム名をセットします。
             親データから子データを展開する際に、ここで設定されたキーの値をDBTableModelから
             取得し、子データ検索用のJSPに渡します。
             子データ検索用のJSPでは通常のリクエスト変数({@カラム名})として値を取得することが可能です。

    - #### setChildSearchJsp

          public void setChildSearchJsp(java.lang.String jsp)

      【TAG】子データを取得するためのJSPをセットします(初期値:"getChildTag.jsp")。
      パラメータ:
        `jsp` - JSPファイル名
      説明:

             子データを取得するためのJSPをセットします。
             このJSPで子データを取得し、viewタグでHTML出力した結果をパースし、子データとして
             親データの直下に要素を挿入します。
             子データ検索用のJSPでは通常のリクエスト変数({@カラム名})として値を取得することが可能です。

    - #### setLevelClm

          public void setLevelClm(java.lang.String clm)

      【TAG】階層レベルとして処理(展開を制御するための画像イメージを表示)するカラム名をセットします(初期値:"LVL")。
      パラメータ:
        `clm` - レベルカラム
      説明:

             階層レベルとして処理(展開を制御するための画像イメージを表示)するカラム名をセットします。
             子データを取得した際に、ここで指定されたカラムは、親レベルに対して自動的に+1されます。

    - #### setImgCollapsed

          public void setImgCollapsed(java.lang.String img)

      【TAG】折りたたまれた状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/collapsed.gif")。
      パラメータ:
        `img` - 画像ファイル名
      説明:

             折りたたまれた状態を表現するための画像ファイル名をセットします。
             「折りたたまれた状態」とは、未展開の状態、及び展開後に折りたたんだ状態の両方を指します。

    - #### setImgExpanded

          public void setImgExpanded(java.lang.String img)

      【TAG】展開された状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/expanded.gif")。
      パラメータ:
        `img` - 画像ファイル名
      説明:

             展開された状態を表現するための画像ファイル名をセットします。

    - #### setImgNoSub

          public void setImgNoSub(java.lang.String img)

      【TAG】展開後子データが存在しない状態を表現するための画像ファイル名をセットします(初期値:"/jsp/image/nosub.gif")。
      パラメータ:
        `img` - 画像ファイル名
      説明:

             展開後子データが存在しない状態を表現するための画像ファイル名をセットします。

    - #### setExpandAll

          public void setExpandAll(java.lang.String flag)

      【TAG】初期状態で全展開を行うかを指定します(初期値:false=全展開しない)。
      パラメータ:
        `flag` - 全展開を行うか [true:行う/false:行わない]
      説明:

             初期状態で全展開を行うかを指定します。DBTableModel上のデータが展開済みのデータ
             であると仮定し、全展開を行った状態で表示します。
             ※ この属性をtrueに指定しても子データ取得用のJSPが再帰的に呼び出される訳では
                ありません。子データの取得は、予めqueryで行っておく必要があります。

      変更履歴:

        4.3.3.0 (2008/10/01) 新規作成

    - #### setChildViewStartNo

          public void setChildViewStartNo(java.lang.String no)

      【TAG】子データを表示するためのStartNoを指定します(初期値:-1)。
      パラメータ:
        `no` - 子データ表示開始番号
      説明:

             子データを取得するためのJSP内で使用します。
             子データを取得し、元のDBTableModelにマージした後、子データのみを表示するため、
             ここでstartNoを指定して差分データを表示します。

      変更履歴:

        4.3.3.0 (2008/10/01) 新規作成

    - #### setExpCtrlClm

          public void setExpCtrlClm(java.lang.String key)

      【TAG】初期全展開した際に最下位の要素の状態(展開済 or 下位あり)を制御するためのカラムを指定します(初期値:EXPAND_CONTROL)。
      パラメータ:
        `key` - 最下位展開 [0,false:展開済/1,true:未展開]
      説明:

             初期全展開した際に最下位の要素の状態(展開済 or 下位あり)を制御するためのカラムを指定します。
             ここで指定されたカラムの値により、全展開された結果の最下位の要素の状態指定することができます。
             この機能を利用することで、第3レベルまで存在するデータの内、第2レベルまでを展開しておく、
             ということを実現することができます。
             ここで指定したカラムが持つ値の意味は以下の通りです。
              '0' or 'false' 展開済 (初期値)
              '1' or 'true'  未展開 ※展開ボタンを押すことで更に下位展開が可能

             なお、この機能は、全展開時(expandAll="true")のみ有効であり、通常の第1レベル展開の場合は、
             このカラムは無視されます。

      変更履歴:

        4.3.5.0 (2008/02/01) 新規作成

    - #### getTagName

          protected java.lang.String getTagName()

      タグの名称を、返します。 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
      オーバーライド:
        `getTagName` クラス内 `CommonTagSupport`
      戻り値:
        タグの名称
      関連項目:
        `CommonTagSupport.getDocumentLink()`
      変更履歴:

        4.3.1.0 (2008/09/03) 新規追加

      このメソッドは、nullを返しません

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