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.html.FormatterType;
019
020/**
021 * 検索結果に対してヘッダーフォーマットを変更するタグです。
022 *
023 * @og.formSample
024 * ●形式:<og:thead rowspan="..." > ... Body ... </og:thead>
025 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
026 *
027 * ●Tag定義:
028 *   <og:thead
029 *       rowspan          ○【TAG】表示データを作成する場合のフォーマットの行数(rowspan)をセットします(初期値:2)(必須)。
030 *       useTrCut           【TAG】先頭trタグを削除するかどうか[true/false]を指定します(初期値:true)
031 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
032 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
033 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない)
034 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない)
035 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
036 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
037 *   >   ... Body ...
038 *   </og:thead>
039 *
040 * ●使用例
041 *      <og:view
042 *          viewFormType = "HTMLCustomTable"
043 *          command      = "{@command}"
044 *          writable     = "false"
045 *          startNo      = "{@startNo}"
046 *          pageSize     = "{@pageSize}"
047 *          rowspan      = "1"
048 *          numberType   = "delete"
049 *      >
050 *          <og:thead rowspan="1" >
051 *              <tr><td> </td><td>[VALUENAME]</td><td>[DESCRIPTION]</td></tr>
052 *          </og:thead>
053 *        ...
054 *      </og:view>
055 *
056 * @og.rev 3.5.4.0 (2003/11/25) TFormatTag のサブクラスとして再定義。
057 * @og.group 画面部品
058 *
059 * @version  4.0
060 * @author       Kazuhiko Hasegawa
061 * @since    JDK5.0,
062 */
063public class TheadTag extends TFormatImpl {
064        /** このプログラムのVERSION文字列を設定します。   {@value} */
065        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
066        private static final long serialVersionUID = 642020160129L ;
067
068        /**
069         * デフォルトコンストラクター
070         *
071         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
072         */
073        public TheadTag() { super(); }          // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
074
075        /**
076         * このフォーマットのタイプを返します。
077         *
078         * @og.rev 3.5.4.0 (2003/11/25) 新規追加
079         *
080         * @return      このフォーマットのタイプを返します。
081         */
082        @Override
083        protected FormatterType getType() {
084                return FormatterType.TYPE_HEAD;
085        }
086}