    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.util.TagBuffer;
    019import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
    020
    021import static org.opengion.fukurou.util.StringUtil.nval ;               // 6.1.0.0 (2014/12/26)
    022
    023/**
    024 * ガントチャートを表示するに当たり、ガント全体（ページ全体一つ設定）の指定を行います。
    025 *
    026 * iGantt タグは、ガントチャート全体に一つ指定する事で、最大行数、固定カラム数、
    027 * 番号列の出力有無を指定するのに使用されます。
    028 * 通常は、単独で使用するのではなく、iGanttBar タグと組み合わせて使用します。
    029 * 通常の view タグの後に記述します。
    030 *
    031 * ガントには、通常のガントと積上ガント、内部積上ガントがあります。
    032 * 通常ガントは、通常の view をガント化します。
    033 * 積上ガントは、ViewにHTMLstackedGanttTableを指定する必要があります。
    034 * この方式の利点は、積上と通常のガントバーを混在できることです。例えば、物件予定をガントバーで、表示し、
    035 * 個人の予定工数を積上るなどの表示が可能です。ただし、件数が多いと、処理に時間がかかります。
    036 * 内部積上ガントは、エンジン内部で積上計算しますので、処理は早いのですが、ガントバーとの
    037 * 混在ができません。これらは、うまく使い分けを行う必要があります。
    038 *
    039 * @og.formSample
    040 * ●形式：&lt;og:iGantt  ... /&gt;
    041 * ●body：なし
    042 * ●前提：headタグで、adjustEvent="Gantt" を指定してください。
    043 *
    044 * ●Tag定義：
    045 *   &lt;og:iGantt
    046 *       margeRows          【TAG】前後の行データが一致している場合、マージするかどうか[true/false]指定します(初期値:false)
    047 *       fixedCols          【TAG】左の固定列の列数（テーブル２分割機能）を指定します
    048 *       viewNumberType     【TAG】viewタグの出力に番号列が出力されているかかどうか（出力されていない場合:deleteを指定）
    049 *       verticalShift      【TAG】ガントの上下ずらし表示を行うかどうか[true/false]指定します(初期値=true:行う)
    050 *       paddingLeft        【TAG】ガントバーの間の左区切りスペースを指定します(初期値=null)
    051 *       paddingRigth       【TAG】ガントバーの間の右区切りスペースを指定します(初期値=null)
    052 *       useBgColor         【TAG】一覧の背景色の縞々模様を再作成するか[true/false]指定します（margeRows='true'の場合は使用する）
    053 *       viewGantt          【TAG】積上ガント:ガント部分の表示を行うかどうか[true/false]指定します(初期値=true:表示する)
    054 *       stackHoliday       【TAG】積上ガント:休日に積上げるかどうか[true/false]指定します（zoom=DAYの場合のみ有効。初期値=true:積上げる)
    055 *       viewMode           【TAG】積上ガント:1:行の最大値を基準に積上げ高さの計算を行う/0:能力設定値を基準に積上げ高さの計算を行う。
    056 *       stdUpper           【TAG】積上ガント:正常範囲の上限となる工数です。これを超えると積上げの色が変化します(初期値:1)
    057 *       stdCost            【TAG】積上ガント:この工数が行の2/3の高さとなります(初期値:1)
    058 *       stdLower           【TAG】積上ガント:正常範囲の下限となる工数です。これを下回ると積上げの色が変化します(初期値:0)
    059 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
    060 *   /&gt;
    061 *
    062 * ●使用例
    063 *   (通常ガント)
    064 *  &lt;og:view
    065 *      viewFormType = "HTMLCustomTable"
    066 *      command      = "{&#064;command}"
    067 *      writable     = "false"
    068 *      useScrollBar = "false"
    069 *  &gt;
    070 *    &lt;og:thead rowspan="2"&gt;
    071 *      &lt;tr&gt;
    072 *          &lt;td&gt;[NOORDER]&lt;/td&gt;
    073 *          &lt;td rowspan="2" class="gantt zoom{&#064;VZOOM}" style="line-height:normal;text-align:left;background-image: url('../image/ganttBG{&#064;VZOOM}.gif');" &gt;
    074 *              &lt;div style="position:relative;left:0px;z-index:101; " height="100%" width="100%" &gt;
    075 *                  &lt;og:ganttHeader
    076 *                      startDate       = "{&#064;startDate}"
    077 *                      endDate         = "{&#064;endDate}"
    078 *                      zoom            = "{&#064;VZOOM}"
    079 *                      daySpan         = "{&#064;daySpan}"
    080 *                  /&gt;
    081 *              &lt;/div&gt;
    082 *          &lt;/td&gt;
    083 *      &lt;/tr&gt;
    084 *    &lt;/og:thead&gt;
    085 *    &lt;og:tbody rowspan="2"&gt;
    086 *      &lt;tr&gt;
    087 *          &lt;td&gt;[NOORDER]&lt;/td&gt;
    088 *          &lt;td rowspan="2" class="gantt zoom{&#064;VZOOM}" style="text-align:left;background-image: url('../image/ganttBG{&#064;VZOOM}.gif');" &gt;
    089 *              &lt;og:iGanttBar type="1" colorNo="[COLOR]" start="[DYORDER]" end="[DYNOKI]" text="[PN]" /&gt;
    090 *              &lt;og:iGanttBar type="0" src="../image/dia_blue.gif" start="[DYORDER]"      text="開始" /&gt;
    091 *              &lt;og:iGanttBar type="0" src="../image/dia_red.gif"  end="[DYNOKI]"         text="終了" /&gt;
    092 *          &lt;/td&gt;
    093 *      &lt;/tr&gt;
    094 *    &lt;/og:tbody&gt;
    095 *  &lt;/og:view&gt;
    096 *
    097 *   &lt;og:iGantt
    098 *       margeRows      = "true"
    099 *       fixedCols      = "1"
    100 *   /&gt;
    101 *
    102 *   (積上ガント)
    103 *  積上ガントを利用する場合は、ViewにHTMLstackedGanttTableを利用する必要があります。
    104 *  &lt;og:view
    105 *      viewFormType = "HTMLStackedGanttTable"
    106 *      command      = "{&#064;command}"
    107 *      writable     = "false"
    108 *      useScrollBar = "false"
    109 *      useParam     = "true"
    110 *      numberType   = "none"
    111 *  &gt;
    112 *  &lt;og:stackParam
    113 *      stackColumns = "NOORDER"
    114 *  /&gt;
    115 *
    116 *    &lt;og:thead rowspan="2"&gt;
    117 *      &lt;tr&gt;
    118 *          &lt;td&gt;[NOORDER]&lt;/td&gt;
    119 *          &lt;td&gt;[PN]&lt;/td&gt;
    120 *          &lt;td rowspan="2" class="gantt zoom{&#064;SZOOM}" style="text-align:left;background-image: url('../image/ganttBG{&#064;SZOOM}.gif');" &gt;
    121 *              &lt;div style="position:relative;left:0px;z-index:101; " height="100%" width="100%" &gt;
    122 *                  &lt;og:ganttHeader
    123 *                      startDate   = "{&#064;startDate}"
    124 *                      endDate     = "{&#064;endDate}"
    125 *                      zoom        = "{&#064;SZOOM}"
    126 *                      calDB       = "GE13"
    127 *                      arg1        = "A"
    128 *                  /&gt;
    129 *              &lt;/div&gt;
    130 *          &lt;/td&gt;
    131 *      &lt;/tr&gt;
    132 *    &lt;/og:thead&gt;
    133 *    &lt;og:tbody rowspan="2"&gt;
    134 *      &lt;tr&gt;
    135 *          &lt;td&gt;[NOORDER]&lt;/td&gt;
    136 *          &lt;td&gt;[PN]&lt;/td&gt;
    137 *          &lt;td rowspan="2" class="gantt zoom{&#064;VZOOM}" style="text-align:left;background-image: url('../image/ganttBG{&#064;VZOOM}.gif');" &gt;
    138 *              &lt;og:iGanttBar type="1" colorNo="[COLOR]" start="[DYORDER]" end="[DYNOKI]"  text="[COSTCLM]"
    139 *                    cost="[COSTCLM]" capacity="[CAPACITY]" /&gt;
    140 *              &lt;og:iGanttBar type="0" src="../image/dia_blue.gif" start="[DYORDER]"      text="開始" /&gt;
    141 *          &lt;/td&gt;
    142 *      &lt;/tr&gt;
    143 *    &lt;/og:tbody&gt;
    144 *  &lt;/og:view&gt;
    145 *
    146 *   &lt;og:iGantt
    147 *       margeRows      = "true"
    148 *       fixedCols      = "1"
    149 *       verticalShift  = "false"
    150 *       viewGantt      = "{&#064;viewGantt}"
    151 *       stackHoliday   = "{&#064;stackHoliday}"
    152 *       useBgColor     = "true"
    153 *       viewMode       = "2"
    154 *   /&gt;
    155 *
    156 * @og.rev 5.6.3.2 (2013/04/12) 新規作成
    157 * @og.group 画面部品
    158 *
    159 * @version  5.0
    160 * @author       Kazuhiko Hasegawa
    161 * @since    JDK6.0,
    162 */
    163public class ViewIGanttTag extends CommonTagSupport {
    164        /** このプログラムのVERSION文字列を設定します。   {@value} */
    165        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
    166        private static final long serialVersionUID = 642020160129L ;
    167
    168        private transient TagBuffer tag = new TagBuffer( "iGantt" ).addBody( "<!-- -->" );              // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    169
    170        /**
    171         * デフォルトコンストラクター
    172         *
    173         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    174         */
    175        public ViewIGanttTag() { super(); }             // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    176
    177        /**
    178         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    179         *
    180         * @og.rev 6.0.2.5 (2014/10/31) HTML5対応。javaScriptで、BODYがないと入れ子になってしまう。
    181         *
    182         * @return      後続処理の指示
    183         */
    184        @Override
    185        public int doEndTag() {
    186                debugPrint();           // 4.0.0 (2005/02/28)
    187
    188                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    189                jspPrint( tag.makeTag() );
    190
    191                return EVAL_PAGE ;              // ページの残りを評価する。
    192        }
    193
    194        /**
    195         * タグリブオブジェクトをリリースします。
    196         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    197         *
    198         */
    199        @Override
    200        protected void release2() {
    201                super.release2();
    202                tag = new TagBuffer( "iGantt" ).addBody( "<!-- -->" );          // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    203        }
    204
    205        /**
    206         * 【TAG】前後の行データが一致している場合、マージするかどうか[true/false]指定します(初期値:false)。
    207         *
    208         * @og.tag
    209         * これは、ガントデータが同一グループの場合に、ガントとして一連に表示するようにします。
    210         * この段階では、階段並べのままです。
    211         * 前後に付ける場合（一列表示）は、verticalShift = "true" を指定してください。
    212         * (adjustGanttTable.jsの)初期値は、false:行わない です。
    213         *
    214         * @param   margeRows 複数行のマージ可否 [true:する/false:しない]
    215         * @see         #setVerticalShift( String )
    216         */
    217        public void setMargeRows( final String margeRows ) {
    218                tag.add( "margeRows",nval( getRequestParameter( margeRows ),null ) );
    219        }
    220
    221        /**
    222         * 【TAG】左の固定列の列数（テーブル２分割機能）を指定します。
    223         *
    224         * @og.tag
    225         * １段組でも２段組でも、固定したいカラム数を指定します。
    226         *
    227         * @param   fixedCols 固定したいカラム数
    228         */
    229        public void setFixedCols( final String fixedCols ) {
    230                tag.add( "fixedCols",nval( getRequestParameter( fixedCols ),null ) );
    231        }
    232
    233        /**
    234         * 【TAG】viewタグの出力に番号列が出力されているかどうか（出力されていない場合:delete）を指定します。
    235         *
    236         * @og.tag
    237         * viewタグで、numberType属性で、行番号を表示しない設定を行った場合、ここでも、viewNumberType="delete" を
    238         * 指定する必要があります。
    239         *
    240         * @param   viewNumberType viewタグ番号列タイプ
    241         */
    242        public void setViewNumberType( final String viewNumberType ) {
    243                tag.add( "viewNumberType",nval( getRequestParameter( viewNumberType ),null ) );
    244        }
    245
    246        /**
    247         * 【TAG】ガントの上下ずらし表示を行うかどうか[true/false]指定します(初期値=true:行う)。
    248         *
    249         * @og.tag
    250         * 通常のガント表示では、データは階段並べで表示されます。
    251         * 同一属性のガントを横一列に表示したい場合は、この属性に、"true" を指定します。
    252         * (adjustGanttTable.jsの)初期値は、true:行う です。
    253         *
    254         * @param   verticalShift 上下ずらし表示 [true:する/false:しない]
    255         */
    256        public void setVerticalShift( final String verticalShift ) {
    257                tag.add( "verticalShift",nval( getRequestParameter( verticalShift ), null ) );
    258        }
    259
    260        /**
    261         * 【TAG】ガントバーの間の左区切りスペースをピクセルで指定します(初期値:null)。
    262         *
    263         * @og.tag
    264         * ガント表示で、margeRows="true" (複数行のマージを行う)場合、前後のガントが同一色の
    265         * 場合、くっついて表示されます。これを、verticalShift="true" (ガントの上下ずらし表示を行う)
    266         * 場合は、個々のバーが判別可能ですが、そうしたくないケースでは、個々の判別ができません。
    267         * そこで、特殊なケースとして、個々の判別が付く様に、ガントバーの長さを調整したいケースが
    268         * あります。
    269         *
    270         * この属性は、バーの左に指定の空欄を用意します。
    271         * 初期値は、null(属性を出力しない) です。
    272         *
    273         * @og.rev 5.6.4.2 (2013/05/17) 新規追加
    274         *
    275         * @param   paddingLeft 左区切りスペース
    276         * @see         #setPaddingRigth( String )
    277         */
    278        public void setPaddingLeft( final String paddingLeft ) {
    279                tag.add( "paddingLeft",nval( getRequestParameter( paddingLeft ),null ) );
    280        }
    281
    282        /**
    283         * 【TAG】ガントバーの間の右区切りスペースをピクセルで指定します(初期値:null)。
    284         *
    285         * @og.tag
    286         * ガント表示で、margeRows="true" (複数行のマージを行う)場合、前後のガントが同一色の
    287         * 場合、くっついて表示されます。これを、verticalShift="true" (ガントの上下ずらし表示を行う)
    288         * 場合は、個々のバーが判別可能ですが、そうしたくないケースでは、個々の判別ができません。
    289         * そこで、特殊なケースとして、個々の判別が付く様に、ガントバーの長さを調整したいケースが
    290         * あります。
    291         *
    292         * この属性は、バーの右に指定の空欄を用意します。
    293         * 初期値は、null(属性を出力しない) です。
    294         *
    295         * @og.rev 5.6.4.2 (2013/05/17) 新規追加
    296         *
    297         * @param   paddingRigth 左区切りスペース
    298         * @see         #setPaddingLeft( String )
    299         */
    300        public void setPaddingRigth( final String paddingRigth ) {
    301                tag.add( "paddingRigth",nval( getRequestParameter( paddingRigth ),null ) );
    302        }
    303
    304        /**
    305         * 【TAG】積上ガント:ガント部分の表示を行うかどうか[true/false]指定します(初期値=true:表示する)。
    306         *
    307         * @og.tag
    308         * falseとするとガント部分を表示せず、積上げのみ表示します。
    309         * (adjustGanttTable.jsの)初期値は、true:表示する。
    310         *
    311         * @param   viewGantt ガント部分の表示可否 [true:する/false:しない]
    312         */
    313        public void setViewGantt( final String viewGantt ) {
    314                tag.add( "viewGantt",nval( getRequestParameter( viewGantt ), null ) );
    315        }
    316
    317        /**
    318         * 【TAG】積上ガント:休日に積上げるかどうか[true/false]指定します(初期値=true:積上げる)。
    319         *
    320         * @og.tag
    321         * 休日に積上る場合、平日、休日を合わせた日数で、工数の平準化が行われます。
    322         * false:積上ない を指定した場合、平日のみで工数が加算されます。
    323         * 積上は、日付関係の場合(zoom=DAY)のみ有効で、時間単位の積上機能はありません。
    324         * (adjustGanttTable.jsの)初期値は、true:積上げる。
    325         *
    326         * @param   stackHoliday 休日に積上可否 [true:する/false:しない]
    327         */
    328        public void setStackHoliday( final String stackHoliday ) {
    329                tag.add( "stackHoliday",nval( getRequestParameter( stackHoliday ), null ) );
    330        }
    331
    332        /**
    333         * 【TAG】一覧の背景色の縞々模様を再作成するか[true/false]指定します(初期値:true)。
    334         *
    335         * @og.tag
    336         * 背景色の縞々模様(ゼブラ模様)を作成する場合は、"true" にセットします。
    337         * margeRows='true'の場合は使用します。
    338         * (adjustGanttTable.jsの)初期値は、true:再作成する。
    339         *
    340         * @param   useBgColor 背景色ゼブラ可否 [true:する/false:しない]
    341         * @see         #setMargeRows( String )
    342         */
    343        public void setUseBgColor( final String useBgColor ) {
    344                tag.add( "useBgColor",nval( getRequestParameter( useBgColor ), null ) );
    345        }
    346
    347        /**
    348         * 【TAG】積上ガント:積上げ高さの計算方法[0:設定値基準/1:最大値基準]指定します(初期値:1:最大値基準)。
    349         *
    350         * @og.tag
    351         * 積上ガントの大きさを、設定値を基準にするか、最大値を基準にするか指定します。
    352         * 1:最大値基準は、高さ固定と考えられます。つまり、積上ガントの最大が1.0の場合、
    353         * 設定値が、0.1 なら、0.1 分の値としてつみあがります。１００分率での表示に適しています。
    354         * 0:設定値基準は、高さ可変です。つまり、積上ガントの設定値の最大が 0.2 の場合、
    355         * 0.1 なら、半分の所まで積みあがります。値に最大値がなく、各積上結果の相対レベルが
    356         * 見たい場合に、適しています。
    357         *
    358         * 0:能力設定値を基準に積上げ高さの計算を行う。
    359         * 1:行の最大値を基準に積上げ高さの計算を行う。
    360         * (adjustGanttTable.jsの)初期値は、1:最大値基準 です。
    361         *
    362         * @param   viewMode 積上げ高さの計算方法 [0:設定値基準/1:最大値基準]
    363         */
    364        public void setViewMode( final String viewMode ) {
    365                tag.add( "viewMode",nval( getRequestParameter( viewMode ),null ) );
    366        }
    367
    368        /**
    369         * 【TAG】積上ガント:正常範囲の上限となる工数を指定します(初期値:1)。
    370         *
    371         * @og.tag
    372         * 正常範囲の上限となる工数を超えると積上げの色が変化します。
    373         * (adjustGanttTable.jsの)初期値は、1 です。
    374         *
    375         * @param   stdUpper 正常範囲の上限工数
    376         * @see         #setStdCost( String )
    377         */
    378        public void setStdUpper( final String stdUpper ) {
    379                tag.add( "stdUpper",nval( getRequestParameter( stdUpper ),null ) );
    380        }
    381
    382        /**
    383         * 【TAG】積上ガント:行の2/3の高さとなる工数を指定します(初期値:1)。
    384         *
    385         * @og.tag
    386         * 正常範囲の上限を初期値の "1" に設定し、この値を初期値の "1" を使うと、
    387         * "1" の高さは、行の2/3の高さになるように計算されます。つまり、オーバー分は、
    388         * 全体の 1/3 以下の場合に、ちょうど良い感じになります。
    389         * オーバーする量との関係で指定します。
    390         * (adjustGanttTable.jsの)初期値は、1 です。
    391         *
    392         * @param   stdCost 正常範囲の上限
    393         * @see         #setStdUpper( String )
    394         */
    395        public void setStdCost( final String stdCost ) {
    396                tag.add( "stdCost",nval( getRequestParameter( stdCost ),null ) );
    397        }
    398
    399        /**
    400         * 【TAG】積上ガント:正常範囲の下限となる工数を指定します(初期値:0)。
    401         *
    402         * @og.tag
    403         * 正常範囲の下限となる工数を下回ると積上げの色が変化します。
    404         * (adjustGanttTable.jsの)初期値は、0 です。
    405         *
    406         * @param   stdLower 正常範囲の下限工数
    407         */
    408        public void setStdLower( final String stdLower ) {
    409                tag.add( "stdLower",nval( getRequestParameter( stdLower ),null ) );
    410        }
    411
    412        /**
    413         * タグの名称を、返します。
    414         * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
    415         *
    416         * @return  タグの名称
    417         * @og.rtnNotNull
    418         */
    419        @Override
    420        protected String getTagName() {
    421                return "iGantt" ;
    422        }
    423
    424        /**
    425         * このオブジェクトの文字列表現を返します。
    426         * 基本的にデバッグ目的に使用します。
    427         *
    428         * @return このクラスの文字列表現
    429         * @og.rtnNotNull
    430         */
    431        @Override
    432        public String toString() {
    433                return ToString.title( this.getClass().getName() )
    434                                .println( "VERSION"             ,VERSION        )
    435                                .println( "tag"                 ,tag.makeTag()  )
    436                                .println( "Other..."    ,getAttributes().getAttribute() )
    437                                .fixForm().toString() ;
    438        }
    439}