    001/*
    002 * Copyright (c) 2009 The openGion Project.
    003 *
    004 * Licensed under the Apache License, Version 2.0 (the "License");
    005 * you may not use this file except in compliance with the License.
    006 * You may obtain a copy of the License at
    007 *
    008 *     http://www.apache.org/licenses/LICENSE-2.0
    009 *
    010 * Unless required by applicable law or agreed to in writing, software
    011 * distributed under the License is distributed on an "AS IS" BASIS,
    012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
    013 * either express or implied. See the License for the specific language
    014 * governing permissions and limitations under the License.
    015 */
    016package org.opengion.hayabusa.taglib;
    017
    018import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
    019import org.opengion.fukurou.util.StringUtil;                                    // 7.0.5.0 (2019/09/09)
    020
    021// import static org.opengion.fukurou.util.StringUtil.nval;             // 7.0.5.0 (2019/09/09) static import をやめます。
    022
    023/**
    024 * 左右分割スクロール処理を行う、View を設定します。
    025 *
    026 * BODY部に記述された Viewタグに対して、左右分割情報を追記設定します。
    027 * Viewタグの左側には、このタグで指定された fixDisplay のカラムを columnDisplay に
    028 * 設定するとともに、このタグで指定された numberType をセットします。
    029 * (初期値は、numberType="sequence" です。)
    030 * Viewタグの右側には、fixDisplay のカラムを noDisplay のカラムに設定するとともに、
    031 * command="VIEW" , noMessage="true" , useSelectedRow="false" , numberType="delete"
    032 * をセットします。(既存の設定値があれば、それに追記されます。)
    033 *
    034 * @og.formSample
    035 * ●形式：&lt;og:splitView  fixDisplay="CLM,NAME_JA"&gt;&lt;og:view ・・・  /&gt;&lt;/og:splitView&gt;
    036 * ●body：あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{&#064;XXXX} は解析しません)
    037 *
    038 * ●Tag定義：
    039 *   &lt;og:splitView
    040 *       fixDisplay          【TAG】固定するカラム名を、CSV形式(CSV形式)で設定します
    041 *       useSplit            【TAG】左右分割する場合は、trueを、分割せずに、BODYのviewタグだけ使用する場合は、false をセットします。
    042 *       caseKey             【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
    043 *       caseVal             【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
    044 *       caseNN              【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない)
    045 *       caseNull            【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない)
    046 *       caseIf              【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
    047 *   &gt;   ... Body ...
    048 *   &lt;/og:splitView&gt;
    049 *
    050 * ●使用例
    051 *    &lt;og:splitView fixDisplay="CLM,NAME_JA"&gt;
    052 *      &lt;og:view
    053 *          viewFormType    = "HTMLTable"
    054 *          command         = "{&#064;command}"
    055 *          checked         = "{&#064;checked}"
    056 *          startNo         = "{&#064;startNo}"
    057 *          pageSize        = "{&#064;pageSize}"
    058 *          noWritable      = "{&#064;noWritable}"
    059 *          columnWritable  = "{&#064;columnWritable}"
    060 *      /&gt;
    061 *    &lt;/og:splitView&gt;
    062 *
    063 * @og.rev 5.3.0.0 (2010/12/01) 新規作成
    064 * @og.group 画面部品
    065 *
    066 * @version  4.0
    067 * @author       Kazuhiko Hasegawa
    068 * @since    JDK5.0,
    069 */
    070public class SplitViewTag extends CommonTagSupport {
    071        /** このプログラムのVERSION文字列を設定します。   {@value} */
    072        private static final String VERSION = "7.0.5.0 (2019/09/09)" ;
    073        private static final long serialVersionUID = 705020190909L ;
    074
    075        private static final String SPLIT_A =
    076                                  "<style type=\"text/css\">#GantBody div tr { height:22px; }</style>"                          + CR
    077                                + "<table id=\"GantBody\" border=\"0px\" cellpadding=\"0px\" cellspacing=\"0px\""       + CR
    078                                + "       frame=\"box\" rules=\"all\" style=\"margin:0px;padding:0px;\">"                       + CR
    079                                + "  <tr style=\"margin:0px;padding:0px;\">"                                                                            + CR
    080                                + "    <td valign=\"top\" style=\"margin:0px; padding:0px;\" >"                                         + CR
    081                                + "      <div id=\"X1\" style=\"overflow-x:hidden; overflow-y:hidden;\" >"                      + CR ;
    082
    083        private static final String SPLIT_B =
    084                                  "      </div>"                                                                                                        + CR
    085                                + "    </td>"                                                                                                           + CR
    086                                + "    <td valign=\"top\" style=\"margin:0px; padding:0px;\">"          + CR
    087                                + "      <div id=\"X2\" style=\"position:absolute; overflow-x:hidden; overflow-y:hidden;\" >" + CR ;
    088
    089        private static final String SPLIT_C =
    090                                  "       </div>"               + CR
    091                                + "    </td>"                   + CR
    092                                + "  </tr>"                             + CR
    093                                + "</table>"                    + CR ;
    094
    095        private String  fixDisplay              ;
    096        private boolean useSplit                = true;         // 左右分割のON/OFFﾌﾗｸﾞ
    097
    098        private boolean firstStepFlag   = true;         // BODY部の view 処理の制御
    099
    100        /**
    101         * デフォルトコンストラクター
    102         *
    103         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    104         */
    105        public SplitViewTag() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    106
    107        /**
    108         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    109         *
    110         * @og.rev 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加
    111         *
    112         * @return      後続処理の指示( EVAL_BODY_INCLUDE )
    113         */
    114        @Override
    115        public int doStartTag() {
    116                // 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加
    117                if( useTag() ) {
    118                        if( useSplit ) {
    119                                firstStepFlag = true;
    120                                // EVAL_BODY_BUFFERED ではなく、Viewなので、INCLUDE 処理します。
    121                                jspPrint( SPLIT_A );
    122                        }
    123                        return EVAL_BODY_INCLUDE ;              // Body インクルード( extends TagSupport 時)
    124                }
    125                return SKIP_BODY ;                                      // Body を評価しない
    126
    127//              firstStepFlag = true;
    128//              // EVAL_BODY_BUFFERED ではなく、Viewなので、INCLUDE 処理します。
    129//              jspPrint( SPLIT_A );
    130//              return EVAL_BODY_INCLUDE ;                                      // Body インクルード( extends TagSupport 時)
    131        }
    132
    133        /**
    134         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    135         *
    136         * @og.rev 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加
    137         *
    138         * @return      後続処理の指示(SKIP_BODY)
    139         */
    140        @Override
    141        public int doAfterBody() {
    142                // 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加
    143                if( useSplit ) {
    144                        if( firstStepFlag ) {
    145                                firstStepFlag = false;
    146
    147                                jspPrint( SPLIT_B );
    148                                // EVAL_BODY_INCLUDE なので、コンテンツの取得ではなく、処理のみ実行されます。
    149                                return EVAL_BODY_BUFFERED ;     // ボディーを再評価( extends BodyTagSupport 時)
    150                        }
    151                        else {
    152                                jspPrint( SPLIT_C );
    153                                return SKIP_BODY ;                      // Body を評価しない
    154                        }
    155                }
    156                return SKIP_BODY ;                                      // Body を評価しない
    157
    158//              if( firstStepFlag ) {
    159//                      firstStepFlag = false;
    160//
    161//                      jspPrint( SPLIT_B );
    162//                      return EVAL_BODY_BUFFERED ;     // ボディーを再評価( extends BodyTagSupport 時)
    163//              }
    164//              else {
    165//                      jspPrint( SPLIT_C );
    166//                      return SKIP_BODY ;                      // Body を評価しない
    167//              }
    168        }
    169
    170        /**
    171         * タグリブオブジェクトをリリースします。
    172         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    173         *
    174         */
    175        @Override
    176        protected void release2() {
    177                super.release2();
    178                fixDisplay = null;
    179                useSplit   = true;
    180        }
    181
    182        /**
    183         * 【TAG】固定するカラム名を、CSV形式(CSV形式)で設定します。
    184         *
    185         * @og.tag
    186         * Viewタグの左側(固定部)には、このタグで指定された fixDisplay のカラムを
    187         * columnDisplay に設定します。
    188         * Viewタグの右側には、fixDisplay のカラムを noDisplay のカラムに設定します。
    189         * 既存の設定値(noDisplay)があれば、それに追記されます。
    190         *
    191         * @og.rev 7.0.5.0 (2019/09/09) StringUtil#nvalCsv(String,String) で、CSV形式の文字列を正規化します。
    192         *
    193         * @param   clms 固定するカラム名(CSV形式)
    194         */
    195        public void setFixDisplay( final String clms ) {
    196//              fixDisplay = nval( getRequestParameter( clms ),fixDisplay );
    197                fixDisplay = StringUtil.nvalCsv( getRequestParameter( clms ),fixDisplay );              // 7.0.5.0 (2019/09/09)
    198        }
    199
    200        /**
    201         * 固定するカラム名を、CSV形式(CSV形式)で取得します。
    202         *
    203         * これは、BODY部に記述された、viewタグからアクセスされるメソッドです。
    204         * 設定されていない場合は、null です。
    205         *
    206         * @return      固定するカラム名(CSV形式)
    207         */
    208        protected String getFixDisplay() {
    209                return fixDisplay ;
    210        }
    211
    212        /**
    213         * 【TAG】左右分割機能の ON/OFF を設定します(初期値=true:左右分割を使用する)。
    214         *
    215         * @og.tag
    216         * 左右分割する場合は、trueを、分割せずに、BODYのviewタグだけ使用する場合は、false をセットします。
    217         * BODYも含めての使用を制御する場合は、case属性(caseKey , caseVal , caseNN , caseNull , caseIf)を、
    218         * 使用してください。
    219         * 初期値は、true:左右分割を使用する です。
    220         *
    221         * @og.rev 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加
    222         * @og.rev 7.0.5.0 (2019/09/09) static import をやめます。
    223         *
    224         * @param   flag 左右分割機能の ON/OFF [true:左右分割/false:BODYのみ表示]
    225         */
    226        public void setUseSplit( final String flag ) {
    227//              useSplit = nval( getRequestParameter( flag ),useSplit );
    228                useSplit = StringUtil.nval( getRequestParameter( flag ),useSplit );             // 7.0.5.0 (2019/09/09) static import をやめます。
    229        }
    230
    231        /**
    232         * 左右分割機能の ON/OFF を取得します。
    233         *
    234         * 左右分割する場合は、trueを、分割せずに、BODYのviewタグだけ使用する場合は、false がセットされています。
    235         * これは、BODY部に記述された、viewタグからアクセスされるメソッドです。
    236         * falseの場合は、viewタグで、左右分割処理を行わないようにします。
    237         *
    238         * @og.rev 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするﾌﾗｸﾞを追加
    239         *
    240         * @return      左右分割機能の ON/OFF[true:左右分割/false:BODYのみ表示]
    241         */
    242        protected boolean isUseSplit() {
    243                return useSplit ;
    244        }
    245
    246        /**
    247         * BODY部の view 処理の制御を行うためのフラグを返します。
    248         *
    249         * 左右分割を行うには、Viewタグを２回出力する必要があります。
    250         * ここでは isFirstStep="true" が１回目(左側:固定部)で、false が
    251         * 右側(可変部)になるように、View側で制御します。
    252         *
    253         * @return      BODY部の view 処理の制御(true:１回目 / false:２回目)
    254         */
    255        protected boolean isFirstStep() {
    256                return firstStepFlag ;
    257        }
    258
    259        /**
    260         * このオブジェクトの文字列表現を返します。
    261         * 基本的にデバッグ目的に使用します。
    262         *
    263         * @return このクラスの文字列表現
    264         * @og.rtnNotNull
    265         */
    266        @Override
    267        public String toString() {
    268                return ToString.title( this.getClass().getName() )
    269                                .println( "VERSION"                     ,VERSION        )
    270                                .println( "fixDisplay"          ,fixDisplay     )
    271                                .println( "Other..."    ,getAttributes().getAttribute() )
    272                                .fixForm().toString() ;
    273        }
    274}