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