Ver8.5.2.0

[opengion/opengionV8.git] / uap / webapps / gf / src / org / opengion / hayabusa / taglib / DatalistTag.java

/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.hayabusa.taglib;

import org.opengion.fukurou.system.OgRuntimeException;                                                  // 6.4.2.0 (2016/01/29)
import static org.opengion.fukurou.util.StringUtil.nval;

import java.io.IOException;
import java.io.ObjectInputStream;

import org.opengion.fukurou.util.Options;
//import org.opengion.hayabusa.common.HybsSystem;                                                               // 8.5.2.0 (2023/07/14) Delete
import org.opengion.fukurou.util.ToString;                                                                              // 6.1.1.0 (2015/01/17)

/**
 * ﾌｫｰﾑの入力欄などで入力候補となるﾃﾞｰﾀﾘｽﾄを定義するHTML拡張ﾀｸﾞです。
 * HTML5 から、新たに追加された要素です。
 *
 * ﾃﾞｰﾀﾘｽﾄ内の選択肢は、optionﾀｸﾞ、queryOptionﾀｸﾞによって指定します。
 * ﾃﾞｰﾀﾘｽﾄ の id 属性は、ﾌｫｰﾑの list 属性と同じｷｰを指定する事で関連付けします。
 *
 * @og.formSample
 * ●形式：<og:datalist id="…" />
 * ●body：あり(EVAL_BODY_INCLUDE:BODYをｲﾝｸﾙｰﾄﾞし、{@XXXX} は解析しません)
 *
 * ●Tag定義：
 *   <og:datalist
 *       id               ○【TAG】入力候補を表示するﾌｫｰﾑの list 属性に設定する id (必須)
 *       caseKey            【TAG】このﾀｸﾞ自体を利用するかどうかの条件ｷｰを指定します(初期値:null)
 *       caseVal            【TAG】このﾀｸﾞ自体を利用するかどうかの条件値を指定します(初期値:null)
 *       caseNN             【TAG】指定の値が、null/ｾﾞﾛ文字列 でない場合(Not Null=NN)は、このﾀｸﾞは使用されます(初期値:判定しない)
 *       caseNull           【TAG】指定の値が、null/ｾﾞﾛ文字列 の場合は、このﾀｸﾞは使用されます(初期値:判定しない)
 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このﾀｸﾞは使用されます(初期値:判定しない)
 *       debug              【TAG】ﾃﾞﾊﾞｯｸﾞ情報を出力するかどうか[true/false]を指定します(初期値:false)
 *   >   ... Body ...
 *   </og:datalist>
 *
 * ●使用例
 * <og:input type="text" name="tokyo" autocomplete="on" list="tokyo.sel" />
 *
 *  <og:datalist id="tokyo.sel" >
 *      <og:option value="渋谷" />
 *      <og:option value="新宿" />
 *      <og:option value="池袋" />
 *  </og:datalist>
 *
 * ただし、値なしのOptionを含めても(addNoValue="true")、HTML5の仕様上、
 * 値なしのOptionは表示されません。
 *
 * @og.group 【HTML5】選択ﾃﾞｰﾀ制御
 * @og.rev 5.7.1.0 (2013/12/06) 新規追加
 *
 * @version     6.0
 * @author      Kazuhiko Hasegawa
 * @since       JDK5.0,
 */
public class DatalistTag extends CommonTagSupport implements OptionAncestorIF {
        /** このﾌﾟﾛｸﾞﾗﾑのVERSION文字列を設定します。 {@value} */
        private static final String VERSION = "8.5.2.0 (2023/07/14)" ;
        private static final long serialVersionUID = 852020230714L ;

        private transient Options option        = new Options();
        /** ﾌｫｰﾑと関連付けるid */
        private String id;

        /**
         * ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
         *
         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
         */
        public DatalistTag() { super(); }               // これも、自動的に呼ばれるが、空のﾒｿｯﾄﾞを作成すると警告されるので、明示的にしておきます。

        /**
         * Taglibの開始ﾀｸﾞが見つかったときに処理する doStartTag() を ｵｰﾊﾞｰﾗｲﾄﾞします。
         *
         * @return      後続処理の指示( EVAL_BODY_INCLUDE )
         */
        @Override
        public int doStartTag() {
                // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method
                return useTag()
                                        ? EVAL_BODY_INCLUDE             // Body ｲﾝｸﾙｰﾄﾞ( extends TagSupport 時)
                                        : SKIP_BODY ;                   // Body を評価しない
        }

