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