org.opengion.hayabusa.taglib

## クラス TabListTag

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

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

      public class TabListTag
      extends CommonTagSupport

       タブ形式のリンクを表示する場合に、タブそのものを表示するタグです。

       tabLinkタグを親タグとし、listType="TAG"を指定した場合に、このタグを使用して
       タブを個別に定義します。

       タグの使用方法については、tabLinkタグのドキュメントを参照して下さい。

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

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

         ●形式：<og:tabLink href="…" > <og:tabList name="TAB1" … /> … </og:tabLink >
         ●body：なし

         ●Tag定義：
           <og:tabList
               name             ○【TAG】要素に対して固有の名前をつけます(必須)。
               lbl                【TAG】ラベルリソースのラベルIDを指定します
               href               【TAG】リンク先のJSPを指定します(初期値:result.jsp)
               term               【TAG】処理する条件を指定します(初期値:null)
               termList           【TAG】処理する条件を含むような文字列を指定します
               delTerm            【TAG】処理しないタブを選択する条件を指定します(初期値:null)
               delTermList        【TAG】処理しない条件を含むような文字列を指定します
               unselClass         【TAG】非選択タブのクラスを指定します(初期値:unselTab)
               keys               【TAG】リンク先のJSPに引数として渡すキーをCSV形式で指定します
               vals               【TAG】リンク先のJSPに引数として渡す値をCSV形式で指定します
               roles              【TAG】ロールをセットします
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
           tabListタグからタブリストを生成する場合
              <og:tabLink
                  listType        = "DB"                      タブの一覧をどこから取得するか
                  href            = "result.jsp"              リンク先のJSP
                  target          = "RESULT"                  リンクターゲット
                  openTab         = "[true/false]"            タブ表示後にタブを自動で開く
                  openTabName     = "{@PN}               自動で開くタブの名前
                  constKeys       = "KEY1"                    次画面に固定で渡すキー一覧
                  constVals       = "{@VAL1}"            次画面に固定で渡す値一覧
                  listCount       = "10"                      1行辺りに表示するタブの数
                  selClass        = "selTab"                  選択タブのクラス
                  unselClass      = "unselTab"                非選択タブのクラス
                  width           = "100px"                   タブリンクの幅
                  height          = "50px"                    タブリンクの高さ
               >
                  <og:tabList name="TAB1" href="result1.jsp" keys="PN,CDK" vals="ABC,V" />
                  <og:tabList name="TAB2" href="result2.jsp" keys="PN,CDK" vals="BCD,W" />
                  <og:tabList name="TAB3" href="result3.jsp" keys="PN,CDK" vals="CDE,X" />
              </og:tabLink>

  機能分類
    画面表示
  バージョン
    4.3.5.0 (2008/02/01)
  作成者
    Nakamura
  導入されたバージョン:
    JDK1.4,

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

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

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setDelTerm(String str)` 【TAG】処理しないタブを選択する条件を指定します(初期値:null)。
    `void` | `setDelTermList(String list)` 【TAG】処理しない条件を含むような文字列を指定します。
    `void` | `setHref(String hr)` 【TAG】リンク先のJSPを指定します(初期値:result.jsp)。
    `void` | `setKeys(String key)` 【TAG】リンク先のJSPに引数として渡すキーをCSV形式で指定します。
    `void` | `setName(String nm)` 【TAG】要素に対して固有の名前をつけます。
    `void` | `setRoles(String roles)` 【TAG】ロールをセットします。
    `void` | `setTerm(String str)` 【TAG】処理する条件を指定します(初期値:null)。
    `void` | `setTermList(String list)` 【TAG】処理する条件を含むような文字列を指定します。
    `void` | `setUnselClass(String cls)` 【TAG】非選択タブのクラスを指定します(初期値:unselTab)。
    `void` | `setVals(String val)` 【TAG】リンク先のJSPに引数として渡す値をCSV形式で指定します。
    `String` | `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, 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`

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

    - #### TabListTag

          public TabListTag()

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

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

  - ### メソッドの詳細

    - #### doEndTag

          public int doEndTag()

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

        6.3.9.0 (2015/11/06) TabLinkTagの取得タイミングを、#doEndTag() に移す。

    - #### release2

          protected void release2()

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

        6.3.9.0 (2015/11/06) TabLinkTagの取得タイミングを、#doEndTag() に移す。

    - #### setName

          public void setName(String nm)

      【TAG】要素に対して固有の名前をつけます。
      パラメータ:
        `nm` - タブ名
      説明:

             要素に対して固有の名前をつけます。
             ここで設定された名称は、自動でタブを表示するためのopenTabName属性判定にも使用されます。

    - #### setHref

          public void setHref(String hr)

      【TAG】リンク先のJSPを指定します(初期値:result.jsp)。
      パラメータ:
        `hr` - リンク先のJSP
      説明:

             リンク先のJSPを指定します。
             ここで指定しない場合は、tagLinkタグの値が適用されます。

    - #### setTerm

          public void setTerm(String str)

      【TAG】処理する条件を指定します(初期値:null)。
      パラメータ:
        `str` - 処理する条件文字列
      説明:

             termListで与えられた文字列に、term文字列(大文字/小文字の区別あり)が
             含まれていれば、OPEN選択タブとして処理します。
             OPEN選択タブでないタブは、初期値OPENにならないだけで、タブそのものは表示されます。
             OPEN選択とDELETE選択が競合した場合は、DELETE選択が優先されます。
             初期値は、 null です。

    - #### setTermList

          public void setTermList(String list)

      【TAG】処理する条件を含むような文字列を指定します。
      パラメータ:
        `list` - 処理する条件 (indexOf による含む/含まない判定)
      説明:

             termListで与えられた文字列に、term文字列(大文字/小文字の区別あり)が
             含まれていれば、OPEN選択タブとして処理します。
             例えば、"A","B","C" という文字列が、term で指定された
             場合に処理するようにしたい場合は、"A|B|C" をセットします。
             初期値は、 null です。
             判定は、文字列を含むかどうかなので、１文字のみの場合は、"|"区切りにする
             必要はありません。
             OPEN選択とDELETE選択が競合した場合は、DELETE選択が優先されます。

    - #### setDelTerm

          public void setDelTerm(String str)

      【TAG】処理しないタブを選択する条件を指定します(初期値:null)。
      パラメータ:
        `str` - 非表示タブ
      説明:

             delTermListで与えられた文字列に、delTerm文字列(大文字/小文字の区別あり)が
             含まれていれば、DELETE選択タブとして処理します。
             DELETE選択タブは、タブそのものが表示されません。
             ただし、タブのselectIndex は、DELETEされたタブも含めて、カウントされますので、
             JSPでの設定時の順番がインデックス番号になります。
             OPEN選択とDELETE選択が競合した場合は、DELETE選択が優先されます。
             初期値は、 null です。

    - #### setDelTermList

          public void setDelTermList(String list)

      【TAG】処理しない条件を含むような文字列を指定します。
      パラメータ:
        `list` - 非表示タブ条件 (indexOf による含む/含まない判定)
      説明:

             delTermListで与えられた文字列に、delTerm文字列(大文字/小文字の区別あり)が
             含まれていれば、DELETE選択タブとして処理します。
             例えば、"A","B","C" という文字列が、delTerm で指定された
             場合に処理しないようにしたい場合は、"A|B|C" をセットします。
             初期値は、 null です。
             判定は、文字列を含むかどうかなので、１文字のみの場合は、"|"区切りにする
             必要はありません。
             OPEN選択とDELETE選択が競合した場合は、DELETE選択が優先されます。

    - #### setUnselClass

          public void setUnselClass(String cls)

      【TAG】非選択タブのクラスを指定します(初期値:unselTab)。
      パラメータ:
        `cls` - 選択タブのクラス名
      説明:

             タブが選択されていない状態にある場合の、タブ部分のクラス名を指定します。
             このクラス名を変更する場合は、そのクラスをcustom/custom.css等で再定義して下さい。
             tabListタグで指定された値は、tabLinkタグで指定されたものより優先されます。
             初期値は、unselTabです。

    - #### setKeys

          public void setKeys(String key)

      【TAG】リンク先のJSPに引数として渡すキーをCSV形式で指定します。
      パラメータ:
        `key` - キー(CSV形式)
      説明:

             リンク先のJSPに引数として渡すキーをCSV形式で指定します。

    - #### setVals

          public void setVals(String val)

      【TAG】リンク先のJSPに引数として渡す値をCSV形式で指定します。
      パラメータ:
        `val` - 値(CSV形式)
      説明:

             リンク先のJSPに引数として渡す値をCSV形式で指定します。

    - #### setRoles

          public void setRoles(String roles)

      【TAG】ロールをセットします。
      パラメータ:
        `roles` - パラメータ
      説明:

             ここで指定したカラムロールを元に、ユーザー毎のアクセス許可がチェックされます。
             アクセス許可されないと、表示されません。
             このロールを指定しない場合は、カラムリソースのロールが使用されます。

    - #### toString

          public String toString()

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

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