        /**
         * Taglibの終了ﾀｸﾞが見つかったときに処理する doEndTag() を ｵｰﾊﾞｰﾗｲﾄﾞします。
         *
         * @og.rev 5.7.6.2 (2014/05/16) IEのHTML5機能が無効の場合、INDBMENU を作成します。
         * @og.rev 6.3.9.0 (2015/11/06) ｺﾝｽﾄﾗｸﾀで初期化されていないﾌｨｰﾙﾄﾞを null ﾁｪｯｸなしで利用している(findbugs)
         * @og.rev 8.5.2.0 (2023/07/14) 一部の機能廃止による修正(問合・ﾄﾗﾌﾞﾙ 0200010980)
         *
         * @return      後続処理
         */
        @Override
        public int doEndTag() {
                debugPrint();                                   // 4.0.0 (2005/02/28)
                // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
                if( useTag() ) {
                        // 6.3.9.0 (2015/11/06) ｺﾝｽﾄﾗｸﾀで初期化されていないﾌｨｰﾙﾄﾞを null ﾁｪｯｸなしで利用している(findbugs)
                        if( id == null ) {
                                final String errMsg = "idは必須です。" ;
                                throw new OgRuntimeException( errMsg );
                        }

                        final StringBuilder rtn = new StringBuilder( BUFFER_MIDDLE );

//                      // 5.7.6.2 (2014/05/16) IEのHTML5機能が無効の場合の処理 8.5.2.0 (2023/07/14) Delete
//                      final String ieHTML5 = (String)getSessionAttribute( HybsSystem.IE_HTML5_KEY );
//                      if( "FALSE".equalsIgnoreCase( ieHTML5 ) ) {
//                              final String inName = id.endsWith( ".sel" ) ? id.substring( 0,id.length()-4 ) : id ;
//
//                              rtn.append("<select id='").append( id )
//                                      .append( "' style='position:absolute;' onChange='selChanged(this);' >" )
//                                      .append( option.getOption() )
//                                      // 8.1.0.0 (2021/12/28) HTML5 準拠に見直し(<script> type属性削除)
////                                    .append( "</select><script type='text/javascript'>makeInputMenu('" )
//                                      .append( "</select><script>makeInputMenu('" )
//                                      .append( inName ).append( "');</script>" );
//                      }
//                      else {
//                              // display:none は、datalist の optionのBODY部が、HTML5 以外では表示されてしまうため。
//                              rtn.append("<div style='display:none;'><datalist id='")
//                                      .append( id ).append( "' >" )
//                                      .append( option.getOption() )
//                                      .append( "</datalist></div>" );
//                      }
                        rtn.append("<datalist id='")
                                .append( id ).append( "' >" )
                                .append( option.getOption() )
                                .append( "</datalist>" );

                        jspPrint( rtn.toString() );
                }
                return EVAL_PAGE ;
        }

        /**
         * ﾀｸﾞﾘﾌﾞｵﾌﾞｼﾞｪｸﾄをﾘﾘｰｽします。
         * ｷｬｯｼｭされて再利用されるので、ﾌｨｰﾙﾄﾞの初期設定を行います。
         *
         */
        @Override
        protected void release2() {
                super.release2();
                option  = new Options();
                id              = null;
        }

        /**
         * ﾃﾞｰﾀﾘｽﾄの選択項目を追加します。
         *
         * datalist ﾀｸﾞのBODY要素の OptionTag よりｱｸｾｽされます。
         *
         * @param       opt     ｵﾌﾟｼｮﾝﾀｸﾞ文字列
         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#addOption( String )
         */
        @Override       // OptionAncestorIF
        public void addOption( final String opt ) {
                option.add( opt );
        }

        /**
         * ﾒﾆｭｰ項目の最後の項目を削除します。
         *
         * select ﾀｸﾞのBODY要素の OptionTag よりｱｸｾｽされます。
         *
         * @og.rev 6.8.0.0 (2017/06/02) ﾒﾆｭｰ項目の最後の項目を削除。
         *
         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#removeLast()
         */
        @Override       // OptionAncestorIF
        public void removeLast() {
                option.removeLast();
        }

