    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.hayabusa.resource.GUIInfo;
    021import org.opengion.fukurou.util.XHTMLTag;
    022import org.opengion.fukurou.util.TagBuffer;
    023import org.opengion.fukurou.util.StringUtil ;
    024
    025import static org.opengion.fukurou.util.StringUtil.nval ;
    026import org.opengion.fukurou.util.EnumType ;
    027
    028import java.util.Locale ;
    029
    030/**
    031 * 戻るボタン/戻るリンクを表示するHTML拡張タグです(通常はcustom/query_info.jspに組込み)。
    032 *
    033 * custom/query_info.jsp に組み込むことで、全てのquery.jspに組込む事ができます。
    034 * 戻るボタン/リンクを表示するかどうかの条件判定は、
    035 * 　条件1：自分自身へ戻る機能はサポートできません。
    036 * 　条件2：BACK_GAMENID が存在するか、または、gamenId で指示された場合のみ表示。
    037 * 　条件3：command="NEW" で、キャッシュに設定しておく必要がある。
    038 *
    039 * @og.formSample
    040 * ●形式：&lt;og:backGamen keys="･･･" vals="･･･" &gt; ･･Body･･ &lt;/og:backGamen&gt;
    041 * ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{&#064;XXXX} を解析します)
    042 *
    043 * ●Tag定義：
    044 *   &lt;og:backGamen
    045 *       type               【TAG】ボタンのタイプ[link/button/relLink/relButton/historyBack]を指定します(初期値:link)
    046 *       command            【TAG】(通常は使いません)戻る時に指定する command を設定できます(初期値:RENEW)
    047 *       gamenId            【TAG】(通常は使いません)戻り先の画面をセットします(初期値:BACK_GAMENID)
    048 *       keys               【TAG】リンク先に渡すキーをCSV形式で複数指定します
    049 *       vals               【TAG】keys属性に対応する値をCSV形式で複数指定します
    050 *       lbl                【TAG】ラベルリソースのラベルIDを指定します
    051 *       href               【HTML】リンク先のURLを指定します
    052 *       target             【HTML】リンク先の表示ターゲットを指定します(初期値:CONTENTS)
    053 *       id                 【HTML】要素に対して固有の名前(id)をつける場合に設定します
    054 *       lang               【HTML】要素の内容と他の属性値の言語(lang,xml:lang)を指定します
    055 *       dir                【HTML】文字表記の方向(dir)を指定します
    056 *       title              【HTML】要素に対する補足的情報(title)を設定します
    057 *       style              【HTML】この要素に対して適用させるスタイルシート(style)を設定します
    058 *       tabindex           【HTML】タブの移動順(tabindex)を指定します(0 ～ 32767)
    059 *       accesskey          【HTML】アクセスキー(alt+キーで直接指定)を割り当てます(初期値:R)
    060 *       clazz              【HTML】要素に対して class 属性を設定します
    061 *       language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
    062 *       onClick            【HTML】JavaScriptのイベント onClick を設定します(例:onClick="renew('query.jsp','QUERY');")
    063 *       onBlur             【HTML】JavaScriptのイベント onBlur を設定します(例:onBlur="this.value=value.toUpperCase();")
    064 *       onFocus            【HTML】JavaScriptのイベント onFocus を設定します
    065 *       ondblClick         【HTML】JavaScriptのイベント ondblClick を設定します
    066 *       onMouseDown        【HTML】JavaScriptのイベント onMouseDown を設定します
    067 *       onMouseUp          【HTML】JavaScriptのイベント onMouseUp を設定します
    068 *       onMouseMove        【HTML】JavaScriptのイベント onMouseMove を設定します
    069 *       onMouseOut         【HTML】JavaScriptのイベント onMouseOut を設定します
    070 *       onMouseOver        【HTML】JavaScriptのイベント onMouseOver を設定します
    071 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
    072 *   &gt;   ... Body ...
    073 *   &lt;/og:backGamen&gt;
    074 *
    075 * ●使用例
    076 *   &lt;og:backGamen keys=&quot;displayMsg,clear&quot; vals=&quot;MSG0065,true&quot; &gt;
    077 *       &lt;img src=&quot;{&#064;SYS.JSP}/image/back.gif&quot; alt=&quot;{&#064;BACK_GAMENID}&quot; /&gt;
    078 *       &lt;og:message lbl=&quot;MSG0049&quot; /&gt;
    079 *   &lt;/og:backGamen&gt;
    080 *
    081 * 7.3.1.0 (2021/02/02)
    082 *  リンクタグで、useBackLink 属性を使用することで、戻るﾘﾝｸをある程度制御できます。
    083 *  何も指定しない場合(null)は、従来通りです。
    084 * true：相手先に(条件が成立すれば)戻るﾘﾝｸを表示。条件が成立しない場合は、自身へのリンクが表示。
    085 * false:必ず表示しない
    086 * 未指定(null):従来通り…自分自身では戻るリンクを表示せず、別画面の場合のみ表示します。
    087 *
    088 * @og.rev 3.1.8.0 (2003/05/16) 新規作成
    089 * @og.group 画面制御
    090 *
    091 * @version  4.0
    092 * @author   Kazuhiko Hasegawa
    093 * @since    JDK5.0,
    094 */
    095public class BackGamenTag extends HTMLTagSupport {
    096        /** このプログラムのVERSION文字列を設定します。   {@value} */
    097        private static final String VERSION = "7.3.1.0 (2021/02/02)" ;
    098        private static final long serialVersionUID = 731020210202L ;
    099
    100        // 4.0.0 (2005/05/31) JDK5.0 enum 対応
    101        /**
    102         * type 属性として指定できる選択肢を定義します。
    103         */
    104        private static final EnumType<String> CHECK_TYPE =
    105                                new EnumType<>( "ボタンのタイプ","link" )
    106                                        .append( "link"                 ,"戻るリンクを作成します。"                                 )
    107                                        .append( "relLink"              ,"戻るリンク(相対パス)を作成します。"           )
    108                                        .append( "button"               ,"戻るボタンを作成します。"                                 )
    109                                        .append( "relButton"    ,"戻るボタン(相対パス)を作成します。"           )
    110                                        .append( "historyBack"  ,"通常のヒストリバックボタンを作成します。" ) ;
    111
    112        // 6.9.4.1 (2018/04/09) FILEFILTER使用時(紙芝居作成時)に、true になります。
    113        private static final boolean USE_FILEFILTER = "true".equalsIgnoreCase( HybsSystem.sys( "USE_FILEFILTER" ) );    // null時は、false
    114
    115        private String          type            = CHECK_TYPE.getDefault() ;
    116        private String          command         = "RENEW" ;
    117        private String          gamenId         ;
    118        private String          target          = "CONTENTS";
    119        private String          accesskey       = "R";
    120        private String[]        keys            ;
    121        private String[]        vals            ;
    122        private String          body            ;
    123        private String          backAddress     ;                       // 4.0.1.0 (2007/12/18)
    124
    125        /**
    126         * デフォルトコンストラクター
    127         *
    128         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    129         */
    130        public BackGamenTag() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    131
    132        /**
    133         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    134         *
    135         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
    136         */
    137        @Override
    138        public int doStartTag() {
    139                return EVAL_BODY_BUFFERED ;     // Body を評価する。( extends BodyTagSupport 時)
    140        }
    141
    142        /**
    143         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    144         *
    145         * @return      後続処理の指示(SKIP_BODY)
    146         */
    147        @Override
    148        public int doAfterBody() {
    149                body = getBodyString();
    150
    151                return SKIP_BODY ;
    152        }
    153
    154        /**
    155         * タグリブオブジェクトをリリースします。
    156         *
    157         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    158         *
    159         */
    160        @Override
    161        protected void release2() {
    162                super.release2();
    163                type            = CHECK_TYPE.getDefault() ;
    164                command         = "RENEW" ;
    165                gamenId         = null;
    166                target          = "CONTENTS";
    167                accesskey       = "R";
    168                keys            = null;
    169                vals            = null;
    170                body            = null;
    171                backAddress     = null;
    172        }
    173
    174        /**
    175         * 戻るボタン/戻るリンクを作成します。
    176         *
    177         * @og.rev 3.1.8.0 (2003/05/16) BACK_GAMENID のキャッシュの取り出し先を変更する。
    178         * @og.rev 3.5.4.0 (2003/11/25) 履歴(history)オブジェクトのback() メソッドを利用した戻る機能を追加します。
    179         * @og.rev 4.0.1.0 (2007/12/17) BackAddress対応
    180         * @og.rev 5.0.2.0 (2009/11/01) 相対パスでの戻るリンク対応
    181         *
    182         * @return  戻るボタン/戻るリンク
    183         */
    184        @Override
    185        protected String makeTag() {
    186                String rtn = "" ;
    187
    188                if( gamenId == null ) {
    189                        gamenId = getBackGamenId() ;
    190                }
    191                if( backAddress == null) { // 4.0.1.0 (2007/12/17)
    192                        backAddress = getBackAddress();
    193                }
    194
    195                // 4.0.0 (2005/05/31)
    196                if( "historyBack".equalsIgnoreCase( type ) ) {
    197                        final String hb = getRequest().getParameter( "historyBack" );
    198                        if( "1".equals( hb ) ) {
    199                                rtn = makeHistoryBackTag();
    200                        }
    201                }
    202                else {
    203                        if( checkCondition( gamenId ) ) {
    204                                set( "target" ,nval( get( "target" ), target ) );
    205
    206                                // 5.0.2.0 (2009/11/01) 相対パスでの戻る対応
    207                                if( "link".equalsIgnoreCase( type ) || "relLink".equalsIgnoreCase( type ) ) {
    208                                        rtn = makeLinkTag();
    209                                }
    210                                else if( "button".equalsIgnoreCase( type ) || "relButton".equalsIgnoreCase( type ) ) {
    211                                        rtn = makeButtonTag();  // 3.8.1.2 (2005/12/19)
    212                                }
    213                                else {
    214                                        final String errMsg = "指定の type は、下記の範囲で指定してください。"
    215                                                                        + "type=" + type + " : "
    216                                                                        + CHECK_TYPE.toString();
    217                                        throw new HybsSystemException( errMsg );
    218                                }
    219                        }
    220                }
    221
    222                return rtn ;
    223        }
    224
    225        /**
    226         * 戻るリンクを作成します。
    227         *
    228         * @og.rev 3.5.5.0 (2004/03/12) 戻るアドレスを、GUIInfoより取得するように変更。
    229         * @og.rev 4.0.0.0 (2005/01/31) GUIInfoの実アドレスのパラメータを考慮する。
    230         * @og.rev 3.7.0.3 (2005/03/01) 戻る行番号を、BACK_ROW_KEYより取得し、SEL_ROW で渡す。
    231         * @og.rev 4.0.1.0 (2007/12/17) 戻るアドレスをbackAddressを使うように変更
    232         * @og.rev 4.0.2.1 (2007/12/27) リクエスト部からGAMENIDを外していたが、二段階戻る場合に不具合が出たため元に戻す
    233         * @og.rev 5.0.2.0 (2009/11/01) 相対パスでの戻るリンク対応
    234         * @og.rev 6.9.4.1 (2018/04/09) FILEFILTER使用時(紙芝居作成時)は、相対ﾘﾝｸを出力するようにします。
    235         *
    236         * @return  戻るリンク
    237         * @og.rtnNotNull
    238         */
    239        private String makeLinkTag() {
    240                set( "body",getMsglbl( gamenId ) );
    241                String href = get( "href" );
    242                if( href == null) {
    243                        // 3.5.5.0 (2004/03/12)
    244                        // 5.0.2.0 (2009/11/01) 相対パスでの戻る対応
    245//                      if( backAddress == null || "relLink".equalsIgnoreCase( type ) ) {                                       // 4.0.1.0 (2007/12/17) if文追加
    246                        if( backAddress == null || "relLink".equalsIgnoreCase( type ) || USE_FILEFILTER ) {     // 6.9.4.1 (2018/04/09) FILEFILTER使用時は、相対ﾘﾝｸを出力
    247                                final GUIInfo guiInfo = getGUIInfo( gamenId );                                                                  // 4.0.0 (2005/01/31)
    248                                if( guiInfo == null ) { return ""; } // 見つからない場合は、アクセス不可
    249                                final String address = guiInfo.getRealAddress( "index.jsp" );
    250                                href = getRequestParameter( address );
    251                        }
    252                        else { // 4.0.1.0 (2007/12/17)
    253                                href = backAddress;
    254                        }
    255                }
    256
    257                // 3.7.0.3 (2005/03/01) 戻る行番号を、BACK_ROW_KEYより取得し、SEL_ROW で渡す。
    258                final String rowkey = HybsSystem.BACK_ROW_KEY + getGUIInfoAttri( "KEY" );
    259                final String rowVal = (String)getSessionAttribute( rowkey );
    260
    261                final String[] keys2 = new String[] { "command","GAMENID","SEL_ROW" };
    262                final String[] vals2 = new String[] {  command , gamenId , rowVal   };
    263                final String urlEnc2 = XHTMLTag.urlEncode( keys2,vals2 );
    264                href = XHTMLTag.addUrlEncode( href,urlEnc2 );
    265
    266                final String urlEnc = XHTMLTag.urlEncode( keys,vals );
    267                href = XHTMLTag.addUrlEncode( href,urlEnc );
    268
    269                set( "href",href );
    270
    271                return XHTMLTag.link( getAttributes() ) ;
    272        }
    273
    274        /**
    275         * 戻るボタンのフォームを作成します。
    276         *
    277         * @og.rev 3.5.5.0 (2004/03/12) 戻るアドレスを、GUIInfoより取得するように変更。
    278         * @og.rev 3.5.5.5 (2004/04/23) hidden の出力に、XHTMLTag.hidden を使用します。
    279         * @og.rev 3.8.1.2 (2005/12/19) メソッド名変更、inputタグ⇒buttonタグ変更
    280         * @og.rev 4.0.1.0 (2007/12/17) BACK_ADDRESS対応
    281         * @og.rev 5.0.2.0 (2009/11/01) 相対パスでの戻るリンク対応
    282         * @og.rev 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
    283         * @og.rev 6.9.4.1 (2018/04/09) FILEFILTER使用時(紙芝居作成時)は、相対ﾘﾝｸを出力するようにします。
    284         *
    285         * @return  戻るボタンのフォーム
    286         * @og.rtnNotNull
    287         */
    288        private String makeButtonTag() {
    289
    290                final String href = get( "href" );
    291                if( href == null ) {
    292                        // 3.5.5.0 (2004/03/12)
    293                        // 5.0.2.0 (2009/11/01) 相対パスでの戻る対応
    294//                      if( backAddress == null || "relButton".equalsIgnoreCase( type ) ) { // 4.0.1.0 (2007/12/18) if文化
    295                        if( backAddress == null || "relButton".equalsIgnoreCase( type ) || USE_FILEFILTER ) {   // 6.9.4.1 (2018/04/09) FILEFILTER使用時は、相対ﾘﾝｸを出力
    296                                final GUIInfo guiInfo = getGUIInfo( gamenId );
    297                                final String address = guiInfo.getRealAddress();
    298                                set( "action", address + "index.jsp" );
    299                        }
    300                        else {
    301                                set( "action", backAddress ); // 4.0.1.0 (2007/12/18)
    302                        }
    303                }
    304                else {
    305                        set( "action",href ) ;
    306                }
    307
    308                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    309                final String tag = new TagBuffer( "button" )
    310                                                        .add( "type"            ,"submit" )
    311                                                        .add( "accesskey"       ,get( "accesskey" ) )
    312                                                        .addBody( getMsglbl( gamenId ) )
    313                                                        .makeTag();
    314
    315                final StringBuilder body = new StringBuilder( BUFFER_MIDDLE )
    316                        .append( tag )                                                                          // 6.1.1.0 (2015/01/17)
    317                        .append( CR )
    318                        // command を hidden で作成します。
    319                        .append( XHTMLTag.hidden( "command",command ) )         // hidden(name,value);
    320                        .append( CR )
    321                        // GAMENID を hidden で作成します。
    322                        .append( XHTMLTag.hidden( "GAMENID",gamenId ) )         // hidden(name,value);
    323                        .append( CR );
    324
    325                // keys,vals を hidden で作成します。
    326                // 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
    327                if( keys != null && vals != null ) {
    328                        if( keys.length != vals.length ) {
    329                                final String errMsg = "キーとバリューの個数が異なります。"
    330                                                        + CR
    331                                                        + " keys.length=[" + keys.length + "]  vals.length=[" + vals.length + "]"
    332                                                        + " keys=" + StringUtil.array2csv( keys ) + CR
    333                                                        + " vals=" + StringUtil.array2csv( vals )  ;    // 5.1.8.0 (2010/07/01) errMsg 修正
    334                                throw new HybsSystemException( errMsg );
    335                        }
    336
    337                        for( int i=0; i<keys.length; i++ ) {
    338                                body.append( XHTMLTag.hidden( keys[i],vals[i] ) )       // hidden(name,value);
    339                                        .append( CR );
    340                        }
    341                }
    342
    343                // 3.7.0.3 (2005/03/01) 戻る行番号を、BACK_ROW_KEYより取得し、SEL_ROW で渡す。
    344                final String rowkey = HybsSystem.BACK_ROW_KEY + getGUIInfo( "GUI.KEY" );
    345                final String rowVal = (String)getSessionAttribute( rowkey );
    346                // 3.7.0.5 (2005/04/11) null の時は、返さないように変更
    347                if( rowVal != null ) {
    348                        body.append( XHTMLTag.hidden( "SEL_ROW",rowVal ) )      // hidden(name,value);
    349                                .append( CR );
    350                }
    351
    352                set( "body",body.toString() );
    353
    354                return XHTMLTag.form( getAttributes() ) ;
    355        }
    356
    357        /**
    358         * 戻るリンク(historyBack)を作成します。
    359         *
    360         * @og.rev 3.5.4.0 (2003/11/25) 履歴(history)オブジェクトのback() メソッドを利用した戻る機能を追加します。
    361         *
    362         * @return  戻るリンク
    363         * @og.rtnNotNull
    364         */
    365        private String makeHistoryBackTag() {
    366                final StringBuilder link = new StringBuilder( BUFFER_MIDDLE )
    367                        .append( "<a onClick=\"history.back()\">" )
    368                        .append( getMsglbl( gamenId ) )
    369                        .append( "</a>" );
    370
    371                return link.toString() ;
    372        }
    373
    374        /**
    375         * BACK_GAMENID の値を取り出します。
    376         *
    377         * 値は、キャッシュではなく、session より HybsSystem.BACK_GAMENID_KEY をキーに
    378         * 取り出します。
    379         *
    380         * @og.rev 3.1.8.0 (2003/05/16) BACK_GAMENID のキャッシュの取り出し先を変更する。
    381         *
    382         * @return  BACK_GAMENID の値
    383         */
    384        private String getBackGamenId() {
    385                final String key = HybsSystem.BACK_GAMENID_KEY + getGUIInfoAttri( "KEY" );      // 4.0.0 (2005/01/31)
    386                return (String)getSessionAttribute( key );
    387        }
    388
    389        /**
    390         * BACK_ADDRESS の値を取り出します。
    391         *
    392         * 値は、キャッシュではなく、session より HybsSystem.BACK_ADDRESS_KEY をキーに
    393         * 取り出します。
    394         *
    395         * @og.rev 4.0.1.0 (2007/12/17) メソッド追加
    396         *
    397         * @return  BACK_GAMENID の値
    398         */
    399        private String getBackAddress() {
    400                final String key = HybsSystem.BACK_ADDRESS_KEY + getGUIInfoAttri( "KEY" );      // 4.0.0 (2005/01/31)
    401
    402                return (String)getSessionAttribute( key );
    403        }
    404
    405        /**
    406         * 【TAG】ボタンのタイプ[link/button/relLink/relButton/historyBack]を指定します(初期値:link)。
    407         *
    408         * @og.tag
    409         * button と設定すると、戻るボタンに、link と設定すると、戻るリンクになります。
    410         * historyBack は、IE等の戻る操作と同じで、JavaScriptのヒストリーバックを行います。
    411         * また、relButton、relLinkとすると、それぞれ相対パス(画面IDから飛び先のアドレスを元に生成)
    412         * で戻り先のアドレスが生成されます。
    413         * 初期値は、戻るリンク(link)です。
    414         * ※ 6.9.4.1 (2018/04/09) FILEFILTER使用時(紙芝居作成時)は、相対ﾘﾝｸを出力します。
    415         *
    416         * <table class="plain">
    417         *   <caption>ボタンのタイプ説明</caption>
    418         *   <tr><th>タイプ                </th><th>説明                                             </th></tr>
    419         *   <tr><td>link               </td><td>戻るリンク                                  </td></tr>
    420         *   <tr><td>button             </td><td>戻るボタン                                  </td></tr>
    421         *   <tr><td>relLink    </td><td>戻るリンク(相対パス)            </td></tr>
    422         *   <tr><td>relButton  </td><td>戻るボタン(相対パス)            </td></tr>
    423         *   <tr><td>historyBack</td><td>通常のヒストリバックボタン  </td></tr>
    424         * </table>
    425         *
    426         * @og.rev 5.0.2.0 (2009/11/01) 相対パスでの戻るリンク対応
    427         *
    428         * @param   tp ボタンのタイプ [link/button/relLink/relButton/historyBack]
    429         */
    430        public void setType( final String tp ) {
    431                type = CHECK_TYPE.nval( tp );
    432        }
    433
    434        /**
    435         * 【TAG】(通常は使いません)戻る時に指定する command を設定できます(初期値:RENEW)。
    436         *
    437         * @og.tag
    438         * 通常は、RENEW で戻ります。
    439         * (初期値は、RENEW なので設定不要です。)
    440         *
    441         * @param       cmd コマンド
    442         */
    443        public void setCommand( final String cmd ) {
    444                command = nval( getRequestParameter( cmd ),command );
    445                if( command != null ) { command = command.toUpperCase(Locale.JAPAN); }
    446        }
    447
    448        /**
    449         * 【TAG】(通常は使いません)戻り先の画面をセットします(初期値:BACK_GAMENID)。
    450         *
    451         * @og.tag
    452         * 通常は、自動的に、BACK_GAMENID の値がセットされますが、
    453         * 先祖に戻る(画面Ａ⇒画面Ｂ⇒画面Ｃ のときに、画面Ａに戻る)場合や、
    454         * 別の画面に、進む場合に、直接指定します。
    455         * (初期値は、来た画面：BACK_GAMENID ですので、設定不要です。)
    456         * 値は、キャッシュではなく、session より HybsSystem.BACK_GAMENID_KEY をキーに
    457         * 取り出します。
    458         * これは、command="NEW" で、BACK_GAMENID リクエストが存在し、BACK_GAMENID と
    459         * 自分自身の画面IDが異なる場合のみ、RequestCacheTag#backGamenIdSet メソッドで
    460         * session に登録されます。
    461         *
    462         * @param   id 戻り先の画面ID
    463         */
    464        public void setGamenId( final String id ) {
    465                gamenId = nval( getRequestParameter( id ),gamenId );
    466        }
    467
    468        /**
    469         * 【TAG】リンク先に渡すキーをCSV形式で複数指定します。
    470         *
    471         * @og.tag
    472         * 戻る時に、検索時のキャッシュに指定した引数以外に指定したり、別の値に置き換えたり
    473         * する場合のキーを設定できます。CSV形式で複数指定できます。
    474         * vals 属性には、キーに対応する値を、設定してください。
    475         * 例:<b>keys="displayMsg,clear"</b> vals="MSG0065,true"
    476         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
    477         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
    478         *
    479         * @og.rev 3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用
    480         *
    481         * @param       key リンク先に渡すキー (例：keys="displayMsg,clear")
    482         * @see         #setVals( String )
    483         */
    484        public void setKeys( final String key ) {
    485                keys = getCSVParameter( key );
    486        }
    487
    488        /**
    489         * 【TAG】keys属性に対応する値をCSV形式で複数指定します。
    490         *
    491         * @og.tag
    492         * キーに設定した値を、CSV形式で複数して出来ます。
    493         * 指定順序は、キーと同じにしておいて下さい。
    494         * 例:keys="displayMsg,clear" <b>vals="MSG0065,true"</b>
    495         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
    496         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
    497         *
    498         * @og.rev 3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用
    499         *
    500         * @param       val keys属性に対応する値 (例：vals="MSG0065,true")
    501         * @see         #setKeys( String )
    502         */
    503        public void setVals( final String val ) {
    504                vals = getCSVParameter( val );
    505        }
    506
    507        /**
    508         * 【HTML】リンク先の表示ターゲットを指定します(初期値:CONTENTS)。
    509         *
    510         * @og.tag
    511         * リンク先の文書を表示させるフレーム、またはウィンドウの名前を指定します。
    512         *
    513         * @param       tgt リンク先の表示ターゲット
    514         */
    515        public void setTarget( final String tgt ) {
    516                set( "target",getRequestParameter( tgt ) );
    517        }
    518
    519        /**
    520         * 【HTML】リンク先のURLを指定します。
    521         *
    522         * @og.tag リンク先のURLを指定します。
    523         *
    524         * @param       href リンク先のURL
    525         */
    526        public void setHref( final String href ) {
    527                set( "href",getRequestParameter( href ) );
    528        }
    529
    530        /**
    531         * メッセージラベル(msglbl)をセットします。
    532         *
    533         * メッセージラベルは、meg属性か、lbl属性で登録された値を、
    534         * それぞれのリソースに応じて各言語に変換した結果を格納しています。
    535         * meg属性 と lbl属性は、同時登録できません。
    536         *
    537         * @og.rev 5.7.1.2 (2013/12/20) msg ⇒ msglbl 変更
    538         *
    539         * @param        gamenId 画面ID
    540         *
    541         * @return   メッセージラベル
    542         * @og.rtnNotNull
    543         */
    544        private String getMsglbl( final String gamenId ) {
    545                final StringBuilder rtn = new StringBuilder( BUFFER_MIDDLE );
    546                final String msglbl = getMsglbl();      // 5.7.1.2 (2013/12/20) msg ⇒ msglbl 変更
    547
    548                // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid if (x != y) ..; else ..;
    549                if( msglbl == null ) {
    550                        if( body == null || body.isEmpty() ) {
    551                                final GUIInfo guiInfo = getGUIInfo( gamenId );          // 4.0.0 (2005/01/31)
    552                                if( guiInfo != null ) {
    553                                        rtn.append( guiInfo.getLongName() );
    554                                }
    555                        }
    556                        else {
    557                                rtn.append( body );
    558                        }
    559                }
    560                else {
    561                        rtn.append( msglbl );
    562                        set( "accesskey",nval( get( "accesskey" ),accesskey ) );
    563                        rtn.append( '(' ).append( get( "accesskey" ) ).append( ')' ) ;          // 6.0.2.5 (2014/10/31) char を append する。
    564                }
    565
    566                return rtn.toString() ;
    567        }
    568
    569        /**
    570         * 画面に戻るボタン/リンクを表示するかどうかを条件判定します。
    571         * 引数の gamenId は、BACK_GAMENID の事で、このタグの属性定義で設定されて
    572         * いない場合は、session より、BACK_GAMENID を取り出します。つまり、取り出す為には、
    573         * command="NEW" で、キャッシュに設定しておく必要があります。
    574         *
    575         * 随時、条件を追加していきます。
    576         *
    577         * 条件1：自分自身へ戻る機能はサポートできません。
    578         * 条件2：command="NEW" で、キャッシュに設定しておく必要がある。
    579         *
    580         * @og.rev 3.5.5.0 (2004/03/12) デバッグ情報を出力するように機能追加
    581         * @og.rev 7.3.1.0 (2021/02/02) useBackLink 属性の値を使用する。
    582         *
    583         * @param        gmnId 画面ID(BACK_GAMENID)
    584         *
    585         * @return   判定結果
    586         */
    587        private boolean checkCondition( final String gmnId ) {
    588                // 7.3.1.0 (2021/02/02)
    589                final String useBkLink = getRequest().getParameter( "useBackLink" );
    590                if( "false".equalsIgnoreCase( useBkLink ) ) { return false; }                   // false の場合は無条件でリンクを出さない。
    591
    592                final String thisGamen = getGUIInfoAttri( "KEY" );      // 4.0.0 (2005/01/31)
    593                final boolean rtn = gmnId != null
    594                                                && gmnId.length() > 0
    595                                                && ! gmnId.equals( thisGamen ) ;
    596
    597                // 7.3.1.0 (2021/02/02)
    598                if( !rtn && "true".equalsIgnoreCase( useBkLink ) ) {
    599                        gamenId = thisGamen;                                                    // true の場合は、gamenIdがnullだとリンクが出ない。
    600                        return true;
    601                }
    602
    603                // 3.5.5.0 (2004/03/12)
    604                if( isDebug() ) {
    605                        final String cmd =pageContext.getRequest().getParameter( "command" );
    606
    607                        // 6.0.2.5 (2014/10/31) char を append する。
    608                        final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE )
    609                                .append( getDocumentLink() )            // 4.0.0 (2005/02/28)
    610                                .append( "<pre>" )
    611                                .append( "command  =[" ).append( cmd       ).append( ']' ).append( CR )
    612                                .append( "type     =[" ).append( type      ).append( ']' ).append( CR )
    613                                .append( "gamenId  =[" ).append( gmnId     ).append( ']' ).append( CR )
    614                                .append( "thisGamen=[" ).append( thisGamen ).append( ']' ).append( CR )
    615                                .append( "useBkLink=[" ).append( useBkLink ).append( ']' ).append( CR )                 // 7.3.1.0 (2021/02/02)
    616                                .append( "checkCondition=[" ).append( rtn  ).append( ']' )
    617                                .append( "</pre>" );
    618                        jspPrint( buf.toString() );
    619                }
    620
    621                return rtn ;
    622        }
    623}