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 * ●形式:<og:splitView fixDisplay="CLM,NAME_JA"><og:view ・・・ /></og:splitView> 036 * ●body:あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{@XXXX} は解析しません) 037 * 038 * ●Tag定義: 039 * <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 * > ... Body ... 048 * </og:splitView> 049 * 050 * ●使用例 051 * <og:splitView fixDisplay="CLM,NAME_JA"> 052 * <og:view 053 * viewFormType = "HTMLTable" 054 * command = "{@command}" 055 * checked = "{@checked}" 056 * startNo = "{@startNo}" 057 * pageSize = "{@pageSize}" 058 * noWritable = "{@noWritable}" 059 * columnWritable = "{@columnWritable}" 060 * /> 061 * </og:splitView> 062 * 063 * @og.rev 5.3.0.0 (2010/12/01) 新規作成 064 * @og.rev 8.2.0.2 (2022/06/24) HTML5廃止対応 065 * @og.group 画面部品 066 * 067 * @version 4.0 068 * @author Kazuhiko Hasegawa 069 * @since JDK5.0, 070 */ 071public class SplitViewTag extends CommonTagSupport { 072 /** このプログラムのVERSION文字列を設定します。 {@value} */ 073 private static final String VERSION = "8.4.1.2 (2023/03/03)" ; 074 private static final long serialVersionUID = 841220230303L ; 075 076 private static final String SPLIT_A = 077 // 8.1.0.0 (2021/12/28) HTML5 準拠に見直し(type="text/css" 不要) 078// "<style type=\"text/css\">#GantBody div tr { height:22px; }</style>" + CR 079 // 8.2.0.2 (2022/06/24) Modify 080// + "<table id=\"GantBody\" border=\"0px\" cellpadding=\"0px\" cellspacing=\"0px\"" + CR 081// + " frame=\"box\" rules=\"all\" style=\"margin:0px;padding:0px;\">" + CR 082// + " <tr style=\"margin:0px;padding:0px;\">" + CR 083// + " <td valign=\"top\" style=\"margin:0px; padding:0px;\" >" + CR 084// + " <div id=\"X1\" style=\"overflow-x:hidden; overflow-y:hidden;\" >" + CR ; 085 "<style>#GantBody div tr { height:22px; }</style>" + CR 086// + "<table id=\"GantBody\" border=\"0px\" >" + CR 087 + "<table id=\"GantBody\" border=\"0px\" style=\"clear:both;\">" + CR // 8.4.1.2 (2023/03/03) 088 + " <tr>" + CR 089 + " <td class=\"GantTd\" >" + CR 090 + " <div id=\"X1\" >" + CR ; 091 092 private static final String SPLIT_B = 093 " </div>" + CR 094 + " </td>" + CR 095 // 8.2.0.2 (2022/06/24) Modify 096// + " <td valign=\"top\" style=\"margin:0px; padding:0px;\">" + CR 097// + " <div id=\"X2\" style=\"position:absolute; overflow-x:hidden; overflow-y:hidden;\" >" + CR ; 098 + " <td class=\"GantTd\" >" + CR 099 + " <div id=\"X2\" >" + CR ; 100 101 private static final String SPLIT_C = 102 " </div>" + CR 103 + " </td>" + CR 104 + " </tr>" + CR 105 + "</table>" + CR ; 106 107 private String fixDisplay ; 108 private boolean useSplit = true; // 左右分割のON/OFFフラグ 109 110 private boolean firstStepFlag = true; // BODY部の view 処理の制御 111 112 /** 113 * デフォルトコンストラクター 114 * 115 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 116 */ 117 public SplitViewTag() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 118 119 /** 120 * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。 121 * 122 * @og.rev 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするフラグを追加 123 * 124 * @return 後続処理の指示( EVAL_BODY_INCLUDE ) 125 */ 126 @Override 127 public int doStartTag() { 128 // 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするフラグを追加 129 if( useTag() ) { 130 if( useSplit ) { 131 firstStepFlag = true; 132 // EVAL_BODY_BUFFERED ではなく、Viewなので、INCLUDE 処理します。 133 jspPrint( SPLIT_A ); 134 } 135 return EVAL_BODY_INCLUDE ; // Body インクルード( extends TagSupport 時) 136 } 137 return SKIP_BODY ; // Body を評価しない 138 139// firstStepFlag = true; 140// // EVAL_BODY_BUFFERED ではなく、Viewなので、INCLUDE 処理します。 141// jspPrint( SPLIT_A ); 142// return EVAL_BODY_INCLUDE ; // Body インクルード( extends TagSupport 時) 143 } 144 145 /** 146 * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。 147 * 148 * @og.rev 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするフラグを追加 149 * 150 * @return 後続処理の指示(SKIP_BODY) 151 */ 152 @Override 153 public int doAfterBody() { 154 // 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするフラグを追加 155 if( useSplit ) { 156 if( firstStepFlag ) { 157 firstStepFlag = false; 158 159 jspPrint( SPLIT_B ); 160 // EVAL_BODY_INCLUDE なので、コンテンツの取得ではなく、処理のみ実行されます。 161 return EVAL_BODY_BUFFERED ; // ボディーを再評価( extends BodyTagSupport 時) 162 } 163 else { 164 jspPrint( SPLIT_C ); 165 return SKIP_BODY ; // Body を評価しない 166 } 167 } 168 return SKIP_BODY ; // Body を評価しない 169 170// if( firstStepFlag ) { 171// firstStepFlag = false; 172// 173// jspPrint( SPLIT_B ); 174// return EVAL_BODY_BUFFERED ; // ボディーを再評価( extends BodyTagSupport 時) 175// } 176// else { 177// jspPrint( SPLIT_C ); 178// return SKIP_BODY ; // Body を評価しない 179// } 180 } 181 182 /** 183 * タグリブオブジェクトをリリースします。 184 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 185 * 186 */ 187 @Override 188 protected void release2() { 189 super.release2(); 190 fixDisplay = null; 191 useSplit = true; 192 } 193 194 /** 195 * 【TAG】固定するカラム名を、CSV形式(CSV形式)で設定します。 196 * 197 * @og.tag 198 * Viewタグの左側(固定部)には、このタグで指定された fixDisplay のカラムを 199 * columnDisplay に設定します。 200 * Viewタグの右側には、fixDisplay のカラムを noDisplay のカラムに設定します。 201 * 既存の設定値(noDisplay)があれば、それに追記されます。 202 * 203 * @og.rev 7.0.5.0 (2019/09/09) StringUtil#nvalCsv(String,String) で、CSV形式の文字列を正規化します。 204 * 205 * @param clms 固定するカラム名(CSV形式) 206 */ 207 public void setFixDisplay( final String clms ) { 208// fixDisplay = nval( getRequestParameter( clms ),fixDisplay ); 209 fixDisplay = StringUtil.nvalCsv( getRequestParameter( clms ),fixDisplay ); // 7.0.5.0 (2019/09/09) 210 } 211 212 /** 213 * 固定するカラム名を、CSV形式(CSV形式)で取得します。 214 * 215 * これは、BODY部に記述された、viewタグからアクセスされるメソッドです。 216 * 設定されていない場合は、null です。 217 * 218 * @return 固定するカラム名(CSV形式) 219 */ 220 protected String getFixDisplay() { 221 return fixDisplay ; 222 } 223 224 /** 225 * 【TAG】左右分割機能の ON/OFF を設定します(初期値=true:左右分割を使用する)。 226 * 227 * @og.tag 228 * 左右分割する場合は、trueを、分割せずに、BODYのviewタグだけ使用する場合は、false をセットします。 229 * BODYも含めての使用を制御する場合は、case属性(caseKey , caseVal , caseNN , caseNull , caseIf)を、 230 * 使用してください。 231 * 初期値は、true:左右分割を使用する です。 232 * 233 * @og.rev 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするフラグを追加 234 * @og.rev 7.0.5.0 (2019/09/09) static import をやめます。 235 * 236 * @param flag 左右分割機能の ON/OFF [true:左右分割/false:BODYのみ表示] 237 */ 238 public void setUseSplit( final String flag ) { 239// useSplit = nval( getRequestParameter( flag ),useSplit ); 240 useSplit = StringUtil.nval( getRequestParameter( flag ),useSplit ); // 7.0.5.0 (2019/09/09) static import をやめます。 241 } 242 243 /** 244 * 左右分割機能の ON/OFF を取得します。 245 * 246 * 左右分割する場合は、trueを、分割せずに、BODYのviewタグだけ使用する場合は、false がセットされています。 247 * これは、BODY部に記述された、viewタグからアクセスされるメソッドです。 248 * falseの場合は、viewタグで、左右分割処理を行わないようにします。 249 * 250 * @og.rev 6.9.5.0 (2018/04/23) 左右分割に、使用をON/OFFするフラグを追加 251 * 252 * @return 左右分割機能の ON/OFF[true:左右分割/false:BODYのみ表示] 253 */ 254 protected boolean isUseSplit() { 255 return useSplit ; 256 } 257 258 /** 259 * BODY部の view 処理の制御を行うためのフラグを返します。 260 * 261 * 左右分割を行うには、Viewタグを2回出力する必要があります。 262 * ここでは isFirstStep="true" が1回目(左側:固定部)で、false が 263 * 右側(可変部)になるように、View側で制御します。 264 * 265 * @return BODY部の view 処理の制御(true:1回目 / false:2回目) 266 */ 267 protected boolean isFirstStep() { 268 return firstStepFlag ; 269 } 270 271 /** 272 * このオブジェクトの文字列表現を返します。 273 * 基本的にデバッグ目的に使用します。 274 * 275 * @return このクラスの文字列表現 276 * @og.rtnNotNull 277 */ 278 @Override 279 public String toString() { 280 return ToString.title( this.getClass().getName() ) 281 .println( "VERSION" ,VERSION ) 282 .println( "fixDisplay" ,fixDisplay ) 283 .println( "Other..." ,getAttributes().getAttribute() ) 284 .fixForm().toString() ; 285 } 286}