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 *       ・<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 *         >
047 * ●body:あり(EVAL_BODY_INCLUDE:BODYをインクルードし、{@XXXX} は解析しません)
048 *
049 * ●Tag定義:
050 *   <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 *   >   ... Body ...
059 *   </og:hideMenu>
060 *
061 * ●使用例
062 * 例1:通常のQUERY画面での利用
063 *         <og:hideMenu>
064 *           <table><tr>
065 *             <og:column name="CLM"/>
066 *           </tr></table>
067 *         </og:hideMenu>
068 *
069 * 例2:queryButtonタグが存在しない状況での利用(buttonIdの明示的な指定)
070 *         <span id="hideButtonSet"> </span>
071 *         <og:hideMenu>
072 *             ......
073 *         </og:hideMenu>
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 = "6.4.4.1 (2016/03/18)" ;
085        private static final long serialVersionUID = 644120160318L ;
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         *
117         * @return      後続処理の指示( EVAL_BODY_INCLUDE )
118         */
119        @Override
120        public int doStartTag() {
121                // 6.3.9.0 (2015/11/06) Variables should start with a lowercase character(PMD)
122                // IMG を final 化するに当たり、実際に使用する直前で生成するように変更。
123                if( hideClass == null || hideClass.isEmpty() ){ // 5.5.4.4 (2012/07/20) 外部指定対応
124                        hideClass = "hideMenu" + ( UNIQ_ID.getAndIncrement() );
125                }
126
127                // 5.5.3.2 (2012/06/08) 画像にalt属性を追加します。
128                String msglbl = getMsglbl();    // 5.7.1.2 (2013/12/20) msg ⇒ msglbl 変更
129                if( msglbl == null ) { setLbl( "MSG0076" ); msglbl = getMsglbl(); }                     // 初期値は、MSG0076:拡張検索条件
130
131                final OgBuilder buf = new OgBuilder()
132                                .append( "<div class=\"" , hideClass , "\" " )
133                                .appendIf( id != null                                                           // if
134                                                , "id=\"" , id , "\" " )
135                                .appendIf( defaultNone                                                          // if
136                                                , "style=\"display: none;\"" )
137                                .append( ">" );
138
139                // 指定したIDにボタン画像を放り込むスクリプトを出力
140                if( buttonId != null && buttonId.length() > 0){
141                        final String IMG = "  <img id=\"queryHide\" src=\""
142                                                        +       ( defaultNone ? openButton : closeButton )
143                                                        +       "\" alt=\"" + msglbl + "\" border=\"0px\""
144                                                        +       " title=\"" + StringUtil.htmlFilter( msglbl,true ) + "\""                       // 6.0.2.4 (2014/10/17) img タグに、title 属性追記
145                                                        +       " onClick=\"hideClass( event, this, '" + hideClass + "', '" + openButton + "', '" + closeButton + "' )\"/> " ;
146
147                        buf.appendCR( "<script language=\"javascript\">" )
148                                .append( "$(function(){$('#" , buttonId , "').append(\"" )
149                                .append( IMG.replace( "\"", "\\\"" ) )
150                                .appendCR( "\");})" )
151                                .appendCR( "</script>");
152
153                }
154
155                jspPrint( buf.toString() );
156                return EVAL_BODY_INCLUDE ;              // Body インクルード( extends TagSupport 時)
157        }
158
159        /**
160         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
161         *
162         * @return      後続処理の指示
163         */
164        @Override
165        public int doEndTag() {
166                debugPrint();
167
168                jspPrint( CR + "</div>" );
169
170                return EVAL_PAGE ;              // ページの残りを評価する。
171        }
172
173        /**
174         * タグリブオブジェクトをリリースします。
175         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
176         *
177         * @og.rev 5.5.4.4 (2012/07/20) hideClass対応
178         */
179        @Override
180        protected void release2() {
181                super.release2();
182                id                      = null;
183                buttonId        = "query-button-append";
184                defaultNone = true;
185                openButton  = HybsSystem.sys( "JSP" ) + "/image/" + HybsSystem.sys( "HIDE_OPEN_BUTTON" );               // 開くボタン
186                closeButton = HybsSystem.sys( "JSP" ) + "/image/" + HybsSystem.sys( "HIDE_CLOSE_BUTTON" );              // 閉じるボタン
187                hideClass       = null;
188        }
189
190        /**
191         * 【HTML】要素に対して固有の名前(id)をつける場合に設定します。
192         *
193         * @og.tag
194         * 開閉される部分を囲っているDIVタグのBODY部分にIDを指定します。
195         * 特定のhideMenuにスタイルを指定したい場合等に利用して下さい。
196         *
197         * @param       input   BODY部分のID
198         */
199        @Override
200        public void setId( final String input) {
201                id = nval( getRequestParameter( input ), id );
202        }
203
204        /**
205         * 【TAG】画像ボタン出力先のIDを指定します。
206         *
207         * @og.tag
208         * 初期値は"query-button-append"です。
209         * queryButtonタグが存在する画面では通常指定する必要はありません。
210         * queryButtonタグが存在しない場合は、別途用意したspanタグの
211         * IDを指定する事でボタンが表示されます。
212         *
213         * @param       input   出力先のID
214         *
215         */
216        public void setButtonId( final String input) {
217                buttonId = nval( getRequestParameter( input ), buttonId );
218        }
219
220        /**
221         * 【TAG】初期状態の開閉指定[[true:閉じている/false:開いている]を指定します(初期値:true)。
222         *
223         * @og.tag
224         * 初期状態が開いているか、閉じているかを指定します。
225         * 初期値は閉じる(true)です。
226         *
227         * @param flag 開閉指定 [true:閉じている/false:開いている]
228         *
229         */
230        public void setDefaultNone( final String flag) {
231                defaultNone = nval( getRequestParameter( flag ), defaultNone );
232        }
233
234        /**
235         * 【TAG】開くボタンの画像を指定します
236         *              (初期値:"jsp/image/" + SystemData#HIDE_OPEN_BUTTON[={@og.value SystemData#HIDE_OPEN_BUTTON}])。
237         *
238         * @og.tag
239         * ボタンの画像を指定します。
240         * 絶対パスの場合は、システムの先頭から、相対パスの場合、基底は各画面のフォルダとなります。
241         * 初期値はjsp/imageフォルダ内のシステムパラメータHIDE_OPEN_BUTTONのファイルです。
242         * (/システムID/jsp/image/expand_u.png)
243         *
244         * @param       name    画像ファイル名
245         */
246        public void setOpenButton( final String name) {
247                openButton = nval( getRequestParameter( name ), openButton );
248        }
249
250        /**
251         * 【TAG】閉じるボタンの画像を指定します
252         *              (初期値:"jsp/image/" + SystemData#HIDE_CLOSE_BUTTON[={@og.value SystemData#HIDE_CLOSE_BUTTON}])。
253         *
254         * @og.tag
255         * ボタンの画像を指定します。
256         * 絶対パスの場合は、システムの先頭から、相対パスの場合、基底は各画面のフォルダとなります。
257         * 初期値はjsp/imageフォルダ内のシステムパラメータHIDE_CLOSE_BUTTONのファイルです。
258         * (/システムID/jsp/image/shrink_u.png)
259         *
260         * @param       name    画像ファイル名
261         */
262        public void setCloseButton( final String name) {
263                closeButton = nval( getRequestParameter( name ), closeButton );
264        }
265
266        /**
267         * 【TAG】開閉するclassを指定します。
268         *
269         * @og.tag
270         * 開閉を制御するためのclass属性を外部から指定します。
271         * 指定しない場合は自動でユニークなClassがセットされます。
272         *
273         * @param       name    クラス
274         * 
275         * @og.rev 5.5.4.4 (2012/07/20) 新規追加
276         */
277        public void setHideClass( final String name) {
278                hideClass = nval( getRequestParameter( name ), hideClass );
279        }
280
281        /**
282         * このオブジェクトの文字列表現を返します。
283         * 基本的にデバッグ目的に使用します。
284         *
285         * @return このクラスの文字列表現
286         * @og.rtnNotNull
287         */
288        @Override
289        public String toString() {
290                return ToString.title( this.getClass().getName() )
291                                .println( "VERSION"                     ,VERSION                                                )
292                                .println( "id"                          ,id                                                             )
293                                .println( "buttonId"            ,buttonId                                               )
294                                .println( "defaultNone"         ,defaultNone                                    )
295                                .println( "openButton"          ,openButton                                             )
296                                .println( "closeButton"         ,closeButton                                    )
297                                .println( "Other..."            ,getAttributes().getAttribute() )
298                                .fixForm().toString() ;
299        }
300}