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