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.HybsSystemException; 019import org.opengion.hayabusa.resource.CodeData; // 7.0.5.1 (2019/09/27) 020import org.opengion.hayabusa.db.SelectionFactory; // 7.0.5.1 (2019/09/27) 021import org.opengion.hayabusa.db.Selection; // 7.0.5.1 (2019/09/27) 022 023import org.opengion.fukurou.util.XHTMLTag; 024import org.opengion.fukurou.util.ToString; // 6.1.1.0 (2015/01/17) 025 026import java.util.stream.Stream; // 6.4.3.4 (2016/03/11) 027import java.util.stream.Collectors; // 6.4.3.4 (2016/03/11) 028 029/** 030 * プルダウンメニューの選択項目を作成するHTML拡張タグです。 031 * 032 * name 属性は、ラベルリソース のキーを与えることで、使用する上位のタグの 033 * ロケールにあわせたリソースを使用して、画面に表示します。 034 * 従って、このタグでは ロケールは指定できません。 035 * selected属性は、そのタグが選ばれている場合を、"true" で指定します。 初期値は、"false" です。 036 * 037 * @og.formSample 038 * ●形式:<og:option value="…" lbl ="…" selected="…" /> 039 * ●body:なし 040 * 041 * ●Tag定義: 042 * <og:option 043 * value 【TAG】値を指定します 044 * selected 【TAG】オプションを選択済みの状態(selected)にセットします(初期値:未選択) 045 * lbl 【TAG】ラベルリソースのラベルIDを指定します 046 * lbls 【TAG】ラベルをCSV形式で複数指定します 047 * label 【TAG】optionタグのラベルを指定します 048 * codeName 【TAG】コードセレクトのユニークキー(コード名称)をセットします 7.0.5.1 (2019/09/27) 049 * caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 050 * caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 051 * caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 052 * caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 053 * caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) 054 * id 【HTML】要素に対して固有の名前(id)をつける場合に設定します 055 * lang 【HTML】要素の内容と他の属性値の言語(lang,xml:lang)を指定します 056 * dir 【HTML】文字表記の方向(dir)を指定します 057 * title 【HTML】要素に対する補足的情報(title)を設定します 058 * style 【HTML】この要素に対して適用させるスタイルシート(style)を設定します 059 * disabled 【TAG】その部品に対して、選択や変更が出来ないように(disabled)指定します(サーバーに送信されない) 060 * clazz 【HTML】要素に対して class 属性を設定します 061 * language 【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します 062 * roles 【TAG】ロールをセットします 063 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 064 * /> 065 * 066 * ●使用例 067 * プルダウンで選択する 値(value) に対して ラベル(lbl) を付けられます。 068 * <og:select name="ORDER_BY" lbl="ORDER_BY"> 069 * <og:option value="SYSTEM_ID,CLM,LANG" lbl ="CLM" selected="selected" /> 070 * </og:select> 071 * 072 * ラベルが複数ある場合は、lbls 属性を使用します。 073 * <og:select name="ORDER_BY" lbl="ORDER_BY"> 074 * <og:option value="SYSTEM_ID,CLM,LANG" lbls="LANG,NAME_JA" /> 075 * </og:select> 076 * 077 * MessageResource プロパティの値を使用したいとききはlbl属性を使います。 078 * <og:select name="CDC"> 079 * <og:option lbl="MSG0001" /> 080 * </og:select> 081 * 082 * LabelResource プロパティの値を使用したいとききはlbl属性を使います。 083 * <og:select name="CDC"> 084 * <og:option lbl="CDC1" /> 085 * </og:select> 086 * 087 * 選択肢の中から複数選択できるようにするときはmultiple属性を使います。 088 * <og:select name="CDC" multiple="multiple"> 089 * <og:option value="AAA" /> 090 * </og:select> 091 * 092 * 選択不可にするときはdisabled属性を使います。 093 * <og:select name="CDC" disabled="disabled"> 094 * <og:option value="AAA" /> 095 * </og:select> 096 * 097 * 選択肢をSELECT文の結果から作成したいときはqueryOptionタグと組み合わせて使います。 098 * <og:select name="CDC"> 099 * <og:queryOption> 100 * select NOSYN,NOSYN,':',NMSYN from DB01 ORDER BY 1 101 * </og:queryOption> 102 * </og:select> 103 * 104 * @og.rev 5.7.1.0 (2013/12/06) DatalistTag 対応で、大幅に見直し 105 * @og.group 選択データ制御 106 * 107 * @version 4.0 108 * @author Kazuhiko Hasegawa 109 * @since JDK5.0, 110 */ 111public class OptionTag extends HTMLTagSupport { 112 /** このプログラムのVERSION文字列を設定します。 {@value} */ 113 private static final String VERSION = "7.0.5.1 (2019/09/27)" ; 114 private static final long serialVersionUID = 705120190927L ; 115 116 /** 117 * デフォルトコンストラクター 118 * 119 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 120 */ 121 public OptionTag() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 122 123 /** 124 * ラベルを作成します。 125 * 126 * lbl 属性でセットされた場合は,そちらを優先します。 127 * セットされていない場合は,value 属性をキーに、 128 * LabelResource プロパティの値をセットします。 129 * value 属性に、カンマ(,)で区切られた複数の Label を 130 * セットできます。 131 * 132 * @og.rev 3.5.4.0 (2003/11/25) selVal 属性を追加。 133 * @og.rev 3.5.5.7 (2004/05/10) DBColumn.getOption( String ) メソッド廃止 134 * @og.rev 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。 135 * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応 136 * @og.rev 5.7.1.0 (2013/12/06) findAncestorWithClass を移動 137 * @og.rev 5.7.1.0 (2013/12/06) SelectTag ⇒ OptionAncestorIF に変更して、DatalistTag にも対応。 138 * @og.rev 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうかの、addKeyLabel 属性対応 139 * @og.rev 7.0.5.1 (2019/09/27) codeName を指定することでリソースからoptionを作成します。 140 * 141 * @return null固定(null を返せば、doEndTag() では、何もしない) 142 */ 143 @Override 144 protected String makeTag() { 145 // 3.5.4.0 (2003/11/25) selVal 属性を追加。 146 // 5.7.1.0 (2013/12/06) findAncestorWithClass を doEndTag() から移動 147 final OptionAncestorIF select = (OptionAncestorIF)findAncestorWithClass( this,OptionAncestorIF.class ); 148 if( select == null ) { 149 final String errMsg = "<b>" + getTagName() + "タグは、SelectTag または、DatalistTag のBODY に記述する必要があります。</b>"; 150 throw new HybsSystemException( errMsg ); 151 } 152 153 // 7.0.5.1 (2019/09/27) codeName を指定することでリソースからoptionを作成します。 154 final String codeName = get( "codeName" ); 155 if( codeName != null && codeName.length() > 0 ) { 156 final CodeData codeData = getResource().getCodeData( get( "codeName" ) ) ; 157 final Selection sel = SelectionFactory.newSelection( "MENU" , codeData , select.getAddKeyLabel() ); 158 159 if( sel == null ) { 160 final String errMsg = "<b>" + getTagName() + "タグのcodeName が、リソースに存在しません。</b> codeName=" + codeName ; 161 throw new HybsSystemException( errMsg ); 162 } 163 164 final String optStr = sel.getOption( select.getValue(),false,false ); 165 select.addOption( optStr ); 166 } 167 // 従来通りの処理 168 else { 169 final String selVal = "|" + select.getValue() + "|"; // 5.0.2.0 (2009/11/01) 170 final boolean multipleAll = select.isMultipleAll(); // 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。 171 172 if( multipleAll || selVal.indexOf( "|" + get( "value" ) + "|" ) >= 0 ) { 173 set( "selected","selected" ); 174 } 175 176 // 5.7.1.0 (2013/12/06) 上位に上げるのではなく、BODY部に出力する。 177 final String msglbl = getMsglbl(); 178 if( msglbl != null ) { 179 set( "body", msglbl ); 180 } 181 182 // 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか[true:キー:ラベル形式/false:ラベルのみ/null:指定通り] 183 select.addOption( XHTMLTag.option( getAttributes() , select.getAddKeyLabel() ) ); 184 } 185 186 return null; 187 } 188 189 /** 190 * 【TAG】値を指定します。 191 * 192 * @og.tag 193 * ここで指定した値がプルダウンメニュー中に存在する場合、選択状態になります。 194 * 195 * @param val 値 196 */ 197 public void setValue( final String val ) { 198 set( "value",getRequestParameter( val ) ); 199 } 200 201 /** 202 * 【TAG】optionタグのラベルを指定します。 203 * 204 * @og.tag 205 * ここでのラベルは、optionタグのラベルです。(lbl属性は、異なります。) 206 * これは、optgroup とともに使用される階層化メニュー時に使用されます。 207 * 208 * @param label ラベル 209 */ 210 public void setLabel( final String label ) { 211 set( "label",getRequestParameter( label ) ); 212 } 213 214 /** 215 * 【TAG】コードセレクトのユニークキー(コード名称)をセットします。 216 * 217 * @og.tag 218 * このキーを元に、CodeData オブジェクトを構築します。 219 * option をリソースから出力することができます。 220 * 221 * @og.rev 7.0.5.1 (2019/09/27) 新規作成 222 * 223 * @param name メニューのユニークキー 224 */ 225 public void setCodeName( final String name ) { 226 set( "codeName",getRequestParameter( name ) ); 227 } 228 229 /** 230 * 【TAG】オプションを選択済みの状態(selected)にセットします(初期値:未選択)。 231 * 232 * @og.tag 233 * selected="selected" または selected="true" 以外の値はセットできないように 234 * 制限をかけます。 235 * 初期値は、未選択 です。 236 * 237 * @param sel 選択済み状態 [selected:選択済み/それ以外:未選択] 238 */ 239 public void setSelected( final String sel ) { 240 final String select = getRequestParameter( sel ); 241 if( "selected".equalsIgnoreCase( select ) || "true".equalsIgnoreCase( select ) ) { 242 set( "selected","selected" ); 243 } 244 } 245 246 /** 247 * 【TAG】ラベルをCSV形式で複数指定します。 248 * 249 * @og.tag 250 * シングルラベルの lbl 属性との違いは,ここではラベルを複数 CSV形式で 251 * 渡すことが可能であることです。これにより、"A,B,C" という値に対して、 252 * "Aのラベル表示,Bのラベル表示,Cのラベル表示" という具合に文字列を 253 * 再合成します。 254 * これは、SQL文のOrdr By 句で、ソート順を指定する場合などに便利です。 255 * <og:option lbls="MKNMJP,MKCD,MKNMEN" /> 256 * 257 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 258 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 259 * 260 * @og.rev 3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得 261 * @og.rev 5.2.2.0 (2010/11/01) setMsglbl 廃止 ⇒ setLbl に置換え 262 * @og.rev 6.4.3.4 (2016/03/11) CSV形式の文字連結を、stream 経由で行います。 263 * @og.rev 6.5.0.0 (2016/09/30) " DESC" 文字列を見つけた場合、DESCだけリソース変換します。 264 * 265 * @param lbls 複数ラベルID(CSV形式) 266 */ 267 public void setLbls( final String lbls ) { 268 269 final String[] keys = getCSVParameter( lbls ); 270 if( keys == null || keys.length == 0 ) { return ; } 271 272 final String lblCSV = Stream.of( keys ) 273 .map( key -> gwtDescLabel( key ) ) // 6.5.0.0 (2016/09/30) 274 .collect( Collectors.joining( "," ) ); 275 276 setLbl( lblCSV ); // 5.2.2.0 (2010/11/01) setMsglbl 廃止 ⇒ setLbl に置換え 277 } 278 279 /** 280 * ラベルの文字列表現に、DESC 文字列解析を加えました。 281 * 282 * キーに、" DESC" 文字列を見つけた場合、DESC部分をリソース変換して、元のキーの 283 * ラベル文字列に合成します。 284 * 主に、並び順を処理する optionタグで、使用することを想定しています。 285 * 286 * @og.rev 6.5.0.0 (2016/09/30) " DESC" 文字列を見つけた場合、DESCだけリソース変換します。 287 * 288 * @param key ラベルID 289 * @return DESC文字列解析付きラベルの文字列表現 290 */ 291 private String gwtDescLabel( final String key ) { 292 final int sp = key.indexOf( " DESC" ); 293 if( sp < 0 ) { 294 return getLabel( key ); 295 } 296 else { 297 return getLabel( key.substring( 0,sp ) ) + getLabel( "DESC" ); 298 } 299 } 300 301 /** 302 * このオブジェクトの文字列表現を返します。 303 * 基本的にデバッグ目的に使用します。 304 * 305 * @og.rev 5.7.1.0 (2013/12/06) selVal と、multipleAll をローカル変数化する。 306 * 307 * @return このクラスの文字列表現 308 * @og.rtnNotNull 309 */ 310 @Override 311 public String toString() { 312 return ToString.title( this.getClass().getName() ) 313 .println( "VERSION" ,VERSION ) 314 .println( "Other..." ,getAttributes().getAttribute() ) 315 .fixForm().toString() ; 316 } 317}