    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 * ●形式：&lt;og:option value="…" lbl ="…" selected="…" /&gt;
    032 * ●body：なし
    033 *
    034 * ●Tag定義：
    035 *   &lt;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 *   /&gt;
    056 *
    057 * ●使用例
    058 *     プルダウンで選択する 値(value) に対して ラベル(lbl) を付けられます。
    059 *     &lt;og:select name="ORDER_BY" lbl="ORDER_BY"&gt;
    060 *         &lt;og:option value="SYSTEM_ID,CLM,LANG" lbl ="CLM" selected="selected" /&gt;
    061 *     &lt;/og:select&gt;
    062 *
    063 *     ラベルが複数ある場合は、lbls 属性を使用します。
    064 *     &lt;og:select name="ORDER_BY" lbl="ORDER_BY"&gt;
    065 *         &lt;og:option value="SYSTEM_ID,CLM,LANG" lbls="LANG,NAME_JA" /&gt;
    066 *     &lt;/og:select&gt;
    067 *
    068 *     MessageResource プロパティの値を使用したいとききはlbl属性を使います。
    069 *     &lt;og:select name="CDC"&gt;
    070 *         &lt;og:option lbl="MSG0001" /&gt;
    071 *     &lt;/og:select&gt;
    072 *
    073 *     LabelResource プロパティの値を使用したいとききはlbl属性を使います。
    074 *     &lt;og:select name="CDC"&gt;
    075 *         &lt;og:option lbl="CDC1" /&gt;
    076 *     &lt;/og:select&gt;
    077 *
    078 *     選択肢の中から複数選択できるようにするときはmultiple属性を使います。
    079 *     &lt;og:select name="CDC" multiple="multiple"&gt;
    080 *         &lt;og:option value="AAA" /&gt;
    081 *     &lt;/og:select&gt;
    082 *
    083 *     選択不可にするときはdisabled属性を使います。
    084 *     &lt;og:select name="CDC" disabled="disabled"&gt;
    085 *         &lt;og:option value="AAA" /&gt;
    086 *     &lt;/og:select&gt;
    087 *
    088 *     選択肢をSELECT文の結果から作成したいときはqueryOptionタグと組み合わせて使います。
    089 *     &lt;og:select name="CDC"&gt;
    090 *         &lt;og:queryOption&gt;
    091 *                     select NOSYN,NOSYN,':',NMSYN from DB01 ORDER BY 1
    092 *         &lt;/og:queryOption&gt;
    093 *     &lt;/og:select&gt;
    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//      private String code = null;
    109
    110        // 3.5.4.0 (2003/11/25) selVal 属性を追加。
    111        // 5.7.1.0 (2013/12/06) ローカル変数化します。
    112//      private String selVal = null;
    113//      private boolean multipleAll     = false;        // 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
    114
    115        /**
    116         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    117         *
    118         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    119         * @og.rev 3.5.4.0 (2003/11/25) selVal 属性を追加。
    120         * @og.rev 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
    121         * @og.rev 4.3.0.0 (2008/07/04) ロールモードマルチ対応
    122         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
    123         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
    124         * @og.rev 5.7.1.0 (2013/12/06) findAncestorWithClass 等を、makeTag() に移動したため、メソッド自体が不要になった。
    125         *
    126         * @return      後続処理の指示
    127         */
    128//      @Override
    129//      public int doEndTag() {
    130//              debugPrint();           // 4.0.0 (2005/02/28)
    131//              // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
    132//              if( !useTag() ) { return(EVAL_PAGE); }
    133//
    134//              // 4.0.0 (2005/11/30) 指定のロールが、アクセス許可の場合は、出力します。
    135//              String roles = get( "roles" );
    136////            if( roles != null && ! getUser().isAccess( roles ) ) {
    137////                    return(EVAL_PAGE);
    138////            }
    139//              // 4.3.0.0 (2008/07/04) ロールモードマルチ対応
    140//              if( ! getUser().isAccess( roles ) ) {
    141//                      return(EVAL_PAGE);
    142//              }
    143//
    144//              SelectTag select = (SelectTag)findAncestorWithClass( this,SelectTag.class );
    145//              if( select == null ) {
    146//                      String errMsg = "このタグは、SelectTag のBODY に記述する必要があります。";
    147//                      throw new HybsSystemException( errMsg );
    148//              }
    149////            selVal = select.getValue();                     // 3.5.4.0 (2003/11/25)
    150//              selVal = "|" + select.getValue() + "|"; // 5.0.2.0 (2009/11/01)
    151//              multipleAll     = select.isMultipleAll();       // 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
    152//              select.addOption( makeTag() );
    153//
    154//              return(EVAL_PAGE);
    155//      }
    156
    157        /**
    158         * タグリブオブジェクトをリリースします。
    159         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    160         *
    161         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
    162         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    163         * @og.rev 3.5.4.0 (2003/11/25) selVal 属性を追加。
    164         * @og.rev 5.7.1.0 (2013/12/06) selVal と、multipleAll がローカル変数化したため、メソッド自体が不要になった。
    165         *
    166         */
    167//      @Override
    168//      protected void release2() {
    169//              super.release2();
    170////            code            = null;
    171//              selVal          = null;
    172//              multipleAll     = false;        // 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
    173//      }
    174
    175        /**
    176         * ラベルを作成します。
    177         *
    178         * lbl 属性でセットされた場合は，そちらを優先します。
    179         * セットされていない場合は，value 属性をキーに、
    180         * LabelResource プロパティの値をセットします。
    181         * value 属性に、カンマ(,)で区切られた複数の Label を
    182         * セットできます。
    183         *
    184         * @og.rev 3.5.4.0 (2003/11/25) selVal 属性を追加。
    185         * @og.rev 3.5.5.7 (2004/05/10) DBColumn.getOption( String ) メソッド廃止
    186         * @og.rev 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
    187         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
    188         * @og.rev 5.7.1.0 (2013/12/06) findAncestorWithClass を移動
    189         * @og.rev 5.7.1.0 (2013/12/06) SelectTag ⇒ OptionAncestorIF に変更して、DatalistTag にも対応。
    190         *
    191         * @return  null固定（null を返せば、doEndTag() では、何もしない）
    192         */
    193        @Override
    194        protected String makeTag() {
    195//              if( code != null ) {
    196//                      String val = nval( get( "value" ),selVal );
    197//
    198//                      // 次期バージョンでは、削除したいと思います。
    199//                      String tag = getDBColumn( code ).getEditorValue( val );
    200//                      int st  = tag.indexOf( '>' );
    201//                      int end = tag.lastIndexOf( "</select" );
    202//                      return tag.substring( st+1,end );
    203//              }
    204
    205                // 3.5.4.0 (2003/11/25) selVal 属性を追加。
    206//              if( ( selVal != null && selVal.length() > 0 && selVal.equals( get( "value" ) ) ) || multipleAll ) {
    207                // 5.0.2.0 (2009/11/01)
    208
    209                // 5.7.1.0 (2013/12/06) findAncestorWithClass を doEndTag() から移動
    210//              SelectTag select = (SelectTag)findAncestorWithClass( this,SelectTag.class );
    211                OptionAncestorIF select = (OptionAncestorIF)findAncestorWithClass( this,OptionAncestorIF.class );
    212                if( select == null ) {
    213                        String errMsg = "<b>" + getTagName() + "タグは、SelectTag または、DatalistTag のBODY に記述する必要があります。</b>";
    214                        throw new HybsSystemException( errMsg );
    215                }
    216
    217                String selVal = "|" + select.getValue() + "|";  // 5.0.2.0 (2009/11/01)
    218                boolean multipleAll     = select.isMultipleAll();       // 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
    219                // 5.7.1.0 (2013/12/06) 上位に上げるのではなく、BODY部に出力する。
    220//              select.addOption( makeTag() );
    221
    222                if( ( selVal != null && selVal.length() > 0 && selVal.indexOf( "|" + get( "value" ) + "|" ) >= 0 ) || multipleAll ) {
    223                        set( "selected","selected" );
    224                }
    225
    226                String msglbl = getMsglbl();
    227                if( msglbl != null ) {
    228                        set( "body", msglbl );
    229                }
    230
    231                select.addOption( XHTMLTag.option( getAttributes() ) );
    232
    233                return null;
    234        }
    235
    236        /**
    237         * 【TAG】値を指定します。
    238         *
    239         * @og.tag
    240         * ここで指定した値がプルダウンメニュー中に存在する場合、選択状態になります。
    241         *
    242         * @param   val 値を指定
    243         */
    244        public void setValue( final String val ) {
    245                set( "value",getRequestParameter( val ) );
    246        }
    247
    248        /**
    249         * 【TAG】optionタグのラベルを指定します。
    250         *
    251         * @og.tag
    252         * ここでのラベルは、optionタグのラベルです。(lbl属性は、異なります。)
    253         * これは、optgroup とともに使用される階層化メニュー時に使用されます。
    254         *
    255         * @param   label ラベル
    256         */
    257        public void setLabel( final String label ) {
    258                set( "label",getRequestParameter( label ) );
    259        }
    260
    261        /**
    262         * 【TAG】オプションを選択済みの状態(selected)にセットします(初期値:未選択)。
    263         *
    264         * @og.tag
    265         * selected="selected" または selected="true" 以外の値はセットできないように
    266         * 制限をかけます。
    267         * 初期値は、未選択 です。
    268         *
    269         * @param   sel  [selected:選択済み/それ以外:未選択]
    270         */
    271        public void setSelected( final String sel ) {
    272                String select = getRequestParameter( sel );
    273                if( "selected".equalsIgnoreCase( select ) || "true".equalsIgnoreCase( select ) ) {
    274                        set( "selected","selected" );
    275                }
    276        }
    277
    278//      /**
    279//       * 【廃止】コードリソースのコードID を指定します。
    280//       *
    281//       * @og.tag
    282//       * コードリソースで定義されている内容を再利用します。基本的には、カラムリソースで、
    283//       * コードカラム属性を定義して使用してください。
    284//       *
    285//       * @og.rev 4.0.0.0 (2007/06/18) 廃止
    286//       *
    287//       * @param   code String
    288//       * @deprecated
    289//       */
    290//      @Deprecated public void setCode( final String code ) {
    291//              this.code = getRequestParameter( code ) ;
    292//      }
    293
    294        /**
    295         * 【TAG】ラベルをCSV形式で複数指定します。
    296         *
    297         * @og.tag
    298         * シングルラベルの lbl 属性との違いは,ここではラベルを複数 カンマ区切りで
    299         * 渡すことが可能であることです。これにより、"A,B,C" という値に対して、
    300         * "Aのラベル表示,Bのラベル表示,Cのラベル表示" という具合に文字列を
    301         * 再合成します。
    302         * これは、SQL文のOrdr By 句で、ソート順を指定する場合などに便利です。
    303         * &lt;og:option lbls="MKNMJP,MKCD,MKNMEN" /&gt;
    304         *
    305         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
    306         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
    307         *
    308         * @og.rev 3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得
    309         * @og.rev 5.2.2.0 (2010/11/01) setMsglbl 廃止 ⇒ setLbl に置換え
    310         *
    311         * @param   lbls 複数ラベルID(カンマ区切り)
    312         */
    313        public void setLbls( final String lbls ) {
    314
    315                String[] keys = getCSVParameter( lbls );
    316                if( keys == null || keys.length == 0 ) { return ; }
    317
    318                StringBuilder buf = new StringBuilder( HybsSystem.BUFFER_MIDDLE );
    319                buf.append( getLabel( keys[0] ) );
    320                for( int i=1; i<keys.length; i++ ) {
    321                        buf.append( "," );
    322                        buf.append( getLabel( keys[i] ) );
    323                }
    324//              setMsglbl( buf.toString() );
    325                setLbl( buf.toString() );               // 5.2.2.0 (2010/11/01) setMsglbl 廃止 ⇒ setLbl に置換え
    326        }
    327
    328        /**
    329         * このオブジェクトの文字列表現を返します。
    330         * 基本的にデバッグ目的に使用します。
    331         *
    332         * @og.rev 5.7.1.0 (2013/12/06) selVal と、multipleAll をローカル変数化する。
    333         * @return このクラスの文字列表現
    334         */
    335        @Override
    336        public String toString() {
    337                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
    338                                .println( "VERSION"             ,VERSION        )
    339//                              .println( "code"                ,code           )
    340//                              .println( "selVal"              ,selVal         )
    341//                              .println( "multipleAll" ,multipleAll)
    342                                .println( "Other..."    ,getAttributes().getAttribute() )
    343                                .fixForm().toString() ;
    344        }
    345}