        /**
         * 【HTML】要素に対して固有の名前(id)をつける場合に設定します。
         *
         * @og.tag
         * ﾃﾞｰﾀﾘｽﾄ の id 属性は、ﾌｫｰﾑの list 属性と同じｷｰを指定する事で関連付けします。
         *
         * ※
         * 内部事情で、inputﾀｸﾞ(columnﾀｸﾞ)の list属性 に設定するｷｰも、id属性に設定するｷｰも、
         * inputﾀｸﾞ(columnﾀｸﾞ)の name属性＋".sel" を標準的に使用してください。
         *
         * @param       id      固有の名前
         */
        @Override
        public void setId( final String id ) {
                this.id = nval( getRequestParameter( id ), null );
        }

        /**
         * 値を外部から取り出します。
         *
         * OptionTag で、value を取り出して、内部の値と同じ場合は、選択状態にします。
         *
         * @og.rev 5.7.1.0 (2013/12/06) 新規追加
         *
         * @return      null固定
         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#addOption( String )
         */
        @Override       // OptionAncestorIF
        public String getValue() {
                // ここでは、何もしません。
                return null;
        }

        /**
         * 複数選択可能時に全選択を設定するかどうかを返します。
         *
         * これは、上位入れ子のﾀｸﾞの OptionTag で、multipleAll を取り出して、
         * true であれば、全選択に設定します。
         *
         * @og.rev 5.7.1.0 (2013/12/06) 新規追加
         *
         * @return      false固定
         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#addOption( String )
         */
        @Override       // OptionAncestorIF
        public boolean isMultipleAll() {
                // ここでは、何もしません。
                return false;
        }

        /**
         * ﾊﾟﾗﾒｰﾀｰ変換({&#064;XXXX}の置き換えをしない状態のﾊﾟﾗﾒｰﾀｰをｾｯﾄします。
         *
         * ※ ここでは、何もしません。
         *
         * @og.rev 5.7.1.0 (2013/12/06) 新規追加
         *
         * @param       param   ﾊﾟﾗﾒｰﾀｰ
         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#addOption( String )
         */
        @Override       // OptionAncestorIF
        public void setRawParam( final String param ) {
                // ここでは、何もしません。
        }

        /**
         * ｾﾚｸﾄﾒﾆｭｰの場合、ｷｰ:ﾗﾍﾞﾙ形式で表示するかどうか[true/false/null]を返します。
         *
         * これは、上位入れ子のﾀｸﾞの OptionTag で、addKeyLabel を取り出して、
         * true であれば、ｷｰ:ﾗﾍﾞﾙ形式 のｵﾌﾟｼｮﾝを、#addOption( String ) で
         * 登録させます。
         *
         * @og.rev 6.0.4.0 (2014/11/28) ｷｰ:ﾗﾍﾞﾙ形式で表示するかどうか。新規追加
         *
         * @return      null固定
         * @see         #addOption( String )
         * @see         org.opengion.hayabusa.taglib.OptionAncestorIF#getAddKeyLabel()
         */
        @Override       // OptionAncestorIF
        public String getAddKeyLabel() {
                // ここでは、何もしません。
                return null;
        }

        /**
         * ｼﾘｱﾗｲｽﾞ用のｶｽﾀﾑｼﾘｱﾗｲｽﾞ読み込みﾒｿｯﾄﾞ
         *
         * ここでは、transient 宣言された内部変数の内、初期化が必要なﾌｨｰﾙﾄﾞのみ設定します。
         *
         * @serialData 一部のｵﾌﾞｼﾞｪｸﾄは、ｼﾘｱﾗｲｽﾞされません。
         *
         * @param       strm    ObjectInputStreamｵﾌﾞｼﾞｪｸﾄ
         * @see         #release2()
         * @throws      IOException     ｼﾘｱﾗｲｽﾞに関する入出力ｴﾗｰが発生した場合
         * @throws      ClassNotFoundException  ｸﾗｽを見つけることができなかった場合
         */
        private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException {
                strm.defaultReadObject();
                option = new Options();
        }

        /**
         * このｵﾌﾞｼﾞｪｸﾄの文字列表現を返します。
         * 基本的にﾃﾞﾊﾞｯｸﾞ目的に使用します。
         *
         * @return      このｸﾗｽの文字列表現
         * @og.rtnNotNull
         */
        @Override
        public String toString() {
                return ToString.title( this.getClass().getName() )
                                .println( "VERSION"             ,VERSION                )
                                .println( "id"                  ,id                             )
                                .println( "Other..."    ,getAttributes().getAttribute() )
                                .fixForm().toString() ;
        }
}