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