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 static org.opengion.fukurou.util.StringUtil.nval; 019 020import org.opengion.fukurou.util.XHTMLTag; 021import org.opengion.hayabusa.common.HybsSystem; 022import org.opengion.hayabusa.resource.GUIInfo; 023 024/** 025 * テキストフィールドの入力を補助するポップアップを作成します。 026 * 027 * 通常のテキストフィールドに組み込むケースと、一覧表に組み込むケースに対応しています。 028 * 基本的には、columnMarker タグと同じ使い方ですが、フィールドが書き込み許可時に表示させる必要が 029 * あるため、実際には、viewMarker の isRendere="false" で使用するケースが多いと思います。 030 * なお、ポップアップ専用なので href="index.jsp" target="CONTENTS" がデフォルトで設定されています。 031 * 032 * @og.formSample 033 * ●形式:<og:popup gamenId="…" href="…" keys="…,…" vals="…,…" rtnKeys="…,…" /> 034 * ●body:なし 035 * 036 * ●Tag定義: 037 * <og:popup 038 * name 【TAG】この要素をリンクの対象とするための名前を指定します 039 * gamenId 【TAG】画面ID属性を登録します 040 * href 【TAG】ポップアップ先のURLを指定します(初期値:index.jsp) 041 * keys 【TAG】ポップアップ先に渡す入力キー配列をCSV形式で複数指定します 042 * vals 【TAG】ポップアップ先に渡す値配列をCSV形式で複数指定します 043 * rtnKeys 【TAG】ポップアップ先より受け取るキー配列をCSV形式で複数指定します 044 * column 【TAG】リンクをつけたいカラムを指定します 045 * onMark 【TAG】リンクを張る(true or 1)/張らない(false or 0)の設定を指定します(初期値:true) 046 * markList 【TAG】処理するマークを、"|"区切りの文字列で指定します 047 * height 【TAG】ダイアログの縦幅をピクセル数で指定します 048 * width 【TAG】ダイアログの横幅をピクセル数で指定します 049 * src 【TAG】表示させる画像のURLを指定します 050 * charset 【TAG】ポップアップ先の文字コードセットを指定します 051 * target 【TAG】ポップアップ先の表示ターゲットを指定します(初期値:CONTENTS) 052 * caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 053 * caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 054 * caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:true) 055 * caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:true) 056 * id 【HTML】要素に対して固有の名前(id)をつける場合に設定します 057 * lang 【HTML】要素の内容と他の属性値の言語(lang,xml:lang)を指定します 058 * dir 【HTML】文字表記の方向(dir)を指定します 059 * title 【HTML】要素に対する補足的情報(title)を設定します 060 * style 【HTML】この要素に対して適用させるスタイルシート(style)を設定します 061 * tabindex 【HTML】タブの移動順(tabindex)を指定します(0 ~ 32767) 062 * accesskey 【HTML】アクセスキー(alt+キーで直接指定)を割り当てます 063 * clazz 【HTML】要素に対して class 属性を設定します 064 * lbl 【TAG】ラベルリソースのラベルIDを指定します 065 * language 【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します 066 * command 【TAG】(通常使いません)処理の実行を指定する command を設定できます(初期値:NEW) 067 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 068 * /> 069 * 070 * ●使用例 071 * ・普通のポップアップ 072 * <og:popup gamenId="GE0002" href="index.jsp" target="CONTENTS" 073 * keys="AAA,BBB,CCC" vals="{@AAA},{@B},ABC" 074 * rtnKeys="DDD,EEE" /> 075 * 076 * ・QUERYの入力フィールドに組み込む 077 * ①keys、vals、rtnKeys がセットされる場合 078 * セットされる keys に対して vals の値をポップアップ画面に渡し、ポップアップ画面の戻り値を rtnKeys にセットされます。 079 * <og:column name="AAA" value="{@AAA}" > 080 * <og:popup gamenId="GE0002" 081 * keys="AAA,BBB,CCC" vals="{@AAA},{@B},ABC" 082 * rtnKeys="DDD,EEE" /> 083 * </og:column> 084 * ②keys、vals、rtnKeys がセットされない場合 085 * ポップアップ画面にリクエスト変数 XNAME に外側のカラム名、XVALUE にカラムの入力値、rtnKeys にカラム名を自動的にセットされます。 086 * <og:column name="AAA" value="{@AAA}" > 087 * <og:popup gamenId="GE0002" /> 088 * </og:column> 089 * 090 * ・RESULTの入力フィールドに組み込む(viewMarker 経由) 091 * gamenId を指定しなければこの画面へのURLを作成します。 092 * このURLは、その画面の index.jsp に直接ジャンプするためのURLです。 093 * <og:viewMarker command="{@command}" isRenderer="false"> 094 * <og:popup gamenId="GE0002" column="ABC" onMark="[ABC]" markList="1|2|3" 095 * keys="AAA,BBB,CCC" vals="[AAA],[BBB].value,{@CCC}" 096 * rtnKeys="DDD,EEE" /> 097 * </og:viewMarker> 098 * 099 * ・ポップアップ側のJSPファイル(view 部分) 100 * 101 * @og.group 画面部品 102 * @og.rev 3.8.6.1 (2006/10/20) 新規作成 103 * 104 * @version 0.9.0 2000/10/17 105 * @author Kazuhiko Hasegawa 106 * @since JDK1.1, 107 */ 108public class PopupTag extends HTMLTagSupport { 109 //* このプログラムのVERSION文字列を設定します。 {@value} */ 110 private static final String VERSION = "5.2.2.0 (2010/11/01)" ; 111 112 private static final long serialVersionUID = 522020101101L ; 113 114 private static final String DEF_BODY = "▼" ; 115 private static final String DEF_STYLE = "width:20px;text-align:center;" ; 116 117 private String column = null; 118 private String gamenId = null; 119 private String href = "index.jsp"; 120 private String target = "CONTENTS"; 121 private String onMark = "true"; // true または 1 122 private String markList = "true|TRUE|1"; // true または 1 123 private String height = null; 124 private String width = null; 125 private String imgsrc = null; 126 private String[] keys = null; 127 private String[] vals = null; 128 private String[] rtnKeys = null; 129 130 /** command 引数に渡す事の出来る コマンド 新規 {@value} */ 131 private static final String CMD_NEW = "NEW" ; // 5.1.7.0 (2010/06/01) 132 private String command = CMD_NEW; // 5.1.7.0 (2010/06/01) 133 134 /** 135 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。 136 * 137 * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応 138 * 139 * @return 後続処理の指示 140 */ 141 @Override 142 public int doEndTag() { 143 // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応 144 if( useTag() ) { 145 makeGamenLink(); 146 147 // GAMENID属性のURLへの自動セットは行わない。 148 ViewMarkerTag viewMark = (ViewMarkerTag)findAncestorWithClass( this,ViewMarkerTag.class ); 149 if( viewMark != null ) { 150 set( "onMark" ,onMark ); 151 set( "markList",markList ); 152 set( "body" ,makePopup( true ) ); 153 154 if( column != null && column.length() > 0 ) { 155 set( "column" ,column ); // 4.0.0 (2005/08/31) 同一カラムの複数登録を許可します。 156 viewMark.addAttribute( getAttributes() ); 157 } 158 } 159 else { 160 if( markList.indexOf( onMark ) >= 0 ) { 161 jspPrint( makePopup( false ) ); 162 } 163 } 164 } 165 return EVAL_PAGE ; 166 } 167 168 /** 169 * 使用しません。 170 * 171 * @return (null 固定) 172 */ 173 @Override 174 protected String makeTag() { return null; } 175 176 /** 177 * タグリブオブジェクトをリリースします。 178 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 179 * 180 */ 181 @Override 182 protected void release2() { 183 super.release2(); 184 column = null; 185 gamenId = null; 186 href = "index.jsp"; 187 target = "CONTENTS"; 188 onMark = "true"; // true または 1 189 markList = "true|TRUE|1"; // true または 1 190 keys = null; 191 vals = null; 192 rtnKeys = null; 193 height = null; 194 width = null; 195 imgsrc = null; 196 command = CMD_NEW; // 5.1.7.0 (2010/06/01) 197 } 198 199 /** 200 * リンクを作成します。 201 * 202 * @og.rev 4.2.4.0 (2008/07/01) keys,vals,rtnKeysが設定されていない場合、外側のog:columnタグのname値を設定するように変更 203 * @og.rev 5.1.7.0 (2010/06/01) 引数にcommandを追加 204 * @og.rev 5.2.1.0 (2010/10/01) height、width には、"px" などの単位を付ける前提での対応 205 * @og.rev 5.2.2.0 (2010/11/01) height、width が null の場合は、シングルクオートをつけない。 206 * 207 * @param useKey [true:KEY付き/false:KEY無し] 208 * 209 * @return リンクタグ文字列 210 */ 211 private String makePopup( final boolean useKey ) { 212 StringBuilder rtn = new StringBuilder(); 213 // 5.2.1.0 (2010/10/01) px を付けると数字ではなくなるため、シングルクオーテーションでくくる。 214 rtn.append( "ogPopup( '" ).append( get( "href" ) ).append( "'," ); 215 // 5.2.2.0 (2010/11/01) height、width が null の場合は、シングルクオートをつけない。 216 if( height != null ) { rtn.append( "'" ).append( height ).append( "'" ); } 217 else { rtn.append( "null" ); } 218 rtn.append( "," ); 219 if( width != null ) { rtn.append( "'" ).append( width ).append( "'" ); } 220 else { rtn.append( "null" ); } 221 rtn.append( "," ); 222 223 String columnName = null; //4.2.4.0 2008/07/01 224 if( keys != null && keys.length > 0 ) { 225 rtn.append( "new Array(" ); 226 addQuote( rtn, keys[0], false ); 227 rtn.append( "," ); 228 addQuote( rtn, vals[0], false ); 229 for( int i = 1; i < keys.length; i++ ) { 230 rtn.append( "," ); 231 addQuote( rtn, keys[i], false ); 232 rtn.append( "," ); 233 addQuote( rtn, vals[i], false ); 234 } 235 rtn.append( ")," ); 236 } 237 else { 238 ColumnTag outerColumn = (ColumnTag) findAncestorWithClass( this, ColumnTag.class ); 239 columnName = ( outerColumn == null ) ? null : outerColumn.getName(); 240 if( columnName != null ) { 241 rtn.append( "new Array('XNAME','" ); 242 rtn.append( columnName ); 243 rtn.append( "','XVALUE'," ); 244 rtn.append( columnName ); 245 rtn.append( ".value" ); 246 rtn.append( ")," ); 247 } 248 else { 249 rtn.append( "null," ); 250 } 251 } 252 rtn.append( "" ); 253 254 if( rtnKeys != null && rtnKeys.length > 0 ) { 255 rtn.append( "this,new Array(" ); 256 addQuote( rtn, rtnKeys[0], useKey ); 257 for( int i = 1; i < rtnKeys.length; i++ ) { 258 rtn.append( "," ); 259 addQuote( rtn, rtnKeys[i], useKey ); 260 } 261 rtn.append( ")" ); 262 } 263 else if( columnName != null ) { 264 rtn.append( "this,new Array('" ); 265 rtn.append( columnName ); 266 rtn.append( "')" ); 267 } 268 else { 269 rtn.append( "null,null" ); 270 } 271 272 // 5.1.7.0 (2010/06/01) 引数にcommandを追加 273 rtn.append( ",'" ).append( command ).append( "');" ); 274 275 if( imgsrc == null ) { 276 set( "type" , "button" ); 277 set( "body" , nval( getMsglbl(),DEF_BODY) ); 278 set( "onClick", rtn.toString() ); 279 set( "style" , nval( get( "style" ),DEF_STYLE) ); 280 return XHTMLTag.button( getAttributes() ) ; 281 } 282 else { 283 set( "src" , imgsrc ); 284 set( "title" , getMsglbl() ); 285 set( "onClick", rtn.toString() ); 286 set( "style" , get( "style" ) ); 287 return XHTMLTag.img( getAttributes() ) ; 288 } 289 } 290 291 /** 292 * 引数 val の設定値を設定する簡易メソッド 293 * 294 * @param buf 結果を格納するStringBuilderオブジェクト 295 * @param val 設定値 296 * @param useKey [true:KEY付き/false:KEY無し] 297 * 298 * @return (引数のバッファと同じオブジェクト) 299 */ 300 private StringBuilder addQuote( final StringBuilder buf, final String val, final boolean useKey ) { 301 if( useKey ) { 302 if( val != null && val.endsWith( ".value" ) ) { 303 buf.append( val.substring( 0,val.length()-6 ) ).append( "__{I}.value" ); 304 } 305 else { 306 buf.append( "'" ).append( val ).append( "__{I}'" ); 307 } 308 } 309 else { 310 if( val != null && val.endsWith( ".value" ) ) { 311 if( val.charAt(0) == '[' ) { 312 buf.append( val.substring( 1,val.length()-7 ) ).append( "__{I}.value" ); 313 } 314 else { 315 buf.append( val ); 316 } 317 } 318 else { 319 buf.append( "'" ).append( val ).append( "'" ); 320 } 321 } 322 return buf ; 323 } 324 325 /** 326 * 画面IDとhref から、指定のURLを作成します。 327 */ 328 private void makeGamenLink() { 329 if( gamenId == null || gamenId.length() == 0 ) { return ; } 330 331 GUIInfo guiInfo = getGUIInfo( gamenId ); // 4.0.0 (2005/01/31) 332 if( guiInfo == null ) { return ; } // 見つからない場合は、アクセス不可 333 334 String address = guiInfo.getRealAddress( get( "href" ) ); 335 String url = getRequestParameter( address ); 336 set( "href",url ); 337 338 if( get( "title" ) == null ) { 339 set( "title","To:" + guiInfo.getLabel() ); 340 } 341 } 342 343 /** 344 * 【TAG】この要素をリンクの対象とするための名前を指定します。 345 * 346 * @og.tag この要素をリンクの対象とするための名前を指定します。 347 * 348 * @param name 名前 349 */ 350 public void setName( final String name ) { 351 set( "name",getRequestParameter( name ) ); 352 } 353 354 /** 355 * 【TAG】リンクをつけたいカラムを指定します。 356 * 357 * @og.tag 358 * このカラム名のTableModelに対して、 ViewLink タグが存在する場合は, 359 * リンクを張ります。 360 * 361 * @param clm カラム名 362 */ 363 public void setColumn( final String clm ) { 364 column = nval( getRequestParameter( clm ),column ); 365 } 366 367 /** 368 * 【TAG】画面ID属性を登録します。 369 * 370 * @og.tag 371 * gamenId 属性は、画面IDをキーに、実アドレスを求めるのに使用します。 372 * 画面IDが指定された場合は、実アドレスに変換する。指定されない場合は、 373 * href 属性をそのままリンク情報を作成します。 374 * 画面IDを指定する場合の href は、JSPファイル名(例えば、index.jsp 等)です。 375 * 376 * @param id 画面ID 377 */ 378 public void setGamenId( final String id ) { 379 gamenId = nval( getRequestParameter( id ),gamenId ); 380 } 381 382 /** 383 * 【TAG】ポップアップ先のURLを指定します(初期値:index.jsp)。 384 * 385 * @og.tag 386 * 通常、gamenId を指定している場合は、それ以降(index.jsp , result.jsp など)を指定します。 387 * 通常のリンクの場合、GAMENID/href というアドレスに合成されます。( GE0001/result.jsp など ) 388 * (正確には、画面IDではなく、対応する画面ADDRESSを使用します。) 389 * ポップアップ専用のリンクなので、初期値は、index.jsp です。 390 * 391 * @param href ポップアップ先のURL 392 */ 393 public void setHref( final String href ) { 394 set( "href",nval( getRequestParameter( href ),this.href ) ); 395 } 396 397 /** 398 * 【TAG】ポップアップ先の文字コードセットを指定します。 399 * 400 * @og.tag ポップアップ先の文字コードセットを指定します。 401 * 402 * @param charset 文字コードセット 403 */ 404 public void setCharset( final String charset ) { 405 set( "charset",getRequestParameter( charset ) ); 406 } 407 408 /** 409 * 【TAG】ポップアップ先の表示ターゲットを指定します(初期値:CONTENTS)。 410 * 411 * @og.tag ポップアップ先の表示ターゲットを指定します。 412 * 413 * @param target 表示ターゲット 414 */ 415 public void setTarget( final String target ) { 416 set( "target",nval( getRequestParameter( target ),this.target ) ); 417 } 418 419 /** 420 * 【TAG】ポップアップ先に渡す入力キー配列をCSV形式で複数指定します。 421 * 422 * @og.tag ポップアップ先に渡す入力キー配列を指定します。 423 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 424 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 425 * 426 * @param key 渡す入力キー配列(CSV形式) 427 */ 428 public void setKeys( final String key ) { 429 keys = getCSVParameter( key ); 430 } 431 432 /** 433 * 【TAG】ポップアップ先に渡す値配列をCSV形式で複数指定します。 434 * 435 * @og.tag ポップアップ先に渡す値配列を指定します。 436 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 437 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 438 * 439 * @param val 渡す値配列(CSV形式) 440 */ 441 public void setVals( final String val ) { 442 vals = getCSVParameter( val ); 443 } 444 445 /** 446 * 【TAG】ポップアップ先より受け取るキー配列をCSV形式で複数指定します。 447 * 448 * @og.tag ポップアップ先より受け取るキー配列を指定します。 449 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 450 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 451 * 452 * @param key 受け取るキー配列(CSV形式) 453 */ 454 public void setRtnKeys( final String key ) { 455 rtnKeys = getCSVParameter( key ); 456 } 457 458 /** 459 * 【TAG】リンクを張る(true or 1)/張らない(false or 0)の設定を指定します(初期値:true)。 460 * 461 * @og.tag 462 * リンクを張る場合は、"true"(または "1") リンクを張らない 463 * 場合は, "true以外"(または "0")をセットします。 464 * 初期値は、 "true"(リンクを張る)です。 465 * さらに、[カラム名] で、動的にカラムの値で、リンクを張る、張らないを 466 * 選ぶ事が可能になります。値は、"true"(または "1") で、マークします。 467 * ただし、単独 linkタグ時は使用できません。 468 * 追記 3.5.2.0 (2003/10/20):markList属性に、処理対象文字列郡を指定できます。 469 * これにより、リンクを処理するかどうかの判断が、true,1 以外にも使用できるようになりました。 470 * 471 * @param flag リンクの設定[true:リンクを張る/それ以外:リンクを張らない] 472 */ 473 public void setOnMark( final String flag ) { 474 onMark = nval( getRequestParameter( flag ),onMark ); 475 } 476 477 /** 478 * 【TAG】処理するマークを、"|"区切りの文字列で指定します。 479 * 480 * @og.tag 481 * markListで与えられた文字列に、onMark文字列(大文字/小文字の区別あり)が 482 * 含まれていれば、処理します。 483 * 例えば、"A","B","C" という文字列が、onMark で指定された 484 * 場合に処理するようにしたい場合は、"A|B|C" をセットします。 485 * markList には、[カラム名]指定が可能です。(ただし、単独 linkタグ時は除く) 486 * 初期値は、 "true|TRUE|1"です。 487 * 488 * @param list 処理するマーク(indexOf による含む/含まない判定) 489 */ 490 public void setMarkList( final String list ) { 491 markList = nval( getRequestParameter( list ),markList ); 492 } 493 494 /** 495 * 【TAG】ダイアログの縦幅をピクセル数で指定します。 496 * 497 * @og.tag 498 * 縦幅を指定します。単位も含めて入力してください。 499 * 設定しない場合は、ogPopup JavaScript の内部初期値が採用されます。 500 * 501 * @og.rev 5.2.1.0 (2010/10/01) height、width には、"px" などの単位を付ける前提での対応 502 * 503 * @param ht ダイアログの縦幅(ピクセル数) 504 */ 505 public void setHeight( final String ht ) { 506 height = nval( getRequestParameter( ht ),height ); 507 if( height != null && ! height.endsWith( "px" ) ) { height += "px"; } // 5.2.1.0 (2010/10/01) 508 } 509 510 /** 511 * 【TAG】ダイアログの横幅をピクセル数で指定します。 512 * 513 * @og.tag 514 * 横幅を指定します。単位も含めて入力してください。 515 * 設定しない場合は、ogPopup JavaScript の内部初期値が採用されます。 516 * 517 * @og.rev 5.2.1.0 (2010/10/01) height、width には、"px" などの単位を付ける前提での対応 518 * 519 * @param wh ダイアログの横幅(ピクセル数) 520 */ 521 public void setWidth( final String wh ) { 522 width = nval( getRequestParameter( wh ),width ); 523 if( width != null && ! width.endsWith( "px" ) ) { width += "px"; } // 5.2.1.0 (2010/10/01) 524 } 525 526 /** 527 * 【TAG】表示させる画像のURLを指定します。 528 * 529 * @og.tag 530 * この属性を設定すると、自動的に イメージリンクでの onClick属性で 531 * ポップアップの起動画面を作成します。 532 * この属性が設定されていない場合は、button での起動になります。 533 * 534 * @param src 画像のURL 535 */ 536 public void setSrc( final String src ) { 537 imgsrc = nval( getRequestParameter( src ),imgsrc ); 538 } 539 540 /** 541 * 【TAG】(通常使いません)処理の実行を指定する command を設定できます(初期値:NEW)。 542 * 543 * @og.tag 544 * ここで指定されたcommandは、ポップアップ画面の引数として渡されます。 545 * 初期値は、NEW です。 546 * 547 * @og.rev 5.1.7.0 (2010/06/01) 新規作成 548 * 549 * @param cmd コマンド 550 */ 551 public void setCommand( final String cmd ) { 552 command = nval( getRequestParameter( cmd ),command ); 553 } 554 555 /** 556 * このオブジェクトの文字列表現を返します。 557 * 基本的にデバッグ目的に使用します。 558 * 559 * @return このクラスの文字列表現 560 */ 561 @Override 562 public String toString() { 563 return org.opengion.fukurou.util.ToString.title( this.getClass().getName() ) 564 .println( "VERSION" ,VERSION ) 565 .println( "column" ,column ) 566 .println( "gamenId" ,gamenId ) 567 .println( "href" ,href ) 568 .println( "target" ,target ) 569 .println( "onMark" ,onMark ) 570 .println( "markList" ,markList ) 571 .println( "height" ,height ) 572 .println( "width" ,width ) 573 .println( "keys" ,keys ) 574 .println( "vals" ,vals ) 575 .println( "rtnKeys" ,rtnKeys ) 576 .println( "Other..." ,getAttributes().getAttribute() ) 577 .fixForm().toString() 578 + HybsSystem.CR 579 + super.toString() ; 580 } 581}