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 java.util.Set;                                                                                   // 6.4.3.4 (2016/03/11)
019import java.io.IOException;
020import java.io.ObjectInputStream;
021
022import org.opengion.fukurou.util.Options;
023import org.opengion.fukurou.util.StringUtil;
024import org.opengion.fukurou.util.TagBuffer;
025import org.opengion.fukurou.util.XHTMLTag;
026import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
027import org.opengion.fukurou.util.ArraySet;                                              // 6.4.3.4 (2016/03/11)
028import org.opengion.hayabusa.common.HybsSystem;
029import org.opengion.hayabusa.common.HybsSystemException;
030
031import static org.opengion.fukurou.util.StringUtil.nval;
032
033/**
034 * プルダウンメニューを作成するHTML拡張タグです。
035 *
036 * プルダウンメニュー内の選択肢は、selectタグの内容であるoptionタグ、
037 * またはqueryOptionタグによって指定します。
038 * optionタグがセットされない場合は、name属性の、コードリソース からoption文字列より、
039 * プルダウンメニューの選択肢を作成します。
040 * name 属性に ラベルリソース のキーを与えることで、 ロケールにあわせたリソースを使用して、
041 * 画面に表示します。ロケールは、ユーザー情報の lang 属性を初期値で使用し、
042 * セットされていない場合は、リクエスト情報のロケールから取得します。
043 * language 属性で定義されている場合は、そちらを優先します。
044 *
045 * @og.formSample
046 * ●形式:<og:select name="…" />
047 * ●body:あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{@XXXX} は解析しません)
048 *
049 * ●Tag定義:
050 *   <og:select
051 *       name             ○【TAG】メニューの名称を指定します(必須)。
052 *       value              【TAG】値を指定します
053 *       defaultVal         【TAG】value属性に値がセットされていないとき使用する、初期値を指定します
054 *       lbl                【TAG】ラベルリソースのラベルIDを指定します
055 *       must               【TAG】必須入力を表す色に変えるかどうか[true/false]を指定します(初期値:false)
056 *       mustAny            【TAG】選択必須入力(どれかひとつ必須)を表す色[true/mustAny/その他]を指定します(初期値:無指定)
057 *       useMustHidden      【TAG】必須の自動チェック用Hiddenを出力するかどうか[true/false]を指定します(初期値:true)
058 *       addNoValue         【TAG】値なしのOptionを含めるかどうか[true/false]を指定します(初期値:false)
059 *       addKeyLabel        【TAG】セレクトメニューの場合、キー:ラベル形式で表示するかどうか[true/false/null]を指定します(初期値:null)
060 *       td                 【TAG】テーブル形式の <td> タグを使用するかどうか[yes/no/false]を指定します(初期値:yes)
061 *       colspan            【TAG】フィールド部分の colspan を指定します
062 *       rowspan            【TAG】ラベル、フィールド共に rowspan を指定します
063 *       optionAttributes   【TAG】JavaScript などの HTML基本タグ以外の属性を、そのままタグとして使用します
064 *       size               【TAG】リストボックスとして表示する場合の表示行数を指定します
065 *       multiple           【TAG】複数選択を可能(multiple)にします(初期値:未設定)
066 *       id                 【HTML】要素に対して固有の名前(id)をつける場合に設定します
067 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
068 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
069 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない)
070 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない)
071 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
072 *       lang               【HTML】要素の内容と他の属性値の言語(lang,xml:lang)を指定します
073 *       dir                【HTML】文字表記の方向(dir)を指定します
074 *       title              【HTML】要素に対する補足的情報(title)を設定します
075 *       style              【HTML】この要素に対して適用させるスタイルシート(style)を設定します
076 *       disabled           【TAG】その部品に対して、選択や変更が出来ないように(disabled)指定します(サーバーに送信されない)
077 *       tabindex           【HTML】タブの移動順(tabindex)を指定します(0 ~ 32767)
078 *       clazz              【HTML】要素に対して class 属性を設定します
079 *       language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
080 *       onClick            【HTML】JavaScriptのイベント onClick を設定します(例:onClick="renew('query.jsp','QUERY');")
081 *       onChange           【HTML】JavaScriptのイベント onChange を設定します(例:onChange="renew('query.jsp','QUERY');")
082 *       onBlur             【HTML】JavaScriptのイベント onBlur を設定します(例:onBlur="this.value=value.toUpperCase();")
083 *       onFocus            【HTML】JavaScriptのイベント onFocus を設定します
084 *       ondblClick         【HTML】JavaScriptのイベント ondblClick を設定します
085 *       onMouseDown        【HTML】JavaScriptのイベント onMouseDown を設定します
086 *       onMouseUp          【HTML】JavaScriptのイベント onMouseUp を設定します
087 *       onMouseMove        【HTML】JavaScriptのイベント onMouseMove を設定します
088 *       onMouseOut         【HTML】JavaScriptのイベント onMouseOut を設定します
089 *       onMouseOver        【HTML】JavaScriptのイベント onMouseOver を設定します
090 *       onSelect           【HTML】JavaScriptのイベント onSelect を設定します
091 *       onKeydown          【HTML】JavaScriptのイベント onKeydown を設定します
092 *       onKeypress         【HTML】JavaScriptのイベント onKeypress を設定します
093 *       onKeyup            【HTML】JavaScriptのイベント onKeyup を設定します
094 *       autofocus          【HTML5】指定した入力欄にカーソルが当たって自動的にフォーカスされます。
095 *       roles              【TAG】ロールをセットします
096 *       eventColumn        【TAG】イベントカラム(親カラム)を指定します
097 *       eventValue         【TAG】イベントValueのSQL分
098 *       eventURL           【TAG】イベントカラム指定時に呼び出すURL
099 *       eventCallback      【TAG】eventColumn実行後のcallbak関数指定
100 *       useRealTimeCheck   【TAG】(通常は使いません)リアルタイムチェックを行うかどうか(初期値:true:行う) 5.9.32.2 (2018/05/18)
101 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
102 *   >   ... Body ...
103 *   </og:select>
104 *
105 * ●使用例
106 *    <og:select name="CDC">                       CodeResource プロパティの値を使用したいときはcode属性を使います。
107 *        <og:option code="CDC" />
108 *    </og:select>
109 *
110 *    <og:select name="CDC">                       選択項目の一番上に項目を付け足すことも可能です。
111 *        <og:option lbl="MSG0001" />              MessageResource プロパティの値を使用したいとききはlbl属性を使います。
112 *        <og:option code="CDC" />
113 *    </og:select>
114 *
115 *    <og:select name="CDC">                       選択項目の一番上に項目を付け足すことも可能です。
116 *        <og:option lbl="CDC1" />                 LabelResource プロパティの値を使用したいとききはlbl属性を使います。
117 *        <og:option code="CDC" />
118 *    </og:select>
119 *
120 *    <og:select name="CDC" multiple="multiple">   選択肢の中から複数選択できるようにするときはmultiple属性を使います。
121 *        <og:option code="CDC" />
122 *    </og:select>
123 *
124 *    <og:select name="CDC" disabled="disabled">   選択不可にするときはdisabled属性を使います。
125 *        <og:option code="CDC" />
126 *    </og:select>
127 *
128 *    <og:select name="CDC">                       選択肢をSELECT文の結果から作成したいときはqueryOptionタグと組み合わせて使います。
129 *        <og:queryOption>
130 *                    select NOSYN,NOSYN,':',NMSYN from DB01 ORDER BY 1
131 *        </og:queryOption>
132 *    </og:select>
133 *
134 *    <og:select name="CDC" eventColumn="OYA" >    親子関係のプルダウンを作る場合
135 *        <og:queryOption>
136 *                    select NOSYN,NOSYN,':',NMSYN from DB01
137 *                     where CLM = "{@OYA}" ORDER BY 1
138 *        </og:queryOption>
139 *    </og:select>
140 *
141 * @og.group 選択データ制御
142 *
143 * @version  4.0
144 * @author       Kazuhiko Hasegawa
145 * @since    JDK5.0,
146 */
147public class SelectTag extends HTMLTagSupport implements OptionAncestorIF {
148        /** このプログラムのVERSION文字列を設定します。   {@value} */
149        private static final String VERSION = "6.9.8.0 (2018/05/28)" ;
150        private static final long serialVersionUID = 698020180528L ;
151
152        // 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
153        private static final Set<String> TD_SET = new ArraySet<>( "yes" , "no" , "false" );
154
155        // 4.0.0 (2005/01/31) HTML_LABEL_SEPARATOR を boolean 変数として取得します。
156        private final String CLM = HybsSystem.sysBool( "HTML_LABEL_SEPARATOR" ) ? ":" : "" ;
157
158        // 4.0.0 (2005/01/31) USE_MULTI_KEY_SELECT を定義しておきます。
159//      // 6.9.5.0 (2018/04/23) USE_MULTI_KEY_SELECT 廃止(IE8以降ブラウザ標準)
160//      private final boolean USE_MULTI_KEY_SELECT =  HybsSystem.sysBool( "USE_MULTI_KEY_SELECT" ) ;
161
162        private transient Options option                = new Options();
163        private String  tdFlag          = "yes";        // yes:<td> タグを使用 / false:フィールドのみ / no:ラベルとフィールド
164
165        // 3.0.1.3 (2003/03/11) colspan 属性を追加。
166        private String  colspan     = "";               // 6.1.0.0 (2014/12/26) refactoring
167        private String  rowspan         = "";           // 6.2.0.0 (2015/02/27) rowspan 属性を追加。
168
169        // 3.5.4.0 (2003/11/25) value ,defaultVal  属性を追加。
170        private String  value       ;
171        private String  defaultVal      ;               // value がセットされていないときの初期値
172        private boolean multipleAll     ;               // 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
173        private String eventColumn      ;               // 4.3.6.0 (2009/04/01) イベントカラム
174        private String  eventValue      ;               // 6.3.4.0 (2015/08/01) eventValue 追加
175        private String eventURL         ;               // 5.1.9.0 (2010/08/01) 動的プルダウン不具合対応
176
177        private String  rawParam        ;               // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
178
179        // 5.1.9.0 (2010/08/01) 値なしのOptionをSelectに含めるかどうか 新規追加
180        private boolean addNoValue  ;           // 互換性のため、初期値は、false になります。
181        private String  addKeyLabel     ;               // 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか
182
183        /**
184         * デフォルトコンストラクター
185         *
186         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
187         */
188        public SelectTag() { super(); }         // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
189
190        /**
191         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
192         *
193         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
194         * @og.rev 5.1.7.0 (2010/06/01) command=RENEWの場合はdefaultValを無視する。
195         * @og.rev 5.1.9.0 (2010/08/01) addNoValue 対応
196         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
197         * @og.rev 5.3.7.0 (2011/07/01) 5.1.7.0 (2010/06/01)の対応で判定条件が逆転しているバグを修正
198         * @og.rev 6.3.1.0 (2015/06/28) 個人リソースのUSE_ADD_KEY_LABELで初期値設定
199         *
200         * @return      後続処理の指示( EVAL_BODY_INCLUDE )
201         */
202        @Override
203        public int doStartTag() {
204                // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
205                if( useTag() ) {
206                        // 6.3.1.0 (2015/06/28) 個人リソースのUSE_ADD_KEY_LABELで初期値設定
207                        if( addKeyLabel == null ) { addKeyLabel = nval( sys( "USE_ADD_KEY_LABEL" ) , null ); }          // 4:個人設定可
208
209                        if( value == null ) {
210        //                      value = nval( getRequestValue( get( "name" ) ),defaultVal );
211                                // 5.1.7.0 (2010/06/01) command=RENEWの場合はdefaultValを無視する。
212                                final String cmd = pageContext.getRequest().getParameter( "command" );
213                                if( "RENEW".equals( cmd ) ) {
214                                        value = StringUtil.array2line( getRequestValues( get( "name" ) ), "|" );
215                                }
216                                else {
217                                        value = nval( StringUtil.array2line( getRequestValues( get( "name" ) ), "|" ),defaultVal );
218                                }
219                        }
220
221                        // 5.1.9.0 (2010/08/01) addNoValue 対応:option を最初にセットする。
222                        if( addNoValue ) {
223                                option.add( "<option value=\"\" ></option>" );
224                        }
225
226                        return EVAL_BODY_INCLUDE ;      // Body インクルード( extends TagSupport 時)
227                }
228                return SKIP_BODY ;                              // Body を評価しない
229        }
230
231        /**
232         * タグリブオブジェクトをリリースします。
233         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
234         *
235         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
236         * @og.rev 2.0.0.8 (2002/10/09) yes/no/false で指定するように変更
237         * @og.rev 3.0.1.3 (2003/03/11) colspan 属性を追加。
238         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
239         * @og.rev 3.5.4.0 (2003/11/25) value ,defaultVal  属性を追加。
240         * @og.rev 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
241         * @og.rev 4.1.2.1 (2008/03/13) must , mustAny 属性を自動化します。
242         * @og.rev 4.3.6.0 (2009/04/01) eventColumn,eventURL追加
243         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
244         * @og.rev 5.1.9.0 (2010/08/01) columnタグで動的プルダウンが動作しない不具合に対応
245         * @og.rev 5.1.9.0 (2010/08/01) addNoValue  属性を追加。
246         * @og.rev 5.2.1.0 (2010/10/01) must , mustAny 属性の処理を、HTMLTagSupport に移します。
247         * @og.rev 6.0.4.0 (2014/11/28) addKeyLabel 属性を追加
248         * @og.rev 6.2.0.0 (2015/02/27) rowspan 属性を追加
249         * @og.rev 6.3.4.0 (2015/08/01) eventValue 追加
250         */
251        @Override
252        protected void release2() {
253                super.release2();
254                option          = new Options();
255                tdFlag     = "yes";     // table形式の <td> タグを使用するかどうか
256                colspan         = "";           // 6.1.0.0 (2014/12/26) refactoring
257                rowspan         = "";           // 6.2.0.0 (2015/02/27) rowspan 属性を追加
258                value       = null;
259                defaultVal      = null;         // value がセットされていないときの初期値
260                multipleAll     = false;        // 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
261                eventColumn     = null;         // 4.3.6.0 (2009/04/01)
262                eventValue  = null;     // 6.3.4.0 (2015/08/01)
263                eventURL        = null;         // 5.1.9.0 (2010/08/01) columnタグで動的プルダウンが動作しない不具合に対応
264                rawParam        = null;         // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
265                addNoValue  = false;    // 5.1.9.0 (2010/08/01) 互換性のため、初期値は、false になります。
266                addKeyLabel = null;             // 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか
267        }
268
269        /**
270         * 入力用のプルダウンメニューを作成します。
271         *
272         * 表示順の項目名タグは、あらかじめ作成済みの値をここでは受け取ります。
273         * hasSelect 属性の値に応じて,タグの作成方法は変わります。
274         *
275         * @og.rev 2.0.0.8 (2002/10/09) yes/no/false で指定するように変更
276         * @og.rev 2.0.1.0 (2002/10/10) ラベルとフィールドのセパレーターとして、コロン(:)を使用するかどうかを指定できる
277         * @og.rev 3.0.1.3 (2003/03/11) colspan 属性を追加。
278         * @og.rev 3.5.4.0 (2003/11/25) value ,defaultVal  属性を追加。
279         * @og.rev 4.0.0.0 (2005/01/31) マルチセレクションのON/OFFをここで指定。
280         * @og.rev 4.1.2.1 (2008/03/13) must , mustAny 属性を自動化します。
281         * @og.rev 4.3.6.0 (2009/04/01) eventColumn対応
282         * @og.rev 4.3.7.1 (2009/06/08) id=labelのclass化
283         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
284         * @og.rev 5.2.1.0 (2010/10/01) must , mustAny 属性の処理を、HTMLTagSupport に移します。
285         * @og.rev 5.5.3.0 (2012/06/01) idのセット見直し
286         * @og.rev 5.6.2.2 (2013/03/15) 自動must処理の出力位置を変更
287         * @og.rev 6.2.0.0 (2015/02/27) rowspan 属性を追加。makeMustHidden(String)対応
288         * @og.rev 6.3.4.0 (2015/08/01) eventValue 追加
289         * @og.rev 6.9.5.0 (2018/04/23) USE_MULTI_KEY_SELECT 廃止(IE8以降ブラウザ標準)
290         *
291         * @return      表示順選択用のプルダウンメニュータグ
292         * @og.rtnNotNull
293         */
294        @Override
295        protected String makeTag() {
296
297                final String name = get( "name" );
298                if( getMsglbl() == null ) { setLbl( name ); }
299
300                // 6.1.0.0 (2014/12/26) refactoring
301
302//              // 4.0.0 (2005/01/31) XHTMLTag.java より移動)
303//              // 6.9.5.0 (2018/04/23) USE_MULTI_KEY_SELECT 廃止(IE8以降ブラウザ標準)
304//              if( USE_MULTI_KEY_SELECT ) {
305//                      set( "onkeydown", "setKeySelect(this);" );
306//              }
307
308                // 5.5.3.0 既にIDが指定されている場合はnameをセットしない
309                if( get("id")==null || get("id").isEmpty() ){
310                        set( "id", name );
311                }
312
313                // 4.3.6.0 (2009/04/01) eventColumnの対応
314                // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
315                String selTag = XHTMLTag.select( getAttributes(), option );
316
317                // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
318                if( eventColumn != null && eventColumn.length() > 0 ) {
319                        String editor = null;
320                        if( rawParam != null && rawParam.length() > 0 ) {
321                                editor = "DBMENU";
322                        }
323                        else {
324                                editor = "MENU";
325                        }
326                        addEventColumn( name, eventColumn, eventValue , eventURL, "", editor, "", rawParam );   // 6.3.4.0 (2015/08/01)
327
328                        // 6.1.1.0 (2015/01/17) TagBufferの連結記述
329                        selTag = new TagBuffer( "span" )
330                                                .add( "class"                                                   , HybsSystem.EVENT_COLUMN_CLASS )
331                                                .add( HybsSystem.EVENT_COLUMN_ID                , name )
332                                                .add( HybsSystem.EVENT_COLUMN_INITVAL   , value )
333                                                .add( HybsSystem.EVENT_COLUMN_WRITABLE  , "true" )
334                                                .addBody( selTag )
335                                                .makeTag();
336
337                }
338
339                final StringBuilder rtn = new StringBuilder( BUFFER_MIDDLE );
340                if( "yes".equals( tdFlag ) ) {
341                        // 4.3.7.1 (2009/06/08) id=labelのclass化
342                        // rtn.append( "<td id=\"label\">" );
343                        rtn.append( "<td class=\"label\"" )
344                                .append( rowspan ).append( '>' )                // 6.2.0.0 (2015/02/27)
345                                .append( getLongLabel() )                               // 4.0.0 (2005/01/31)
346                                .append( CLM )
347                                .append( "</td><td" )
348                                .append( colspan )                                              // 6.1.0.0 (2014/12/26) refactoring
349                                .append( rowspan )                                              // 6.2.0.0 (2015/02/27)
350                                .append( '>' )                                                  // 6.0.2.5 (2014/10/31) char を append する。
351                                .append( selTag )
352                                .append( makeMustHidden( name ) )               // 6.2.0.0 (2015/02/27) , 5.6.2.2 (2013/03/15)
353                                .append( "</td>" );
354                }
355                else if( "no".equals( tdFlag ) ) {
356                        // 4.3.7.1 (2009/06/08) id=labelのclass化
357                        // rtn.append( "<span id=\"label\">" );
358                        rtn.append( "<span class=\"label\">" )
359                                .append( getLongLabel() )               // 4.0.0 (2005/01/31)
360                                .append( CLM )
361                                .append( "</span>" )
362                                .append( selTag )
363                                .append( makeMustHidden( name ) );              // 6.2.0.0 (2015/02/27) , 5.6.2.2 (2013/03/15)
364                }
365                // "false".equals( tdFlag ) の条件
366                else {
367                        rtn.append( selTag )
368                                .append( makeMustHidden( name ) );              // 6.2.0.0 (2015/02/27) , 5.6.2.2 (2013/03/15)
369                }
370
371                return rtn.toString() ;
372        }
373
374        /**
375         * メニュー項目の選択項目を追加します。
376         *
377         * select タグのBODY要素の OptionTag よりアクセスされます。
378         *
379         * @og.rev 3.1.2.0 (2003/04/07) taglib パッケージ内部で使用している箇所を protected 化する。
380         * @param       opt      オプションタグ文字列
381         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#addOption( String )
382         */
383        public void addOption( final String opt ) {
384                option.add( opt );
385        }
386
387        /**
388         * メニュー項目の最後の項目を削除します。
389         *
390         * select タグのBODY要素の OptionTag よりアクセスされます。
391         *
392         * @og.rev 6.8.0.0 (2017/06/02) メニュー項目の最後の項目を削除。
393         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#removeLast()
394         */
395        public void removeLast() {
396                option.removeLast();
397        }
398
399        /**
400         * 【TAG】メニューの名称を指定します。
401         *
402         * @og.tag メニューの名称を指定します。
403         *
404         * @param       name 名称
405         */
406        public void setName( final String name ) {
407                set( "name", getRequestParameter( name ) );
408        }
409
410        /**
411         * 【TAG】リストボックスとして表示する場合の表示行数を指定します。
412         *
413         * @og.tag 表示行数を指定します。
414         *
415         * @param       size 表示行数
416         */
417        public void setSize( final String size ) {
418                set( "size",getRequestParameter( size ) );
419        }
420
421        /**
422         * 【TAG】複数選択を可能(multiple)にします(初期値:未設定)。
423         *
424         * @og.tag
425         * multiple 値が "multiple" または "true" の場合、複数選択状態になります。
426         * また、"ALL" を設定する場合は、OptionTag上で、すべてのOption が選択状態に
427         * 初期設定されます。
428         * 大文字、小文字の種別はなくしますが、指定以外の文字が設定された場合は、エラーになります。
429         *
430         * @og.rev 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
431         *
432         * @param       multi 複数選択指定 [multiple:複数選択/true:複数選択/ALL:初期値全選択]
433         */
434        public void setMultiple( final String multi ) {
435                final String multiple = nval( getRequestParameter( multi ),null );
436                if( "multiple".equalsIgnoreCase( multiple ) || "true".equalsIgnoreCase( multiple ) ) {
437                        set( "multiple","multiple" );
438                }
439                else if( "ALL".equalsIgnoreCase( multiple ) ) {
440                        set( "multiple","multiple" );
441                        multipleAll = true;
442                }
443                else if( ! ( "false".equalsIgnoreCase( multiple ) || multiple == null ) ) {
444                        final String errMsg = "multiple 属性には、[multiple,true,ALL] 以外は設定できません。"
445                                                + "multiple=" + multi ;
446                        throw new HybsSystemException( errMsg );
447                }
448        }
449
450        /**
451         * 【TAG】テーブル形式の &lt;td&gt; タグを使用するかどうか[yes/no/false]を指定します(初期値:yes)。
452         *
453         * @og.tag
454         * 初期値は、使用する("yes") です。
455         *
456         * @og.rev 2.0.0.8 (2002/10/09) yes/no/false で指定するように変更
457         * @og.rev 5.5.1.0 (2012/04/03) エラーメッセージ変更
458         * @og.rev 6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え。
459         * @og.rev 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
460         *
461         * @param   flag TDタグ使用 [yes:tdタグを使用/no:ラベルとフィールド/false:フィールドのみ]
462         */
463        public void setTd( final String flag ) {
464                final String td = nval( getRequestParameter( flag ),tdFlag );
465
466                if( check( td , TD_SET ) ) {
467                        tdFlag = td;
468                }
469                else {
470                        final String errMsg = "Error in SelectTag [td]: "
471                                                 + td + "  in [" + String.join( ", " , TD_SET ) + "] only used.";
472                        throw new HybsSystemException( errMsg );
473                }
474        }
475
476        /**
477         * 【TAG】フィールド部分の colspan を指定します。
478         *
479         * @og.tag
480         * 通常は、ラベルとフィールドが、別のtdで囲われます。しかし、場合によっては、
481         * フィールド部の長いカラムがある場合、上下のカラムとの位置関係がおかしくなり、
482         * ラベルとフィールドが離れて表示されるケースがあります。
483         * この場合、長いフィールド部を持つカラムに、colspan 属性を指定すると、
484         * その分のカラムを割り当てることにより、上下のカラムとの位置関係を
485         * 調節することが可能になります。
486         * 通常は、3 を指定して、tdが、フィールド、ラベル、フィールドの
487         * 組み合わせ部分に、長いフィールドが適用されるように使用します。
488         *
489         *  &lt;og:select name="CDK" colspan="3" /&gt;
490         *
491         * @og.rev 3.0.1.3 (2003/03/11) colspan 属性を追加。
492         *
493         * @param   sp フィールド部分のcolspan
494         */
495        public void setColspan( final String sp ) {
496                colspan = nval( getRequestParameter( sp ),colspan );
497                // 6.1.0.0 (2014/12/26) refactoring
498                if( colspan.length() > 0 ) {
499                        colspan = " colspan=\"" + colspan + "\" ";
500                }
501        }
502
503        /**
504         * 【TAG】ラベル、フィールド共に rowspan を指定します。
505         *
506         * @og.tag
507         * 通常は、ラベルとフィールドが、別のtdで囲われます。rowspan は、
508         * そのどちらの TDフィールドにも、設定します。
509         * 初期値は、rowspan を付けないです。
510         *
511         *  &lt;og:select name="CDK" rowspan="3" /&gt;
512         *
513         * @og.rev 6.2.0.0 (2015/02/27) rowspan 属性を追加
514         *
515         * @param   sp ラベル、フィールド部分のrowspan
516         */
517        public void setRowspan( final String sp ) {
518                rowspan = nval( getRequestParameter( sp ),rowspan );
519                if( rowspan.length() > 0 ) {
520                        rowspan = " rowspan=\"" + rowspan + "\" ";
521                }
522        }
523
524        /**
525         * 【TAG】値を指定します。
526         *
527         * @og.tag
528         *   ここで指定された値が、optionタグの値と同じであれば、選択状態になります。
529         *
530         *    &lt;og:select name="CDC" value="{&#064;ABC}" defaultVal="XYZ"  &gt;
531         *         &lt;og:option value="ABC" lbl="CDC1" /&gt;
532         *         &lt;og:option value="XYZ" lbl="CDC2" /&gt;
533         *    &lt;/og:select&gt;
534         *
535         * @og.rev 3.5.4.0 (2003/11/25) 新規作成
536         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
537         *
538         * @param   val 値
539         */
540        public void setValue( final String val ) {
541                value = nval( StringUtil.array2line( getRequestParameterValues( val ), "|" ),value );
542        }
543
544        /**
545         * 値を外部から取り出します。
546         *
547         * OptionTag で、value を取り出して、内部の値と同じ場合は、選択状態にします。
548         *
549         * @og.rev 3.5.4.0 (2003/11/25) 新規作成
550         * @og.rev 5.7.1.0 (2013/12/06) OptionAncestorIF にする為、protected ⇒ public 化する。
551         *
552         * @return      内部に設定された値
553         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#getValue()
554         */
555        public String getValue() {
556                return value;
557        }
558
559        /**
560         * 【TAG】イベントカラム(親カラム)を設定します。
561         *
562         * @og.tag
563         *   親子関係のカラムを作成する場合に利用します。
564         *   queryOptionタグとセットで利用して下さい。
565         *
566         *   ※詳細はcolumnTagのeventColumn属性の説明をご覧下さい。
567         *
568         * @og.rev 4.3.6.0 (2009/04/01)
569         *
570         * @param   col 親カラム名
571         */
572        public void setEventColumn( final String col ) {
573                eventColumn = nval( getRequestParameter( col ), eventColumn );
574        }
575
576        /**
577         * 【TAG】eventColumn使用時の値を、SQL文から求めるためのqueryをセットします。
578         *
579         * @og.tag
580         * eventColumn利用時は{&#064;XXXX}はリクエストパラメータではなく
581         * xxxカラムの実際の値が利用されます。
582         *
583         * @og.rev 6.3.4.0 (2015/08/01) eventValue 追加
584         * @param       val     パラメータ
585         */
586        public void setEventValue( final String val ) {
587                eventValue = nval( getReservedParameter( val ), eventValue );   // ここでは{@XXXX}変換をしない
588        }
589
590        /**
591         * 【TAG】イベントカラム指定時に呼び出すURLを指定します。
592         *
593         * @og.tag
594         *   イベントカラム指定時に部品を作成するJSPを指定します。
595         *   初期値はシステムリソースのEVENT_COLUMN_URLです。
596         *   (例:eventURL="makeColumn_custom.jsp")
597         *
598         *   ※詳細はcolumnTagのeventURL属性の説明をご覧下さい。
599         *
600         * @og.rev 4.3.6.0 (2009/04/01)
601         *
602         * @param       url     呼び出すURL
603         */
604        public void setEventURL( final String url ) {
605                eventURL = nval( getRequestParameter( url ), eventURL );
606        }
607
608        /**
609         * 複数選択可能時に全選択を設定するかどうかを返します。
610         *
611         * これは、上位入れ子のタグの OptionTag で、multipleAll を取り出して、
612         * true であれば、全選択に設定します。
613         *
614         * @og.rev 3.8.0.9 (2005/10/17) 新規作成
615         * @og.rev 5.7.1.0 (2013/12/06) OptionAncestorIF にする為、protected ⇒ public 化する。
616         *
617         * @return      全選択:true / 通常:false
618         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#isMultipleAll()
619         */
620        public boolean isMultipleAll() {
621                return multipleAll;
622        }
623
624        /**
625         * 【TAG】value属性に値がセットされていないとき使用する、初期値を指定します。
626         *
627         * @og.tag
628         * value属性に値がセットされていないときに、この初期値を使用します。
629         *
630         * なお、commandがRENEWの場合は、このdefaultValは適用されません。
631         * これは、defaultValの値が埋め込まれた項目が存在する画面に戻った際に、
632         * defaultValの項目の値がnullとなっていた場合に、defaultValの値が復元されると、
633         * 検索結果との不一致が発生するためです。
634         *
635         * @og.rev 3.5.4.0 (2003/11/25) 新規作成
636         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
637         *
638         * @param       dv 初期値
639         */
640        public void setDefaultVal( final String dv ) {
641                defaultVal = nval( StringUtil.array2line( getRequestParameterValues( dv ), "|" ),defaultVal );
642        }
643
644        /**
645         * 【TAG】値なしのOptionを含めるかどうか[true/false]を指定します(初期値:false)。
646         *
647         * @og.tag
648         * カラムがプルダウンメニュー形式の場合、選択肢には通常データベース登録できる候補が
649         * 並びます。しかし、検索時には、候補を絞りたくない(指定しない)場合があり、
650         * その様な場合には、値なしのOptionを含める(true)ことで、対応可能です。
651         * 初期値:false(値なしのOptionを含めない)は、過去の互換性を重視しているため、column タグと異なります。
652         *
653         * @og.rev 5.1.9.0 (2010/08/01) 新規追加
654         *
655         * @param       flag  値なしのOptionの有無 [true:含める/それ以外:含めない]
656         */
657        public void setAddNoValue( final String flag ) {
658                addNoValue = nval( getRequestParameter( flag ),addNoValue );
659        }
660
661        /**
662         * 【TAG】セレクトメニューの場合、キー:ラベル形式で表示するかどうか[true/false/null]を指定します(初期値:null)。
663         *
664         * @og.tag
665         * カラムがプルダウンメニュー形式の場合、キー:ラベル形式で表示するか、ラベルだけで表示するかを
666         * 選択できます。
667         * true を指定すると、「強制的に」キー:ラベル形式で表示します。
668         * false の場合は、「強制的に」ラベルのみで表示されます。
669         * 初期値の null の場合、コードリソースや、SQL文に準拠した指定通りの形式で表示します。
670         *
671         * &lt;og:column name="CDC" addKeyLabel="true" /&gt;
672         *
673         * @og.rev 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか。新規追加
674         *
675         * @param   flag  キー:ラベル形式表示 [true:キー:ラベル形式/false:ラベルのみ/null:指定通り]
676         */
677        public void setAddKeyLabel( final String flag ) {
678                addKeyLabel = nval( getRequestParameter( flag ),addKeyLabel );
679        }
680
681        /**
682         * セレクトメニューの場合、キー:ラベル形式で表示するかどうか[true/false/null]を返します。
683         *
684         * これは、上位入れ子のタグの OptionTag で、addKeyLabel を取り出して、
685         * true であれば、キー:ラベル形式 のオプションを、#addOption( String ) で
686         * 登録させます。
687         *
688         * @og.rev 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか。新規追加
689         *
690         * @return      true:キー:ラベル形式/false:ラベルのみ/null:指定通り
691         * @see         #addOption( String )
692         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#getAddKeyLabel()
693         */
694        public String getAddKeyLabel() {
695                return addKeyLabel;
696        }
697
698        /**
699         * パラメーター変換({&#064;XXXX}の置き換えをしない状態のパラメーターをセットします。
700         *
701         * @og.rev 5.1.7.0 (2010/06/01) 新規作成(動的プルダウン実装見直し)
702         * @og.rev 5.5.4.0 (2012/07/02) 予約語対応
703         *
704         * @param   param パラメーター
705         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#setRawParam( String )
706         */
707        public void setRawParam( final String param ) {
708                rawParam = nval( getReservedParameter(param), rawParam ); // 5.5.4.0 (2012/07/02)
709        }
710
711        /**
712         * 【TAG】eventColumn実行後のcallbak関数を指定します。
713         *
714         * @og.tag
715         * eventColumnの動作終了後に実行するCallback関数の指定を行います。
716         * 関数名のみを指定して下さい。
717         *  ex) sampleCallback()を実行する場合はeventCallback="sampleCallback"
718         * 実行する関数の第一引数には自動的に次の要素が入った配列が渡されます
719         *  [0] 変更された子カラムのID属性値
720         *  [1] evnetColumn実行後の子カラムの値
721         *  [2] eventColumn実行前の子カラムの値
722         *
723         * この属性は、optionAttributesへの設定と同様の動作を行います。
724         *
725         * @og.rev 5.5.4.0 (2012/07/02) 新規追加
726         * @og.rev 6.9.8.0 (2018/05/28) パラメータ引数が、未設定の場合の考慮不足
727         *
728         * @param   callback callbak関数
729         */
730        public void setEventCallback( final String callback ) {
731                // optionAttributes扱いで登録します。
732                final String clbk = getRequestParameter( callback );
733                if( StringUtil.isNotNull( clbk ) ){
734                        add( "optionAttributes", "eventCallback='" + clbk + "'" );
735                }
736
737//              // optionAttributes扱いで登録します。
738//              if( callback != null && callback.length() > 0 ){
739//                      add( "optionAttributes", "eventCallback='"+getRequestParameter( callback )+"'" );
740//              }
741        }
742
743        /**
744         * 【TAG】リアルタイムチェックを行うかどうかを指定します(初期値:true)。
745         *
746         * @og.tag
747         * カラム単位でリアルタイムチェックを行うかどうかを設定をします。
748         * タグに独自属性としてrealTimeCheck="true/false"を追記します。
749         * falseを設定した場合にチェックが行われなくなります。
750         * 初期値はリアルタイムチェックを行う(true)です。
751         * 
752         * この属性は、optionAttributesへの設定と同様の動作を行います。
753         * 引数の文字列の、true/false 判定を行っていません。そのままの文字列が設定されます。
754         * JavaScript 側では、false 判定のみ行っているので、不正な文字列の場合は、
755         * 初期値(true:リアルタイムチェックを行う)が適用されます。
756         * これは、Ver5 とロジックを合わせておくための処置です。
757         *
758         * @og.rev 5.9.32.2 (2018/05/18) 新規追加
759         * @og.rev 6.9.8.0 (2018/05/28) Ver5 とロジックを合わせます。
760         *
761         * @param   flag リアルタイムチェックを行うかどうか [true:行う/false:行わない]
762         */
763        public void setUseRealTimeCheck( final String flag ) {
764                // optionAttributes扱いで登録します。
765                final String rtcf = getRequestParameter( flag );
766
767                if( StringUtil.isNotNull( rtcf ) ){
768                        add( "optionAttributes", "realTimeChk=\"" + rtcf + "\"" );                      // 連結時のスペースは、Attributes クラスで処理
769                }
770
771//              // optionAttributes扱いで登録します。
772//              final boolean useRtc = nval( getRequestParameter( flag ) , true );
773//
774//              if( !useRtc ) {         // true 以外の場合のみ、optionAttributes に属性を追加します。
775//                      add( "optionAttributes", "realTimeChk=\"false\"" );                     // 連結時のスペースは、Attributes クラスで処理
776//              }
777        }
778
779        /**
780         * シリアライズ用のカスタムシリアライズ読み込みメソッド
781         *
782         * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。
783         *
784         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
785         * @serialData 一部のオブジェクトは、シリアライズされません。
786         *
787         * @param       strm    ObjectInputStreamオブジェクト
788         * @see #release2()
789         * @throws IOException  シリアライズに関する入出力エラーが発生した場合
790         * @throws ClassNotFoundException       クラスを見つけることができなかった場合
791         */
792        private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException {
793                strm.defaultReadObject();
794                option = new Options();
795        }
796
797        /**
798         * このオブジェクトの文字列表現を返します。
799         * 基本的にデバッグ目的に使用します。
800         *
801         * @return このクラスの文字列表現
802         * @og.rtnNotNull
803         */
804        @Override
805        public String toString() {
806                return ToString.title( this.getClass().getName() )
807                                .println( "VERSION"             ,VERSION                )
808                                .println( "tdFlag"              ,tdFlag         )
809                                .println( "colspan"             ,colspan                )
810                                .println( "rowspan"             ,rowspan                )
811                                .println( "value"               ,value                  )
812                                .println( "defaultVal"  ,defaultVal             )
813                                .println( "multipleAll" ,multipleAll    )
814                                .println( "Other..."    ,getAttributes().getAttribute() )
815                                .fixForm().toString() ;
816        }
817}