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.fukurou.system.OgBuilder ;                          // 6.4.4.1 (2016/03/18)
019
020import org.opengion.fukurou.util.TagBuffer;
021import org.opengion.fukurou.util.XHTMLTag;
022import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
023import org.opengion.hayabusa.common.HybsSystemException;
024import org.opengion.hayabusa.db.DBTableModel;
025import org.opengion.hayabusa.db.DBTableModelUtil;
026
027import static org.opengion.fukurou.util.StringUtil.nval;
028
029import java.io.IOException;
030import java.io.ObjectInputStream;
031import java.util.ArrayList;
032import java.util.List;
033import java.util.Locale;
034import java.util.Arrays;                                                                                // 6.4.3.4 (2016/03/11)
035import java.util.stream.Collectors;                                                             // 6.4.3.4 (2016/03/11)
036
037/** タブ形式のリンクを表示するタグです。
038 *
039 * このタグ形式の実態は、リンクのリストであるため、実の画面の表示はターゲットを指定して
040 * 別フレームで行う必要があります。
041 *
042 * タブの指定方法については、listType属性の指定により、クエリ発行(DB)により動的に生成する
043 * パターンと、タグ指定(TAG)により、静的に生成するパターンがあります。
044 * listType属性に何も指定されていない場合は、Body部分に記述された内容により、自動判定されます。
045 * ("SELECT"で始まっている場合はDB、それ以外はTAGとして処理)
046 *
047 * ①listType属性が"DB"の場合
048 *  検索された各カラムは、その順番により次の意味を持ちます。
049 *  [第1カラム] タブの名前        : リンク時のキー情報、後述のopenTabName属性のキーとしても使用 ※必須
050 *  [第2カラム] タブの表示名称    : タブの表示名称 指定がない場合は、第1カラムが表示名称となります。
051 *  [第3カラム] タブのリンク先URL : タブのリンク先URL 指定がない場合は、href属性の値が適用されます。
052 *  [第4カラム] タブのクラス属性  : 個別のタブに付加されるクラス属性 指定がない場合は、unselClass属性の値が適用されます。
053 *  [第5カラム] タブのロールズ    : タブのロールズを指定します。ユーザーロールズと一致しない指定した場合は、タブが表示されなくなります。
054 *  [第6カラム] タブの選択可否    : タブの選択可否を'true'or'false'で指定します。falseを指定した場合は、タブが表示されなくなります。
055 *                                  (ロールズで選択不可になっている場合は、この値は無視されます)
056 *  各カラムの値は[カラム名]=[値]の形で、リンク先のJSPに引数として渡されます。
057 *  また、リンク先のJSPについては、href属性で指定します。
058 *
059 * ②listType属性が"TAG"の場合
060 *  tabListタグを記述し、個別にタブを定義します。
061 *  制御可能な項目は、①DBの場合と同等です。
062 *  タブの名前を定義するname属性は、tabListタグで必ず定義する必要があります。
063 *  lbl属性が指定されていない場合は、name属性のラベル名称を取得します。
064 *  タブのリンク先JSP及び、クラス属性については、tabListタグで指定がない場合、tabListタグの値が適用されます。
065 *
066 * [共通設定]
067 * 初期設定では、第1番目の"有効な"タブが自動的に開かれます。(="true")
068 * 各タブの表示方法で、選択不可能なタブが存在している場合は、それらを読み飛ばした上で、"有効な"タブを
069 * 検索します。
070 * また、自動で開くタブは、openTabName属性で指定可能であり、これに変数を定義することで、
071 * 画面リロード時も、開いていたタブを再度選択された状態で表示することが可能です。
072 *
073 * 選択したタブ及び非選択のタブの枠線や、背景色等を変更する場合は、custom.cssでクラスを定義し、
074 * 変更して下さい。
075 *
076 * タブの表示方向(水平方向 or 垂直方向)については、orientation属性で変更することが可能です。
077 * (初期値は、水平方向)
078 * 水平方向にした場合は、listCount属性により強制的に一定数のタブを表示する毎に、改行を挿入することができます。
079 *
080 * このタグを使用する場合は、headタグで必ずuseTabLink="true"を指定してJavaScriptをロードして下さい。
081 *
082 * 各属性は、{@XXXX} 変数が使用できます。
083 * これは、ServletRequest から、XXXX をキーに値を取り出し,この変数に割り当てます。
084 * つまり、このXXXXをキーにリクエストすれば、この変数に値をセットすることができます。
085 *
086 * @og.formSample
087 * ●形式:<og:tabLink href="…" … />
088 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
089 *
090 * ●Tag定義:
091 *   <og:tabLink
092 *       listType           【TAG】タブの一覧をどこから取得するかを指定します(初期値:AUTO)
093 *       href               【TAG】リンク先のJSPを指定します(初期値:result.jsp)
094 *       target             【TAG】リンクのターゲットを指定します(初期値:RESULT)
095 *       openTab            【TAG】リンク表示にタブリンクを自動で開くかどうか[true/false]を指定します(初期値:true[=開く])
096 *       openTabName        【TAG】最初に開くタブリンクの名前を指定します
097 *       constKeys          【TAG】次画面に渡す定数パラメーターのキーを指定します
098 *       constVals          【TAG】次画面に渡す定数パラメーターの値を指定します
099 *       listCount          【TAG】1行辺りに表示するタブの数を指定します(初期値:10)
100 *       selClass           【TAG】選択タブのクラスを指定します(初期値:selTab)
101 *       unselClass         【TAG】非選択タブのクラスを指定します(初期値:unselTab)
102 *       orientation        【TAG】タブの方向、横型(Horizontal)か縦型(Vertical)を指定します(初期値:横型)
103 *       width              【TAG】タブリンクの幅を % 、px 、または "auto" で指定します
104 *       height             【TAG】タブの高さを、% 、px 、または "auto" で指定します
105 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
106 *   >   ... Body ...
107 *   </og:tabLink>
108 *
109 * ●使用例
110 *   ①DBからタブリストを取得する場合
111 *
112 *    Body部分に記述されたクエリよりタブ一覧を生成します。
113 *
114 *      <og:tabLink
115 *          listType        = "DB"                      タブの一覧をどこから取得するか
116 *          href            = "result.jsp"              リンク先のJSP
117 *          target          = "RESULT"                  リンクターゲット
118 *          openTab         = "[true/false]"            タブ表示後にタブを自動で開く
119 *          openTabName     = "{@PN}               自動で開くタブの名前
120 *          constKeys       = "KEY1"                    次画面に固定で渡すキー一覧
121 *          constVals       = "{@VAL1}"            次画面に固定で渡す値一覧
122 *          listCount       = "10"                      1行辺りに表示するタブの数
123 *          selClass        = "selTab"                  選択タブのクラス
124 *          unselClass      = "unselTab"                非選択タブのクラス
125 *          width           = "100px"                   タブリンクの幅
126 *          height          = "50px"                    タブリンクの高さ
127 *       >
128 *               select PN,HINM,'tabClass','query.jsp','ADMIN','false' from XX01 where PN = '{@PN}' order by PN
129 *      </og:tabLink>
130 *
131 *   ②tabListタグからタブリストを生成する場合
132 *
133 *    tabListタグよりタブ一覧を生成します。
134 *
135 *      <og:tabLink
136 *          listType        = "DB"                      タブの一覧をどこから取得するか
137 *          href            = "result.jsp"              リンク先のJSP
138 *          target          = "RESULT"                  リンクターゲット
139 *          openTab         = "[true/false]"            タブ表示後にタブを自動で開く
140 *          openTabName     = "{@PN}               自動で開くタブの名前
141 *          constKeys       = "KEY1"                    次画面に固定で渡すキー一覧
142 *          constVals       = "{@VAL1}"            次画面に固定で渡す値一覧
143 *          listCount       = "10"                      1行辺りに表示するタブの数
144 *          selClass        = "selTab"                  選択タブのクラス
145 *          unselClass      = "unselTab"                非選択タブのクラス
146 *          width           = "100px"                   タブリンクの幅
147 *          height          = "50px"                    タブリンクの高さ
148 *       >
149 *          <og:tabList name="TAB1" href="result1.jsp" keys="PN,CDK" vals="ABC,V" />
150 *          <og:tabList name="TAB2" href="result2.jsp" keys="PN,CDK" vals="BCD,W" />
151 *          <og:tabList name="TAB3" href="result3.jsp" keys="PN,CDK" vals="CDE,X" />
152 *      </og:tabLink>
153 *
154 * @og.group 画面表示
155 *
156 * @version  0.9.0      2008/09/26
157 * @author       Nakamura
158 * @since        JDK1.4,
159 */
160public class TabLinkTag extends CommonTagSupport {
161        private static final String VERSION = "6.4.4.1 (2016/03/18)" ;
162        private static final long serialVersionUID = 644120160318L ;
163
164        /** リストのulタグのclass属性 */
165        private static final String             UL_TAG_START            = "<ul class=\"tabList\">";
166        private static final String             UL_TAG_END                      = "</ul>";
167
168        /** タブ表示を入れ替えるためのJavaScript関数 */
169        private static final String             CHANGE_TAB_SCRIPT       = "changeTab";
170        private static final String             INITIAL_TAB_SCRIPT      = "initialTabSelect";
171
172        /** 自動で開くタブに付加されるID */
173        private static final String             FIRST_TAB_ID            = "firstTab";
174
175        /** リスト取得タイプのEnum */
176        private static enum LIST_TYPE { AUTO, DB, TAG };
177
178        /** 内部変数 */
179        private String          query                   ;
180        private transient List<TabData>         tabData         = new ArrayList<>();
181
182        /** タグで設定する属性 */
183        private LIST_TYPE       type                    = LIST_TYPE.AUTO;
184        private String          href                    = "result.jsp";
185        private String          target                  = "RESULT";
186        private boolean         openTab                 = true;
187        private String          openTabName             ;
188        private String[]        constKeys               ;
189        private String[]        constVals               ;
190        private int                     listCount               = 10;
191        private String          selClass                = "selTab";
192        private String          unselClass              = "unselTab";
193        private boolean         isHorizontal    = true;
194        private String          width                   = "auto";
195        private String          height                  = "auto";
196
197        /**
198         * デフォルトコンストラクター
199         *
200         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
201         */
202        public TabLinkTag() { super(); }                // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
203
204        /**
205         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
206         *
207         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
208         */
209        @Override
210        public int doStartTag() {
211                return EVAL_BODY_BUFFERED ;     // Body を評価する
212        }
213
214        /**
215         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
216         *
217         * @og.rev 6.3.1.1 (2015/07/10) BodyString,BodyRawStringは、CommonTagSupport で、trim() します。
218         *
219         * @return      後続処理の指示(SKIP_BODY)
220         */
221        @Override
222        public int doAfterBody() {
223                query = getBodyString();
224                return SKIP_BODY ;
225        }
226
227        /**
228         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
229         *
230         * @og.rev 4.3.5.0 (2008/02/01) 処理及び内部構造を大幅に見直し
231         *
232         * @return      後続処理の指示
233         */
234        @Override
235        public int doEndTag() {
236                debugPrint();
237                final int rtnCode = EVAL_PAGE;
238
239                // 種別の自動判定処理
240                if( type == LIST_TYPE.AUTO ) {
241                        if( query == null || query.isEmpty() ) {
242                                type = LIST_TYPE.TAG;
243                        }
244                        else {
245                                if( query.toUpperCase( Locale.JAPAN ).indexOf( "SELECT" ) >= 0 ) {
246                                        type = LIST_TYPE.DB;
247                                }
248                                else {
249                                        type = LIST_TYPE.TAG;
250                                }
251                        }
252                }
253
254                if( type == LIST_TYPE.DB ) {
255                        makeTabsFromQuery();
256                }
257                else if( type == LIST_TYPE.TAG ) {
258                        makeTabsFromTag();
259                }
260
261                // リンク一覧が何も設定されていない場合は、処理しない
262                if( ! tabData.isEmpty() ) {
263                        makeTag();
264                }
265
266                return rtnCode ;
267        }
268
269        /**
270         * タグリブオブジェクトをリリースします。
271         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
272         */
273        @Override
274        protected void release2() {
275                super.release2();
276                query                   = null;
277                tabData                 = new ArrayList<>();
278                type                    = LIST_TYPE.AUTO;
279                href                    = "result.jsp";
280                target                  = "RESULT";
281                openTab                 = true;
282                openTabName             = null;
283                constKeys               = null;
284                constVals               = null;
285                listCount               = 10;
286                selClass                = "selTab";
287                unselClass              = "unselTab";
288                isHorizontal    = true;
289                width                   = "auto";
290                height                  = "auto";
291        }
292
293        /**
294         * DBからタブリンクの一覧を作成します。
295         * DBTableModelが作成されない(行数が0の場合)は、リンク一覧は生成されません。
296         *
297         * @og.rev 6.3.9.1 (2015/11/27) 3項演算子を || or &amp;&amp; で簡素化できる(PMD)。
298         */
299        private void makeTabsFromQuery() {
300                final DBTableModel table = DBTableModelUtil.makeDBTable( query, new String[0], getResource(), getApplicationInfo() );
301                if( table == null || table.getRowCount() == 0 ) {
302                        return;
303                }
304
305                // 6.3.9.1 (2015/11/27) 初期値設定の簡素化
306                final boolean isSetLabel        = table.getColumnCount() > 1;
307                final boolean isSetHref         = table.getColumnCount() > 2;
308                final boolean isSetClazz        = table.getColumnCount() > 3;
309                final boolean isSetRoles        = table.getColumnCount() > 4;
310                final boolean isSetVisible      = table.getColumnCount() > 5;
311
312                final int rowCount = table.getRowCount();
313                final String key   = table.getColumnName( 0 );
314                // 6.3.9.1 (2015/11/27) visible=true以外は処理しないので、先に求める。
315                for( int row=0; row<rowCount; row++ ) {
316                        final boolean visible = ( !isSetRoles   || getUser().isAccess( table.getValue( row, 4 ) ) ) &&
317                                                                        ( !isSetVisible || Boolean.valueOf(    table.getValue( row, 5 ) ) );
318
319                        if( visible ) {
320                                final String value      = table.getValue( row, 0 );
321                                final String label      = ( isSetLabel ? nval( table.getValue( row, 1 ), value ) : value );
322                                String newHref  = ( isSetHref  ? nval( table.getValue( row, 2 ), href ) : href );
323                                // 第1カラムのカラム名とその値はリンクの引数に含める
324                                newHref = XHTMLTag.addUrlEncode( newHref, XHTMLTag.urlEncode( key, value ) );
325
326                                final String clazz      = ( isSetClazz ? nval( table.getValue( row, 3 ), unselClass ) : unselClass );
327
328                                tabData.add( new TabData( newHref, value, label, clazz, visible ) );
329                        }
330                }
331        }
332
333        /**
334         * タブリストからタブリンクの一覧を作成します。
335         * (予めaddTagメソッドにより、リンク一覧が登録されているため、ここでは何も処理しません)
336         *
337         * @see #addTag( String, String, String, String, boolean, String[], String[] )
338         */
339        private void makeTabsFromTag() {
340                // 何もありません。(PMD エラー回避)
341        }
342
343        /**
344         * 子タグであるタブリストタグからタブ情報をセットします。
345         *
346         * @param hr 画面URL
347         * @param name タブの名前
348         * @param label タブの表示名称
349         * @param clz 非選択状態のタブに付加するclass名
350         * @param visible タブが選択可能 [true:可能/false:不可能]
351         * @param keys リンク先のJSPに渡すキー一覧
352         * @param vals リンク先のJSPに渡す値一覧
353         */
354        protected void addTag( final String hr, final String name, final String label, final String clz
355                                                        ,final boolean visible, final String[] keys, final String[] vals ) {
356                String newHref = nval( hr, href );
357                if( keys != null && keys.length > 0 ) {
358                        newHref = XHTMLTag.addUrlEncode( newHref, XHTMLTag.urlEncode( keys, vals ) );
359                }
360
361                if( visible ) { // visible=falseの場合は表示しない
362                        tabData.add( new TabData( newHref, name, nval( label, getLabel( name ) ), nval( clz, unselClass ), visible ) );
363                }
364        }
365
366        /**
367         * リンク一覧からHTMLタグを作成します。
368         *
369         * @og.rev 5.0.2.0 (2009/11/01) openTab属性がfalseの場合でも、openTabNameに指定されたタブに色付けする。
370         * @og.rev 5.1.4.0 (2010/03/01) FF対応&FirstTabのID付加に関するバグを修正
371         * @og.rev 6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。
372         */
373        private void makeTag() {
374                final OgBuilder buf = new OgBuilder().appendCR();
375
376                boolean isExistFirst = false;
377                for( int idx=0; idx<tabData.size(); idx++ ) {
378                        final TabData tab = tabData.get( idx );
379
380                        if( idx % listCount == 0 ) {
381                                buf.appendIfCR( idx > 0 , UL_TAG_END )                          // if
382                                        .appendCR( UL_TAG_START );
383                        }
384
385                        // openTabNameが定義されていない場合は、1番目の有効なタブを開く
386                        // 5.1.4.0 (2010/03/01) バグ修正
387                        if( !isExistFirst && tab.visible
388                                && ( openTabName == null || openTabName.isEmpty() || openTabName.equals( tab.name ) ) ) {
389                                buf.append( tab.makeLiTag( idx, true ) );
390                                isExistFirst = true;
391                        }
392                        else {
393                                buf.append( tab.makeLiTag( idx, false ) );
394                        }
395                }
396                buf.appendCR( UL_TAG_END )
397                        .appendIf( openTab || openTabName != null && openTabName.length() > 0                                           // 6.9.7.0 (2018/05/14) PMD Useless parentheses.
398                                        , "<script type=\"text/javascript\">addEvent(window,\"load\", function() { "
399                                        , INITIAL_TAB_SCRIPT
400                                        , "(" , String.valueOf( openTab ) , "); } );</script>" );
401
402                jspPrint( buf.toString() );
403        }
404
405        /**
406         * Tabデータ を管理している 内部クラス
407         *
408         * タブの情報を管理するための簡易的な、内部クラスです。
409         */
410        private final class TabData {
411                // 引数として初期設定される変数
412                private final String href;
413                private final String name;
414                private final String label;
415                private final String clazz;
416                // 現状の実装では、visible=falseは渡ってきませんが、将来的にdisableの状態で
417                // 表示したい場合等に対応するため残しておきます。
418                private final boolean visible;
419
420                /**
421                 * コンストラクタ
422                 *
423                 * @param hr 画面URL
424                 * @param nm タブの名前
425                 * @param lbl タブの表示名称
426                 * @param clz 非選択状態のタブに付加するclass名
427                 * @param vsb タブが選択可能 [true:可能/false:不可能]
428                 */
429                public TabData( final String hr, final String nm, final String lbl, final String clz, final boolean vsb ) {
430                        href    = hr;
431                        name    = nm;
432                        label   = lbl;
433                        clazz   = clz;
434                        visible = vsb;
435                }
436
437                /**
438                 * liタグの部分の文字列を生成します。
439                 *
440                 * @og.rev 6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。
441                 *
442                 * @param idx           生成したタブのインデックス番号
443                 * @param isFirst       始めの有効なタブかどうか[true:始め/false:それ以外]
444                 * @return liタグ文字列
445                 * @og.rtnNotNull
446                 */
447                private String makeLiTag( final int idx, final boolean isFirst ) {
448                        return new OgBuilder()
449                                .append( "<li class=\"" , clazz , "\""
450                                                , " style=\""
451                                                , " width: "    , width  , ";"
452                                                , " height: "   , height , ";" )
453                                .appendIf( isHorizontal , " float: left;" )
454                                .appendIf( isHorizontal && ( idx % listCount == 0 )     // if-if なので、少し無駄かも
455                                                , " clear: left; margin-left: "
456                                                , String.valueOf( (idx/listCount) * 10 )
457                                                , "px;" )
458                                .appendCR( " \">" , makeLinkTag( isFirst ) , "</li>" )
459                                .toString();
460                }
461
462                /**
463                 * aタグの部分の文字列を生成します。
464                 * タブが選択不可能な状態の場合は、タブの表示文字列をそのまま返します。
465                 *
466                 * @og.rev 4.3.6.4 戻るボタンがでない問題への対応
467                 *
468                 * @param       isFirst 始めの有効なタブかどうか[true:始め/false:それ以外]
469                 * @return      liタグ文字列
470                 * @og.rtnNotNull
471                 */
472                private String makeLinkTag( final boolean isFirst ) {
473                        String newHref = XHTMLTag.addUrlEncode( href, XHTMLTag.urlEncode( constKeys, constVals ) );
474                        // 4.3.6.4 (2009/05/01)
475                        // タブ画面から遷移した時に、タブの読込により、画面IDが消えてしまい
476                        // 戻るボタンがでない不具合への対応
477                        newHref = XHTMLTag.addUrlEncode( newHref, "GAMENID=" + getGUIInfoAttri( "KEY" ) );
478
479                        // 6.1.1.0 (2015/01/17) TagBufferの連結記述
480                        return new TagBuffer( "a" )
481                                        .add( "href"    , newHref )
482                                        .add( "name"    , name )
483                                        .add( "target"  , target )
484                                        .add( "onClick" , CHANGE_TAB_SCRIPT + "( this, \"" + selClass + "\" );" )
485                                        .add( "id"              , FIRST_TAB_ID  , isFirst )
486                                        .addBody( label )
487                                        .makeTag();
488                }
489        }
490
491        /**
492         * 【TAG】タブの一覧をどこから取得するか[AUTO/DB/TAG]を指定します(初期値:AUTO)。
493         *
494         * @og.tag
495         * タブの一覧をどこから取得するかを指定します。
496         * 現状の実装では、クエリを発行して一覧を生成する「DB」と、子タグである
497         * tabListタグを列挙してタブを定義する「TAG」が実装されています。
498         *
499         * また、「AUTO」と指定した場合は、Body部分の内容に応じて自動的に判定されます。
500         * 初期値は、「AUTO」です。
501         *
502         * @og.rev 6.4.3.4 (2016/03/11) CSV形式の文字連結を、stream 経由で行います。
503         *
504         * @param       tp 取得方法 [AUTO/DB/TAG]
505         */
506        public void setListType( final String tp ) {
507                final String typeStr = nval( getRequestParameter( tp ), null );
508                try {
509                        type = LIST_TYPE.valueOf( typeStr );
510                }
511                catch( final IllegalArgumentException ex ) {
512                        final String errMsg = Arrays.stream( LIST_TYPE.values() )
513                                                                        .map( obj -> obj.name() )
514                                                                        .collect( Collectors.joining( "," , "listType は " , " から選んでください。" ) );  // 連結文字 , 最初 , 最後
515                        throw new HybsSystemException( errMsg, ex );
516                }
517        }
518
519        /**
520         * 【TAG】リンク先のJSPを指定します(初期値:result.jsp)。
521         *
522         * @og.tag
523         * リンク先のJSPを指定します。
524         * このタブリンクは、あくまで「タブの形をしたリンク」なので、
525         * target属性と合わせてセットする必要があります。
526         * 初期値は、「result.jsp」です。
527         *
528         * @param       hr リンク先のJSP
529         */
530        public void setHref( final String hr ) {
531                href = nval( getRequestParameter( hr ), href );
532        }
533
534        /**
535         * 【TAG】リンクのターゲットを指定します(初期値:RESULT)。
536         *
537         * @og.tag
538         * リンクのターゲットを指定します。
539         * このタブリンクは、あくまで「タブの形をしたリンク」なので、
540         * target属性を設定し、別のフレームに実画面を表示するようにします。
541         * 初期値は、「RESULT」です。
542         *
543         * @param       tgt リンクターゲット
544         */
545        public void setTarget( final String tgt ) {
546                target = nval( getRequestParameter( tgt ), target );
547        }
548
549        /**
550         * 【TAG】リンク表示にタブリンクを自動で開くかどうか[true/false]を指定します(初期値:true[=開く])。
551         *
552         * @og.tag
553         * リンク表示にタブリンクを自動で開くかを指定します。
554         * openTabName属性が指定されていない場合、自動で開くタブは
555         * 「1番目に表示されたタブリンク」です。
556         * 指定されている場合は、その名前を持つ「1番目」のタブが自動で開かれます。
557         * タブが選択不可能な状態の場合は、「1番目」の条件から除外されます。
558         * 初期値は、「true(開く)」です。
559         *
560         * @param       flag 自動タブオープン [true:自動で開く/false:開かない]
561         */
562        public void setOpenTab( final String flag ) {
563                openTab = nval( getRequestParameter( flag ), openTab );
564        }
565
566        /**
567         * 【TAG】最初に開くタブリンクの名前を指定します。
568         *
569         * @og.tag
570         * 最初に開くタブリンクのキーを指定します。
571         *
572         * @param       name 初期表示タブ名前
573         */
574        public void setOpenTabName( final String name ) {
575                openTabName = nval( getRequestParameter( name ), openTabName );
576        }
577
578        /**
579         * 【TAG】次画面に渡す定数パラメーターのキーを指定します。
580         *
581         * @og.tag
582         * 次画面に渡す定数パラメーターのキーを指定します。
583         * キーはCSV形式で複数指定が可能です。
584         * パラメーターの値は、constVals属性の数と一致している必要があります。
585         *
586         * @param       keys 定数キー (CSV形式)
587         * @see         #setConstVals( String )
588         */
589        public void setConstKeys( final String keys ) {
590                constKeys = getCSVParameter( keys );
591        }
592
593        /**
594         * 【TAG】次画面に渡す定数パラメーターの値を指定します。
595         *
596         * @og.tag
597         * 次画面に渡す定数パラメーターの値を指定します。
598         * 値はCSV形式で複数指定が可能です。
599         * パラメーターの値は、constKeys属性の数と一致している必要があります。
600         *
601         * @param       vals 定数値 (CSV形式)
602         * @see         #setConstKeys( String )
603         */
604        public void setConstVals( final String vals ) {
605                constVals = getCSVParameter( vals );
606        }
607
608        /**
609         * 【TAG】1行辺りに表示するタブの数を指定します(初期値:10)。
610         *
611         * @og.tag
612         * 1行辺りに表示するタブの数を指定します。
613         * 1行辺りのタブの数がこの設定を超えると、自動的に折り返します。
614         * また、折り返し毎に、左に10pxのマージンを設けます。
615         * 初期値は、10です。
616         * この属性は、orientationがHorizontal(水平方向)の場合のみ有効です。
617         *
618         * @param       cnt 1行タブ数
619         */
620        public void setListCount( final String cnt ) {
621                listCount = nval( getRequestParameter( cnt ), listCount );
622        }
623
624        /**
625         * 【TAG】選択タブのクラスを指定します(初期値:selTab)。
626         *
627         * @og.tag
628         * タブが選択されている状態にある場合の、タブ部分のクラス名を指定します。
629         * このクラス名を変更する場合は、そのクラスをcustom/custom.css等で再定義して下さい。
630         * 初期値は、selTabです。
631         *
632         * @param       cls 選択タブのクラス名
633         */
634        public void setSelClass( final String cls ) {
635                selClass = nval( getRequestParameter( cls ), selClass );
636        }
637
638        /**
639         * 【TAG】非選択タブのクラスを指定します(初期値:unselTab)。
640         *
641         * @og.tag
642         * タブが選択されていない状態にある場合の、タブ部分のクラス名を指定します。
643         * このクラス名を変更する場合は、そのクラスをcustom/custom.css等で再定義して下さい。
644         * 初期値は、unselTabです。
645         *
646         * @param       cls 選択タブのクラス名
647         */
648        public void setUnselClass( final String cls ) {
649                unselClass = nval( getRequestParameter( cls ), unselClass );
650        }
651
652        /**
653         * 【TAG】タブの方向[Horizontal(or H):横型/Vertical(or V):縦型]を指定します(初期値:Horizontal:横型)。
654         *
655         * @og.tag
656         * タブは、上にタブが並ぶ横型と左にタブが並ぶ縦型があります。
657         * この属性では、横型は、Horizontal 、縦型は、Vertical を指定します。
658         * 指定は、文字列の最初の一文字を見ているだけですので、HかVでも構いません。
659         *
660         * 縦型(Vertical)にした場合、各タブ要素は、フレームサイズの幅に合わせて
661         * 最大で表示されます。幅を固定する場合は、width属性を指定して下さい。
662         *
663         * 初期値は、横型(Horizontal) です。
664         *
665         * @param       ori タブの方向 [Horizontal(or H):横型/Vertical(or V):縦型]
666         */
667        public void setOrientation( final String ori ) {
668                final String ori2 = nval( getRequestParameter( ori ),null );
669                if( ori2 != null && ori2.length() > 0 ) {
670                        final char ch = ori2.toUpperCase(Locale.JAPAN).charAt(0);
671                        if( ch == 'H' ) { isHorizontal = true; }
672                        else if( ch == 'V' ) { isHorizontal = false; }
673                        else {
674                                final String errMsg = "orientation の指定は、H(orizontal) または、V(ertical) です。"
675                                                        + " orientation=" + ori2 ;                      // 5.1.8.0 (2010/07/01) errMsg 修正
676                                throw new HybsSystemException( errMsg );
677                        }
678                }
679        }
680
681        /**
682         * 【TAG】タブリンクの幅を % 、px 、または "auto" で指定します(初期値:auto)。
683         *
684         * @og.tag
685         * 初期値は、"auto"(自動設定) です。
686         * autoの場合、横型表示では、文字の幅に合わせて自動的に調整され、
687         * 縦型表示の場合は、フレームサイズに合わせて拡大して表示されます。
688         *
689         * @param       wh      幅 (% 、px 、または "auto" )
690         */
691        public void setWidth( final String wh ) {
692                width = nval( getRequestParameter( wh ),width );
693        }
694
695        /**
696         * 【TAG】タブの高さを、% 、px 、または "auto" で指定します(初期値:auto)。
697         *
698         * @og.tag
699         * タブの高さを、% 、px 、または "auto" で指定します
700         * 初期値は、"auto"(自動設定) です。
701         *
702         * @param       ht      高さ (% 、px 、または "auto" )
703         */
704        public void setHeight( final String ht ) {
705                height = nval( getRequestParameter( ht ),height );
706        }
707
708        /**
709         * シリアライズ用のカスタムシリアライズ読み込みメソッド
710         *
711         * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。
712         *
713         * @og.rev 5.1.8.0 (2010/07/01) tabData の初期化処理 追加
714         * @serialData 一部のオブジェクトは、シリアライズされません。
715         *
716         * @param       strm    ObjectInputStreamオブジェクト
717         * @see #release2()
718         * @throws IOException  シリアライズに関する入出力エラーが発生した場合
719         * @throws ClassNotFoundException       クラスを見つけることができなかった場合
720         */
721        private void readObject( final ObjectInputStream strm ) throws IOException, ClassNotFoundException {
722                strm.defaultReadObject();
723                tabData         = new ArrayList<>();
724        }
725
726        /**
727         * このオブジェクトの文字列表現を返します。
728         * 基本的にデバッグ目的に使用します。
729         *
730         * @return このクラスの文字列表現
731         * @og.rtnNotNull
732         */
733        @Override
734        public String toString() {
735                return ToString.title(this.getClass().getName() )
736                .println( "VERSION"       , VERSION )
737                .println( "listType"      , type.toString() )
738                .println( "href"          , href )
739                .println( "target"        , target )
740                .println( "openTab"       , openTab )
741                .println( "openTabName"   , openTabName )
742                .println( "constKeys"     , constKeys )
743                .println( "constVals"     , constVals )
744                .println( "listCount"     , listCount )
745                .println( "selClass"      , selClass )
746                .println( "unselClass"    , unselClass )
747                .println( "isHorizontal"  , isHorizontal )
748                .println( "width"         , width )
749                .println( "height"        , height )
750                .println( "Other...", getAttributes().getAttribute() ).fixForm().toString();
751        }
752}