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.hayabusa.common.HybsSystem; 019import org.opengion.hayabusa.common.HybsSystemException; 020import org.opengion.hayabusa.db.DBTableModel; 021import org.opengion.hayabusa.resource.GUIInfo; 022import org.opengion.fukurou.util.XHTMLTag; 023import org.opengion.fukurou.util.StringUtil; 024import org.opengion.fukurou.util.ToString; // 6.1.1.0 (2015/01/17) 025 026import static org.opengion.fukurou.util.StringUtil.nval ; 027 028/** 029 * フレームを作成するHTML拡張タグで、引数の受け渡しが可能です。 030 * 031 * @og.formSample 032 * ●形式:<og:frame src="…" name="…" /> 033 * ●body:なし 034 * 035 * ●Tag定義: 036 * <og:frame 037 * src ○【HTML】フレームに表示するソースファイルを指定します(必須)。 038 * name ○【HTML】フレーム名を指定します(例:QUERY,RESULT,CONTENTS など)(必須)。 039 * changeGamen 【TAG】ソース指定の画面を変更します 040 * keys 【TAG】引数を指定します 041 * dbTable 【TAG】前ページで選択したデータ列の情報を次のページに渡すかどうか[true/false]を指定します(初期値:false) 042 * longdesc 【HTML】フレームに関する詳しい説明のあるURL(lobgdesc)を指定します 043 * forceEnc 【TAG】(通常は使いません) valsの値が[で開始している場合でもURLEncodeを通すかを設定します(初期値:false) 5.10.15.3 (2019/09/27) 044 * id 【HTML】要素に対して固有の名前(id)をつける場合に設定します 045 * clazz 【HTML】要素に対して class 属性を設定します 046 * title 【HTML】要素に対する補足的情報(title)を設定します 047 * style 【HTML】この要素に対して適用させるスタイルシート(style)を設定します 048 * caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20) 049 * caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20) 050 * caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20) 051 * caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20) 052 * caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) 053 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 054 * /> 055 * 056 * 【廃止】7.0.1.0 (2018/10/15) 物理削除 057 * // marginwidth 【廃止】フレームの左右余白サイズ(marginwidth)を指定します(HTML5廃止属性) 058 * // marginheight 【廃止】フレームの上下余白サイズ(marginheight)を指定します(HTML5廃止属性) 059 * // noresize 【廃止】フレームサイズを変更できないよう(noresize)に指定します(HTML5廃止属性) 6.9.5.0 (2018/04/23) 物理削除 060 * // frameborder 【廃止】フレームの境界線(frameborder)の[0:非表示/1:表示]を指定します(初期値:1)(HTML5廃止属性) 6.9.5.0 (2018/04/23) 物理削除 061 * // scrolling 【廃止】スクロールバー(scrolling)の表示/非表示[auto/yes/no]を指定します(初期値:auto)(HTML5廃止属性) 062 * 063 * ●使用例: 064 * ・一般的な例:フレーム分割する構文は、HTML準拠。リクエスト変数は各フレームまで転送されます。 065 * <frameset> 066 * <og:frame src="query.jsp" name="QUERY" /> 067 * <og:frame src="forward.jsp" name="RESULT" /> 068 * </frameset> 069 * 070 * ・DBTableModel の値(例ではPN)を、取り出して、リクエスト変数として利用します。 071 * 現状では、commonForward タグ の useTableData="true" dbkeys="{@dbkeys}" 属性を利用します。 072 * <frameset> 073 * <og:frame src="query.jsp" name="QUERY" keys="PN" dbTable="true" /> 074 * <og:frame src="forward.jsp" name="RESULT" keys="PN" dbTable="true" /> 075 * </frameset> 076 * 077 * ・changeGamen 属性を利用して、ソース指定の画面を切り替えます。 078 * たとえば、jsp/index.jsp では、GAMENID属性がURLに存在する場合、直接その画面を 079 * 表示させることができます。 080 * <frameset cols="160,*,0" frameborder="1" framespacing="1"> 081 * <og:frame src="menu/menu.jsp" name="MENU" /> 082 * <og:frame src="GE0000/index.jsp" name="CONTENTS" 083 * changeGamen="{@GAMENID}" /> 084 * </frameset> 085 * 086 * @og.group 画面部品 087 * 088 * @version 4.0 089 * @author Kazuhiko Hasegawa 090 * @since JDK5.0, 091 */ 092public class FrameTag extends HTMLTagSupport { 093 /** このプログラムのVERSION文字列を設定します。 {@value} */ 094 private static final String VERSION = "6.9.5.0 (2018/04/23)" ; 095 private static final long serialVersionUID = 695020180423L ; 096 097 private String tableId = HybsSystem.TBL_MDL_KEY; 098 private String changeGmn ; 099 private String keys ; 100 private transient DBTableModel table; 101 private boolean dbTable ; 102 103 // 3.5.2.0 (2003/10/20) システムパラメータ の FRAME_UNDER_BAR_REQUEST_KEY_USED を使用。 104 private final boolean UNDER_BAR_KEY_USED = HybsSystem.sysBool( "FRAME_UNDER_BAR_REQUEST_KEY_USED" ); 105 /** 強制URLエンコード用 */ 106 protected boolean useForceEnc ; // 5.10.15.3 (2019/09/27) 強制URLエンコード用 107 108 /** 109 * デフォルトコンストラクター 110 * 111 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 112 */ 113 public FrameTag() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 114 115 /** 116 * タグリブオブジェクトをリリースします。 117 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 118 * 119 * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加 120 * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。 121 * @og.rev 5.10.15.3 (2019/09/27) forceEnc追加 122 * 123 */ 124 @Override 125 protected void release2() { 126 super.release2(); 127 tableId = HybsSystem.TBL_MDL_KEY; 128 changeGmn = null; // 4.0.0 (2005/02/28) 129 keys = null; 130 table = null; 131 dbTable = false; 132 useForceEnc = false; // 5.10.15.3 (2019/09/27) 133 } 134 135 /** 136 * リンクを作成します。 137 * 138 * @og.rev 3.5.4.0 (2003/11/25) comand="RENEW" 時には、dbTable 属性は、強制的に false とします。 139 * @og.rev 5.9.1.2 (2015/10/23) iframeとの継承関係で、共通的に呼び出すメソッドを追加します。 140 * 141 * @return リンクタグ文字列 142 * @og.rtnNotNull 143 */ 144 @Override 145 protected String makeTag() { 146 if( changeGmn != null ) { set( "src",changeGmn ); } 147 148 final String cmd = getRequest().getParameter( "command" ); 149 if( "RENEW".equals( cmd ) ) { dbTable = false; } 150 151 setIdName(); 152 final String urlEnc = getUrlEncode(); 153 return makeTagFrame( urlEnc ); 154 } 155 156 /** 157 * リンクを作成します。 158 * 159 * @og.rev 5.9.1.2 (2015/10/23) iframeとの継承関係で、共通的に呼び出すメソッドを追加します。 160 * 161 * @param urlEnc エンコードされたURL 162 * @return リンクタグ文字列 163 * @og.rtnNotNull 164 */ 165 protected String makeTagFrame( final String urlEnc ) { 166 return XHTMLTag.frame( getAttributes(),urlEnc ); 167 } 168 169 /** 170 * id 属性 / name 属性 セット 171 * 172 * フレーム名は id 属性で登録する(XHTML) 互換性のため、 173 * id 属性と name 属性には同じ値をセットしておく。 174 * 175 */ 176 private void setIdName() { 177 final String idno = get( "id" ); 178 final String name = get( "name" ); 179 if( idno == null || idno.isEmpty() ) { 180 if( name != null && name.length() > 0 ) { 181 set( "id", name ); 182 } 183 else { 184 final String errMsg = "id 属性か name 属性のどちらかは登録してください。"; 185 throw new HybsSystemException( errMsg ); 186 } 187 } 188 else { 189 set( "name", idno ); 190 } 191 } 192 193 /** 194 * keys 属性 を元に、request情報より values の値を取り込む。 195 * 196 * keys属性は キー情報がCSV形式になっている為,ばらして 197 * values属性の配列に一つづつ設定していきます。 198 * 199 * @og.rev 2.0.0.2 (2002/09/24) 検索結果の値を取り込めていなかったバグを修正。 200 * @og.rev 2.1.1.1 (2002/11/15) 選択行情報を取り込めていなかったバグを修正。 201 * @og.rev 3.4.0.3 (2003/09/10) DBTableModelへのリクエスト情報をURLに連結しないように変更。 202 * @og.rev 4.0.0.0 (2005/01/31) getParameterRows() を使用するように変更 203 * @og.rev 5.10.15.3 (2019/09/27) forceEnc追加 204 * 205 * @return URLエンコードされた文字列 206 * @og.rtnNotNull 207 */ 208// private String getUrlEncode() { 209 protected String getUrlEncode() { 210 final int[] rowNo = getParameterRows(); // 4.0.0 (2005/01/31) 211 final int selcount = rowNo.length; // 4.0.0 (2005/01/31) 212 213 final String[] key = (String[])StringUtil.enume2Array( getParameterNames(), new String[0] ); 214 String[] dbkey = null; 215 216 int dbcount = 0; 217 218 int recount = 0; 219 for( int i=0; i<key.length; i++ ) { 220 if( isNormalRequestKey( key[i] ) ) { // 3.4.0.3 (2003/09/10) 221 recount++; 222 } 223 } 224 225 if( keys != null && dbTable && selcount > 0 ) { 226 dbkey = StringUtil.csv2Array( keys ); 227 dbcount = dbkey.length; 228 } 229 230 String[] val = new String[ recount + dbcount + selcount ]; 231 String[] keyt = new String[ recount + dbcount + selcount ]; 232 233 int j = 0; 234 for( int i=0; i<key.length; i++ ) { 235 if( isNormalRequestKey( key[i] ) ) { // 3.4.0.3 (2003/09/10) 236 keyt[j] = key[i]; 237 val[j] = getRequestValue( key[i] ); 238 j++; 239 } 240 } 241 242 if( dbTable && dbcount > 0 ) { 243 table = (DBTableModel)getSessionAttribute( tableId ); 244 if( table != null ) { 245 for( int i=0; i<dbcount; i++ ) { 246 keyt[recount + i] = dbkey[i]; 247 val[recount +i] = table.getValue(rowNo[0],table.getColumnNo( dbkey[i] )); 248 } 249 } 250 } 251 252 // 4.0.0 (2005/01/31) selected文字配列をrowNo数字配列に変更 253 for( int i=0; i<selcount; i++ ) { 254 keyt[recount + dbcount + i] = HybsSystem.ROW_SEL_KEY; 255 val[recount + dbcount + i] = String.valueOf( rowNo[i] ); 256 } 257 258// return XHTMLTag.urlEncode( keyt,val ); 259 return XHTMLTag.urlEncode( keyt,val,"&",useForceEnc ); // 5.10.15.3 (2019/09/27) 260 } 261 262 /** 263 * 【HTML】フレームに表示するソースファイルを指定します。 264 * 265 * @og.tag フレームに表示するソースファイルを指定します。 266 * 267 * @param src ソースファイル 268 */ 269 public void setSrc( final String src ) { 270 set( "src",getRequestParameter( src ) ); 271 } 272 273 /** 274 * 【HTML】フレーム名を指定します(例:QUERY,RESULT,CONTENTS など)。 275 * 276 * @og.tag フレーム名を指定します。 277 * 278 * @param name フレーム名 279 */ 280 public void setName( final String name ) { 281 set( "name",getRequestParameter( name ) ); 282 } 283 284 /** 285 * 【HTML】フレームに関する詳しい説明のあるURL(lobgdesc)を指定します。 286 * 287 * @og.tag lobgdescを指定します。 288 * 289 * @param longdesc 詳しい説明のあるURL 290 */ 291 public void setLongdesc( final String longdesc ) { 292 set( "longdesc",getRequestParameter( longdesc ) ); 293 } 294 295 /** 296 * 【TAG】valsの値が[で開始している場合でもURLEncodeを通すかを設定します(初期値:false)。 297 * 298 * @og.tag 299 * テーブルモデルの値の変換のため、通常は先頭が[の場合はエンコードがかかりません。 300 * 強制的にかける場合にtrueにします。 301 * 302 * @og.rev 5.10.15.3 (2019/09/27) forceEnc追加 303 * 304 * @param flg URLEncodeを通す場合は、trueをセット 305 */ 306 public void setForceEnc( final String flg ) { 307 useForceEnc = nval( getRequestParameter( flg ), useForceEnc ); 308 } 309 310// /** 311// * 【廃止】フレームの左右余白サイズ(marginwidth)を指定します。 312// * HTML5では廃止されている属性のため、可能であればCSSを利用してください。 313// * 314// * @og.tag フレームの左右余白サイズを指定します。 315// * 316// * @og.rev 6.9.5.0 (2018/04/23) 値の設定を行いません。 317// * @og.rev 7.0.1.0 (2018/10/15) 廃止:物理削除 318// * 319// * @param marginwidth 左右余白サイズ 320// */ 321// public void setMarginwidth( final String marginwidth ) { 322//// set( "marginwidth",getRequestParameter( marginwidth ) ); 323// } 324 325// /** 326// * 【廃止】フレームの上下余白サイズ(marginheight)を指定します。 327// * HTML5では廃止されている属性のため、可能であればCSSを利用してください。 328// * 329// * @og.tag フレームの上下余白サイズを指定します。 330// * 331// * @og.rev 6.9.5.0 (2018/04/23) 値の設定を行いません。 332// * @og.rev 7.0.1.0 (2018/10/15) 廃止:物理削除 333// * 334// * @param marginheight 上下余白サイズ 335// */ 336// public void setMarginheight( final String marginheight ) { 337//// set( "marginheight",getRequestParameter( marginheight ) ); 338// } 339 340// /** 341// * 【廃止】フレームサイズを変更できないよう(noresize)に指定します。 342// * HTML5では廃止されている属性のため、可能であればCSSを利用してください。 343// * 344// * @og.tag 345// * フレームサイズを変更させない場合は、"noresize" を指定します。 346// * 処理自体は、空文字列以外であれば、内部的に"noresize" を設定します。 347// * 348// * @og.rev 6.9.5.0 (2018/04/23) 物理削除 349// * 350// * @param noresize フレームサイズ変更不可指定 351// */ 352// public void setNoresize( final String noresize ) { 353// final String ns = getRequestParameter( noresize ); 354// if( ns != null ) { set( "noresize", "noresize" ); } 355// } 356 357// /** 358// * 【廃止】スクロールバー(scrolling)の表示/非表示[auto/yes/no]を指定します(初期値:auto)。 359// * HTML5では廃止されている属性のため、可能であればCSSを利用してください。 360// * 361// * @og.tag 362// * auto:必要に応じてスクロールバーを表示(初期値) 363// * yes:常にスクロールバーを表示 364// * no:常にスクロールバーを表示しない 365// * 366// * @og.rev 6.9.5.0 (2018/04/23) 値の設定を行いません。 367// * @og.rev 7.0.1.0 (2018/10/15) 廃止:物理削除 368// * 369// * @param scrolling スクロールバーの表示方法指定 [auto:自動/yes:常時表示/no:非表示] 370// */ 371// public void setScrolling( final String scrolling ) { 372//// set( "scrolling",getRequestParameter( scrolling ) ); 373// } 374 375// /** 376// * 【廃止】フレームの境界線(frameborder)の[0:非表示/1:表示]を指定します(初期値:1)。 377// * HTML5では廃止されている属性のため、可能であればCSSを利用してください。 378// * 379// * @og.tag 380// * 0:枠を表示しない 381// * 1:枠を表示する。 382// * 初期値は、1:枠を表示する です。 383// * 384// * @og.rev 6.9.5.0 (2018/04/23) 物理削除 385// * 386// * @param frameborder フレームの境界線 [0:枠非表示/1:枠表示] 387// */ 388// public void setFrameborder( final String frameborder ) { 389// set( "frameborder",getRequestParameter( frameborder ) ); 390// } 391 392 /** 393 * 【TAG】ソース指定の画面を変更します。 394 * 395 * @og.tag 396 * src 指定がデフォルト設定で、changeGamen属性が設定されている 397 * 場合には、この値が優先されます。 398 * changeGamen は、画面IDのみ指定してください。src には、このID+"/index.jsp" が 399 * 追加されます。つまり、changeGamen="{@GAMENID}" という指定をしておけば、 400 * FavoriteLinkTag 等で引数に GAMENID が指定された場合のみ、この属性が有効になり、 401 * src="実画面ID/index.jsp" が指定されたことと同じ結果になります。 402 * 403 * @og.rev 3.1.2.0 (2003/04/07) 画面IDと実画面ディレクトリとの関連見直し(DIRの代りにGAMENIDを推奨) 404 * @og.rev 4.2.1.1 (2008/04/30) 画面切り替えをするのは、アドレスが設定されいる場合に限る 405 * @param src 置換えソース 406 */ 407 public void setChangeGamen( final String src ) { 408 final String sc = nval( getRequestParameter( src ),changeGmn ); 409 if( sc != null ) { 410 final GUIInfo guiInfo = getGUIInfo( sc ); 411 if( guiInfo != null && guiInfo.getAddress() != null && guiInfo.getAddress().length() > 0 ) { // 見つからない場合は、アクセス不可 412 changeGmn = guiInfo.getRealAddress( "index.jsp" ); 413 } 414 } 415 } 416 417 /** 418 * 【TAG】引数を指定します。 419 * 420 * @og.tag 421 * URL の引数にセットするキーを CSV形式でセットします。 422 * 423 * @param key 引数 424 */ 425 public void setKeys( final String key ) { 426 keys = getRequestParameter( key ) ; 427 } 428 429 /** 430 * 【TAG】前ページで選択したデータ列の情報を次のページに渡すかどうか[true:渡す/false:渡さない]を指定します(初期値:false)。 431 * 432 * @og.tag 433 * ただし、1行分のデータのみです。(複数選択時は、最初の1件目) 434 * trueを指定すると、データを渡します。falseの場合は、渡しません。 435 * 初期値は、false:渡さない です。 436 * 437 * @param db 選択データを渡すかどうか [true:渡す/false:渡さない] 438 */ 439 public void setDbTable( final String db ) { 440 dbTable = nval( getRequestParameter( db ),dbTable ); 441 } 442 443 /** 444 * 標準的な リクエスト情報かどうかを判断します。 445 * 446 * これは、引数のキーが、HybsSystem.ROW_SEL_KEY か、 447 * DBTableModel で送信されたキー( キー__番号)形式の場合は 448 * false を返します。 449 * 通常のリクエストキーとして扱いたくない場合の判定に使用します。 450 * 451 * @og.rev 3.4.0.3 (2003/09/10) 新規追加 452 * @og.rev 3.5.2.0 (2003/10/20) システムパラメータ の FRAME_UNDER_BAR_REQUEST_KEY_USED を使用。 453 * @og.rev 3.5.5.0 (2004/03/12) 名前と行番号の区切り記号("__")を、HybsSystem.JOINT_STRING に変更。 454 * @og.rev 6.8.1.1 (2017/07/22) 転送不要のキーを除外します。 455 * 456 * @param key 判定するキー 457 * 458 * @return 標準的な リクエスト情報かどうか [true:標準的/false:それ以外] 459 */ 460 private boolean isNormalRequestKey( final String key ) { 461 return key != null && 462 ! key.equals( HybsSystem.ROW_SEL_KEY ) && 463 ! key.startsWith( HybsSystem.NO_XFER_KEY ) && // 6.8.1.1 (2017/07/22) 464 ( key.indexOf( HybsSystem.JOINT_STRING ) < 0 || UNDER_BAR_KEY_USED ) ; 465 } 466 467 /** 468 * このオブジェクトの文字列表現を返します。 469 * 基本的にデバッグ目的に使用します。 470 * 471 * @return このクラスの文字列表現 472 * @og.rtnNotNull 473 */ 474 @Override 475 public String toString() { 476 return ToString.title( this.getClass().getName() ) 477 .println( "VERSION" ,VERSION ) 478 .println( "tableId" ,tableId ) 479 .println( "changeGmn" ,changeGmn ) 480 .println( "keys" ,keys ) 481 .println( "dbTable" ,dbTable ) 482 .println( "Other..." ,getAttributes().getAttribute() ) 483 .fixForm().toString() ; 484 } 485}