org.opengion.hayabusa.taglib

## クラス SplitViewTag

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

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

      public class SplitViewTag
      extends CommonTagSupport

       左右分割スクロール処理を行う、View を設定します。

       BODY部に記述された Viewタグに対して、左右分割情報を追記設定します。
       Viewタグの左側には、このタグで指定された fixDisplay のカラムを columnDisplay に
       設定するとともに、このタグで指定された numberType をセットします。
       (初期値は、numberType="sequence" です。)
       Viewタグの右側には、fixDisplay のカラムを noDisplay のカラムに設定するとともに、
       command="VIEW" , noMessage="true" , useSelectedRow="false" , numberType="delete"
       をセットします。(既存の設定値があれば、それに追記されます。)

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

         ●形式：<og:splitView  fixDisplay="CLM,NAME_JA"><og:view ・・・  /></og:splitView>
         ●body：あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{@XXXX} は解析しません)

         ●Tag定義：
           <og:splitView
               fixDisplay          【TAG】固定するカラム名を、CSV形式(CSV形式)で設定します
               useSplit            【TAG】左右分割する場合は、trueを、分割せずに、BODYのviewタグだけ使用する場合は、false をセットします。
               caseKey             【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
               caseVal             【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
               caseNN              【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない)
               caseNull            【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない)
               caseIf              【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
           >   ... Body ...
           </og:splitView>

         ●使用例
            <og:splitView fixDisplay="CLM,NAME_JA">
              <og:view
                  viewFormType    = "HTMLTable"
                  command         = "{@command}"
                  checked         = "{@checked}"
                  startNo         = "{@startNo}"
                  pageSize        = "{@pageSize}"
                  noWritable      = "{@noWritable}"
                  columnWritable  = "{@columnWritable}"
              />
            </og:splitView>

  機能分類
    画面部品
  変更履歴:
    5.3.0.0 (2010/12/01) 新規作成
  バージョン
    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`

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doAfterBody()` Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected java.lang.String` | `getFixDisplay()` 固定するカラム名を、CSV形式(CSV形式)で取得します。
    `protected boolean` | `isFirstStep()` BODY部の view 処理の制御を行うためのフラグを返します。
    `protected boolean` | `isUseSplit()` 左右分割機能の ON/OFF を取得します。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setFixDisplay(java.lang.String clms)` 【TAG】固定するカラム名を、CSV形式(CSV形式)で設定します。
    `void` | `setUseSplit(java.lang.String flag)` 【TAG】左右分割機能の ON/OFF を設定します(初期値=true:左右分割を使用する)。
    `java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。

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

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

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

    - #### SplitViewTag

          public SplitViewTag()

      デフォルトコンストラクター
      変更履歴:
        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_INCLUDE )
      変更履歴:
        6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加

    - #### doAfterBody

          public int doAfterBody()

      Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
      定義:
        `doAfterBody` インタフェース内 `IterationTag`
      オーバーライド:
        `doAfterBody` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示(SKIP_BODY)
      変更履歴:
        6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加

    - #### release2

          protected void release2()

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

    - #### setFixDisplay

          public void setFixDisplay(java.lang.String clms)

      【TAG】固定するカラム名を、CSV形式(CSV形式)で設定します。
      パラメータ:
        `clms` - 固定するカラム名(CSV形式)
      説明:
        Viewタグの左側(固定部)には、このタグで指定された fixDisplay のカラムを columnDisplay に設定します。 Viewタグの右側には、fixDisplay のカラムを noDisplay のカラムに設定します。 既存の設定値(noDisplay)があれば、それに追記されます。
      変更履歴:
        7.0.5.0 (2019/09/09) StringUtil#nvalCsv(String,String) で、CSV形式の文字列を正規化します。

    - #### getFixDisplay

          protected java.lang.String getFixDisplay()

      固定するカラム名を、CSV形式(CSV形式)で取得します。 これは、BODY部に記述された、viewタグからアクセスされるメソッドです。 設定されていない場合は、null です。
      戻り値:
        固定するカラム名(CSV形式)

    - #### setUseSplit

          public void setUseSplit(java.lang.String flag)

      【TAG】左右分割機能の ON/OFF を設定します(初期値=true:左右分割を使用する)。
      パラメータ:
        `flag` - 左右分割機能の ON/OFF [true:左右分割/false:BODYのみ表示]
      説明:
        左右分割する場合は、trueを、分割せずに、BODYのviewタグだけ使用する場合は、false をセットします。 BODYも含めての使用を制御する場合は、case属性(caseKey , caseVal , caseNN , caseNull , caseIf)を、 使用してください。 初期値は、true:左右分割を使用する です。
      変更履歴:
        6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加, 7.0.5.0 (2019/09/09) static import をやめます。

    - #### isUseSplit

          protected boolean isUseSplit()

      左右分割機能の ON/OFF を取得します。 左右分割する場合は、trueを、分割せずに、BODYのviewタグだけ使用する場合は、false がセットされています。 これは、BODY部に記述された、viewタグからアクセスされるメソッドです。 falseの場合は、viewタグで、左右分割処理を行わないようにします。
      戻り値:
        左右分割機能の ON/OFF[true:左右分割/false:BODYのみ表示]
      変更履歴:
        6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加

    - #### isFirstStep

          protected boolean isFirstStep()

      BODY部の view 処理の制御を行うためのフラグを返します。 左右分割を行うには、Viewタグを２回出力する必要があります。 ここでは isFirstStep="true" が１回目(左側:固定部)で、false が 右側(可変部)になるように、View側で制御します。
      戻り値:
        BODY部の view 処理の制御(true:１回目 / false:２回目)

    - #### toString

          public java.lang.String toString()

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

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