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