    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.fukurou.system.OgBuilder ;                          // 6.4.4.1 (2016/03/18)
    020import org.opengion.fukurou.util.ToString;                                      // 6.1.1.0 (2015/01/17)
    021import org.opengion.fukurou.util.StringUtil ;                           // 6.2.2.0 (2015/03/27)
    022
    023import static org.opengion.fukurou.util.StringUtil.nval;
    024
    025import java.util.concurrent.atomic.AtomicInteger;                       // 5.5.2.6 (2012/05/25) findbugs対応
    026
    027/**
    028 * Query画面の拡張検索領域を指定用のタグです。
    029 *
    030 * 通常は属性を何もセットせずにQuery画面の隠しメニューに利用します。
    031 * queryButtonタグが存在しない場合はボタンを出力したい場所にIDをセットしたspanタグを
    032 * 配置し、そのIDをこのタグのbuttonId属性で指定して下さい。
    033 * タグの動きとしてはにはbody内に書いた内容をbuttonIdで指定した領域に動的に作成した
    034 * ボタン(初期値はシステムパラメータの画像)でON/OFF制御可能とします。
    035 * なお、body部分にはog:firldsetタグも利用可能です。
    036 *
    037 * @og.formSample
    038 * ●形式：
    039 *       ・&lt;og:hideMenu
    040 *                   [ id           = "uniqHideId"   ] タグで囲われた部分に付けるID
    041 *                   [ buttonId     = "targetId"     ] ボタンを出力する場所のIDを指定
    042 *                   [ defaultNone  = "[true|false]" ] 初期状態の開閉指定
    043 *                   [ openButton   = "open.png"     ] 開く(＋)ボタンの画像
    044 *                   [ closeButton  = "close.png"    ] 閉じる(－)ボタンの画像
    045 *                   [ lbl          = "MSG0076"      ] 画像のalt属性に付けるメッセージ(初期値:MSG0076)
    046 *         &gt;
    047 * ●body：あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{&#064;XXXX} は解析しません)
    048 *
    049 * ●Tag定義：
    050 *   &lt;og:hideMenu
    051 *       id                 【TAG】このタグのBODY部分にIDを指定します
    052 *       buttonId           【TAG】画像ボタン出力先のIDを指定します
    053 *       defaultNone        【TAG】初期状態の開閉指定[[true:閉じている/false:開いている]を指定します(初期値:true)
    054 *       openButton         【TAG】開くボタンの画像を指定します(初期値:"jsp/image/" + SystemData#HIDE_OPEN_BUTTON[={@og.value SystemData#HIDE_OPEN_BUTTON}])
    055 *       closeButton        【TAG】閉じるボタンの画像を指定します(初期値:"jsp/image/" + SystemData#HIDE_CLOSE_BUTTON[={@og.value SystemData#HIDE_CLOSE_BUTTON}])
    056 *       lbl                【TAG】ラベルリソースのラベルIDを指定します
    057 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
    058 *   &gt;   ... Body ...
    059 *   &lt;/og:hideMenu&gt;
    060 *
    061 * ●使用例
    062 * 例１:通常のQUERY画面での利用
    063 *         &lt;og:hideMenu&gt;
    064 *           &lt;table&gt;&lt;tr&gt;
    065 *             &lt;og:column name="CLM"/&gt;
    066 *           &lt;/tr&gt;&lt;/table&gt;
    067 *         &lt;/og:hideMenu&gt;
    068 *
    069 * 例２:queryButtonタグが存在しない状況での利用(buttonIdの明示的な指定)
    070 *         &lt;span id="hideButtonSet"&gt; &lt;/span&gt;
    071 *         &lt;og:hideMenu&gt;
    072 *             ......
    073 *         &lt;/og:hideMenu&gt;
    074 *
    075 * @og.rev 4.3.6.0 (2009/04/01) 新規作成
    076 * @og.group 画面部品
    077 *
    078 * @version  4.0
    079 * @author   Takahashi Masakazu
    080 * @since    JDK5.0,
    081 */
    082public class HideMenuTag extends CommonTagSupport {
    083        /** このプログラムのVERSION文字列を設定します。   {@value} */
    084        private static final String VERSION = "7.0.1.0 (2018/10/15)" ;
    085        private static final long serialVersionUID = 701020181015L ;
    086
    087        private static final AtomicInteger UNIQ_ID = new AtomicInteger(1);              // 5.5.2.6 (2012/05/25) findbugs対応              // 6.4.1.1 (2016/01/16) uniqID  → UNIQ_ID  refactoring
    088
    089        private String id                       ;                                                                                       // この領域に付けるid
    090        private String buttonId         = "query-button-append";                                        // ボタンを出力する場所のid
    091        private boolean defaultNone = true;                                                                             // 開閉初期状態
    092
    093        private String openButton       = HybsSystem.sys( "JSP" ) + "/image/" + HybsSystem.sys( "HIDE_OPEN_BUTTON" );           // 開くボタン
    094        private String closeButton      = HybsSystem.sys( "JSP" ) + "/image/" + HybsSystem.sys( "HIDE_CLOSE_BUTTON" );          // 閉じるボタン
    095        private String hideClass        ;               // 5.5.4.4 (2012/07/20)
    096
    097        /**
    098         * デフォルトコンストラクター
    099         *
    100         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    101         */
    102        public HideMenuTag() { super(); }               // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    103
    104        /**
    105         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    106         *
    107         * @og.rev 5.5.2.6 (2012/05/25) findbugs対応。staticフィールドへの書き込みに、AtomicInteger を利用します。
    108         * @og.rev 5.5.3.2 (2012/06/08) 画像にalt属性を追加します。
    109         * @og.rev 5.5.4.4 (2012/07/20) hideClassを外部から指定可能にします
    110         * @og.rev 5.7.1.2 (2013/12/20) msg ⇒ msglbl 変更
    111         * @og.rev 6.0.2.4 (2014/10/17) img タグに、title 属性追記
    112         * @og.rev 6.2.2.0 (2015/03/27) BRと\nを相互に変換する処理を追加
    113         * @og.rev 6.2.2.3 (2015/04/10) htmlフィルターに、BR→改行処理機能を追加。
    114         * @og.rev 5.9.2.1 (2015/11/12) , 6.3.9.0 (2015/11/06) id修正
    115         * @og.rev 6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。
    116         * @og.rev 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"／＞" 止めを、"＞" に変更します)。
    117         *
    118         * @return      後続処理の指示( EVAL_BODY_INCLUDE )
    119         */
    120        @Override
    121        public int doStartTag() {
    122                // 6.3.9.0 (2015/11/06) Variables should start with a lowercase character(PMD)
    123                // IMG を final 化するに当たり、実際に使用する直前で生成するように変更。
    124                if( hideClass == null || hideClass.isEmpty() ){ // 5.5.4.4 (2012/07/20) 外部指定対応
    125                        hideClass = "hideMenu" + ( UNIQ_ID.getAndIncrement() );
    126                }
    127
    128                // 5.5.3.2 (2012/06/08) 画像にalt属性を追加します。
    129                String msglbl = getMsglbl();    // 5.7.1.2 (2013/12/20) msg ⇒ msglbl 変更
    130                if( msglbl == null ) { setLbl( "MSG0076" ); msglbl = getMsglbl(); }                     // 初期値は、MSG0076:拡張検索条件
    131
    132                final OgBuilder buf = new OgBuilder()
    133                                .append( "<div class=\"" , hideClass , "\" " )
    134                                .appendIf( id != null                                                           // if
    135                                                , "id=\"" , id , "\" " )
    136                                .appendIf( defaultNone                                                          // if
    137                                                , "style=\"display: none;\"" )
    138                                .append( ">" );
    139
    140                // 指定したIDにボタン画像を放り込むスクリプトを出力
    141                if( buttonId != null && buttonId.length() > 0){
    142                        final String IMG = "  <img id=\"queryHide\" src=\""
    143                                                        +       ( defaultNone ? openButton : closeButton )
    144                                                        +       "\" alt=\"" + msglbl + "\" border=\"0px\""
    145                                                        +       " title=\"" + StringUtil.htmlFilter( msglbl,true ) + "\""                       // 6.0.2.4 (2014/10/17) img タグに、title 属性追記
    146//                                                      +       " onClick=\"hideClass( event, this, '" + hideClass + "', '" + openButton + "', '" + closeButton + "' )\"/> " ;
    147                                                        +       " onClick=\"hideClass( event, this, '" + hideClass + "', '" + openButton + "', '" + closeButton + "' )\"> " ;           // 7.0.1.0 (2018/10/15)
    148
    149                        buf.appendCR( "<script language=\"javascript\">" )
    150                                .append( "$(function(){$('#" , buttonId , "').append(\"" )
    151                                .append( IMG.replace( "\"", "\\\"" ) )
    152                                .appendCR( "\");})" )
    153                                .appendCR( "</script>");
    154                }
    155
    156                jspPrint( buf.toString() );
    157                return EVAL_BODY_INCLUDE ;              // Body インクルード( extends TagSupport 時)
    158        }
    159
    160        /**
    161         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    162         *
    163         * @return      後続処理の指示
    164         */
    165        @Override
    166        public int doEndTag() {
    167                debugPrint();
    168
    169                jspPrint( CR + "</div>" );
    170
    171                return EVAL_PAGE ;              // ページの残りを評価する。
    172        }
    173
    174        /**
    175         * タグリブオブジェクトをリリースします。
    176         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    177         *
    178         * @og.rev 5.5.4.4 (2012/07/20) hideClass対応
    179         */
    180        @Override
    181        protected void release2() {
    182                super.release2();
    183                id                      = null;
    184                buttonId        = "query-button-append";
    185                defaultNone = true;
    186                openButton  = HybsSystem.sys( "JSP" ) + "/image/" + HybsSystem.sys( "HIDE_OPEN_BUTTON" );               // 開くボタン
    187                closeButton = HybsSystem.sys( "JSP" ) + "/image/" + HybsSystem.sys( "HIDE_CLOSE_BUTTON" );              // 閉じるボタン
    188                hideClass       = null;
    189        }
    190
    191        /**
    192         * 【HTML】要素に対して固有の名前(id)をつける場合に設定します。
    193         *
    194         * @og.tag
    195         * 開閉される部分を囲っているDIVタグのBODY部分にIDを指定します。
    196         * 特定のhideMenuにスタイルを指定したい場合等に利用して下さい。
    197         *
    198         * @param       input   BODY部分のID
    199         */
    200        @Override
    201        public void setId( final String input) {
    202                id = nval( getRequestParameter( input ), id );
    203        }
    204
    205        /**
    206         * 【TAG】画像ボタン出力先のIDを指定します。
    207         *
    208         * @og.tag
    209         * 初期値は"query-button-append"です。
    210         * queryButtonタグが存在する画面では通常指定する必要はありません。
    211         * queryButtonタグが存在しない場合は、別途用意したspanタグの
    212         * IDを指定する事でボタンが表示されます。
    213         *
    214         * @param       input   出力先のID
    215         *
    216         */
    217        public void setButtonId( final String input) {
    218                buttonId = nval( getRequestParameter( input ), buttonId );
    219        }
    220
    221        /**
    222         * 【TAG】初期状態の開閉指定[[true:閉じている/false:開いている]を指定します(初期値:true)。
    223         *
    224         * @og.tag
    225         * 初期状態が開いているか、閉じているかを指定します。
    226         * 初期値は閉じる(true)です。
    227         *
    228         * @param flag 開閉指定 [true:閉じている/false:開いている]
    229         *
    230         */
    231        public void setDefaultNone( final String flag) {
    232                defaultNone = nval( getRequestParameter( flag ), defaultNone );
    233        }
    234
    235        /**
    236         * 【TAG】開くボタンの画像を指定します
    237         *              (初期値:"jsp/image/" + SystemData#HIDE_OPEN_BUTTON[={@og.value SystemData#HIDE_OPEN_BUTTON}])。
    238         *
    239         * @og.tag
    240         * ボタンの画像を指定します。
    241         * 絶対パスの場合は、システムの先頭から、相対パスの場合、基底は各画面のフォルダとなります。
    242         * 初期値はjsp/imageフォルダ内のシステムパラメータHIDE_OPEN_BUTTONのファイルです。
    243         * (/システムID/jsp/image/expand_u.png)
    244         *
    245         * @param       name    画像ファイル名
    246         */
    247        public void setOpenButton( final String name) {
    248                openButton = nval( getRequestParameter( name ), openButton );
    249        }
    250
    251        /**
    252         * 【TAG】閉じるボタンの画像を指定します
    253         *              (初期値:"jsp/image/" + SystemData#HIDE_CLOSE_BUTTON[={@og.value SystemData#HIDE_CLOSE_BUTTON}])。
    254         *
    255         * @og.tag
    256         * ボタンの画像を指定します。
    257         * 絶対パスの場合は、システムの先頭から、相対パスの場合、基底は各画面のフォルダとなります。
    258         * 初期値はjsp/imageフォルダ内のシステムパラメータHIDE_CLOSE_BUTTONのファイルです。
    259         * (/システムID/jsp/image/shrink_u.png)
    260         *
    261         * @param       name    画像ファイル名
    262         */
    263        public void setCloseButton( final String name) {
    264                closeButton = nval( getRequestParameter( name ), closeButton );
    265        }
    266
    267        /**
    268         * 【TAG】開閉するclassを指定します。
    269         *
    270         * @og.tag
    271         * 開閉を制御するためのclass属性を外部から指定します。
    272         * 指定しない場合は自動でユニークなClassがセットされます。
    273         *
    274         * @param       name    クラス
    275         *
    276         * @og.rev 5.5.4.4 (2012/07/20) 新規追加
    277         */
    278        public void setHideClass( final String name) {
    279                hideClass = nval( getRequestParameter( name ), hideClass );
    280        }
    281
    282        /**
    283         * このオブジェクトの文字列表現を返します。
    284         * 基本的にデバッグ目的に使用します。
    285         *
    286         * @return このクラスの文字列表現
    287         * @og.rtnNotNull
    288         */
    289        @Override
    290        public String toString() {
    291                return ToString.title( this.getClass().getName() )
    292                                .println( "VERSION"                     ,VERSION                                                )
    293                                .println( "id"                          ,id                                                             )
    294                                .println( "buttonId"            ,buttonId                                               )
    295                                .println( "defaultNone"         ,defaultNone                                    )
    296                                .println( "openButton"          ,openButton                                             )
    297                                .println( "closeButton"         ,closeButton                                    )
    298                                .println( "Other..."            ,getAttributes().getAttribute() )
    299                                .fixForm().toString() ;
    300        }
    301}