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 * iGanttBar タグは、TDタグの繰返し部に記述することで、個々のガントのタスクを作成します。
025 * これを使用する場合は、iGant タグを全体に一つ指定する必要があります。
026 *
027 * @og.formSample
028 * ●形式:<og:iGanttBar  ... />
029 * ●body:なし
030 * ●前提:headタグで、adjustEvent="Gantt" を指定してください。
031 *
032 * ●Tag定義:
033 *   <og:iGanttBar
034 *       type         【TAG】ガント要素のタイプ(0:マイルストーン 1:バー )(必須)
035 *       color        【TAG】バーの色(マイルストーンの場合は不要)
036 *       colorNo      【TAG】バーの色番号で指定します
037 *       src          【TAG】マイルストーンのアイコン画像(URIより設定)
038 *       start        【TAG】開始日(YYYYMMDD)、または開始時間(YYYYMMDDHH24MM)
039 *       end          【TAG】終了日(YYYYMMDD)、または終了時間(YYYYMMDDHH24MM)
040 *       text         【TAG】ガント要素の注釈メッセージ。
041 *       href         【TAG】入力した場合はガントにリンクを付加します。
042 *       target       【TAG】hrefを指定した場合に付加されるリンクのターゲット
043 *       barLink      【TAG】hrefで付加されるリンクの範囲にバー本体を含めるかどうか[true/false]を指定します(初期値:false)
044 *       startInput   【保留】ガント要素の開始日に紐付く入力欄(開始日または終了日に紐付く入力欄が設定しなければガント要素は動かせない)
045 *       endInput     【保留】ガント要素の終了日に紐付く入力欄(開始日または終了日に紐付く入力欄が設定しなければガント要素は動かせない)
046 *       chbox        【保留】行選択のチェックボックス 設定値:[ROW.ID]
047 *       cost         【TAG】開始日、終了日を利用して積上げられる工数を指定します。
048 *       capacity     【TAG】積上げの最大値(キャパシティ)を指定します。
049 *       debug        【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
050 *   />
051 *
052 * ●使用例
053 *   (通常ガント)
054 *  <og:view
055 *      viewFormType = "HTMLCustomTable"
056 *      command      = "{@command}"
057 *      writable     = "false"
058 *      useScrollBar = "false"
059 *  >
060 *    <og:thead rowspan="2">
061 *      <tr>
062 *          <td>[NOORDER]</td>
063 *          <td rowspan="2" class="gantt zoom{@VZOOM}" style="line-height:normal;text-align:left;background-image: url('../image/ganttBG{@VZOOM}.gif');" >
064 *              <div style="position:relative;left:0px;z-index:101; " height="100%" width="100%" >
065 *                  <og:ganttHeader
066 *                      startDate       = "{@startDate}"
067 *                      endDate         = "{@endDate}"
068 *                      zoom            = "{@VZOOM}"
069 *                      daySpan         = "{@daySpan}"
070 *                  />
071 *              </div>
072 *          </td>
073 *      </tr>
074 *    </og:thead>
075 *    <og:tbody rowspan="2">
076 *      <tr>
077 *          <td>[NOORDER]</td>
078 *          <td rowspan="2" class="gantt zoom{@VZOOM}" style="text-align:left;background-image: url('../image/ganttBG{@VZOOM}.gif');" >
079 *              <og:iGanttBar type="1" colorNo="[COLOR]" start="[DYORDER]" end="[DYNOKI]" text="[PN]" />
080 *              <og:iGanttBar type="0" src="../image/dia_blue.gif" start="[DYORDER]"      text="開始" />
081 *              <og:iGanttBar type="0" src="../image/dia_red.gif"  end="[DYNOKI]"         text="終了" />
082 *          </td>
083 *      </tr>
084 *    </og:tbody>
085 *  </og:view>
086 *    
087 *   <og:iGantt
088 *       margeRows      = "true"
089 *       fixedCols      = "1"
090 *   />
091 *
092 *   (積み上げガント)
093 *  <og:view
094 *      viewFormType = "HTMLStackedGanttTable"
095 *      command      = "{@command}"
096 *      writable     = "false"
097 *      useScrollBar = "false"
098 *      useParam     = "true"
099 *      numberType   = "none"
100 *  >
101 *  <og:stackParam
102 *      stackColumns = "NOORDER"
103 *  />
104 * 
105 *    <og:thead rowspan="2">
106 *      <tr>
107 *          <td>[NOORDER]</td>
108 *          <td>[PN]</td>
109 *          <td rowspan="2" class="gantt zoom{@SZOOM}" style="text-align:left;background-image: url('../image/ganttBG{@SZOOM}.gif');" >
110 *              <div style="position:relative;left:0px;z-index:101; " height="100%" width="100%" >
111 *                  <og:ganttHeader
112 *                      startDate   = "{@startDate}"
113 *                      endDate     = "{@endDate}"
114 *                      zoom        = "{@SZOOM}"
115 *                      calDB       = "GE13"
116 *                      arg1        = "A"
117 *                  />
118 *              </div>
119 *          </td>
120 *      </tr>
121 *    </og:thead>
122 *    <og:tbody rowspan="2">
123 *      <tr>
124 *          <td>[NOORDER]</td>
125 *          <td>[PN]</td>
126 *          <td rowspan="2" class="gantt zoom{@VZOOM}" style="text-align:left;background-image: url('../image/ganttBG{@VZOOM}.gif');" >
127 *              <iGanttBar type="1" colorNo="[COLOR]" start="[DYORDER]" end="[DYNOKI]"  text="[COSTCLM]"
128 *                    cost="[COSTCLM]" capacity="[CAPACITY]" />
129 *              <og:iGanttBar type="0" src="../image/dia_blue.gif" start="[DYORDER]"      text="開始" />
130 *          </td>
131 *      </tr>
132 *    </og:tbody>
133 *  </og:view>
134 *    
135 *   <og:iGantt
136 *       margeRows      = "true"
137 *       fixedCols      = "1"
138 *       verticalShift  = "false"
139 *       viewGantt      = "{@viewGantt}"
140 *       stackHoliday   = "{@stackHoliday}"
141 *       useBgColor     = "true"
142 *       viewMode       = "2"
143 *   />
144 *
145 * @og.rev 5.6.3.2 (2013/04/12) 新規作成
146 * @og.group 画面部品
147 *
148 * @version  5.0
149 * @author       Kazuhiko Hasegawa
150 * @since    JDK6.0,
151 */
152public class ViewIGanttBarTag extends CommonTagSupport {
153        //* このプログラムのVERSION文字列を設定します。   {@value} */
154        private static final String VERSION = "5.6.3.2 (2013/04/12)" ;
155
156        private static final long serialVersionUID = 563220130412L ;
157
158        private TagBuffer tag = new TagBuffer( "iGanttBar" ) ;
159
160        /**
161         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
162         *
163         * @return      後続処理の指示
164         */
165        @Override
166        public int doEndTag() {
167                debugPrint();           // 4.0.0 (2005/02/28)
168
169                jspPrint( tag.makeTag() );
170
171                return EVAL_PAGE ;              // ページの残りを評価する。
172        }
173
174        /**
175         * タグリブオブジェクトをリリースします。
176         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
177         *
178         */
179        @Override
180        protected void release2() {
181                super.release2();
182                tag = new TagBuffer( "iGanttBar" );
183        }
184
185        /**
186         * 【TAG】ガント要素のタイプ(0:マイルストーン 1:バー )を指定します(必須)。
187         *
188         * @og.tag
189         * 0:マイルストーン を指定すると、その日(時間)に、マーカーがされます。
190         * ガントのような期間ではなく、そのポイントを表すのに使用します。
191         * 例えば、受注日、納期 などの設定値です。
192         * start か end どちらかの指定で構いません。
193         * start を使用した場合は、指定日(時間)の前方に、endを使用した場合は、
194         * 指定日(時間)の後方にマーカーが置かれます。
195         *
196         * @param   type ガント要素のタイプ[0:マイルストーン/1:バー]
197         */
198        public void setType( final String type ) {
199                tag.add( "type",StringUtil.nval( getRequestParameter( type ),null ) );
200        }
201
202        /**
203         * 【TAG】ガント要素(バー)の色コードを設定します。
204         *
205         * @og.tag
206         * color は、ガント要素の色コードを設定します。
207         * type="0:マイルストーン" の場合は不要です。
208         * このコードは、予め決められた色画像を呼び出しますので、任意の色が使えるという事ではありません。
209         * 色指定は、横棒の場合は、image/W_色コード.png の画像を使います。
210         * 色コード と 色番号が同時に指定された場合は、色コード が優先されます。
211         *
212         * type=2:差分枠 は、value > baseVal の場合は、超過を、value < baseValの場合は、不足を表します。
213         * <table border="1" frame="box" rules="all">
214         *   <caption>色番号 対応表</caption>
215     *   <tr><th>色番号</th><th>設定値    </th><th>棒色   </th><th> </th><th>横棒サンプル</th></tr>
216     *   <tr><td> 0    </td><td>blue      </td><td>青     </td><td> </td><td style="background-image:url(../image/W_blue.png);">    </td></tr>
217     *   <tr><td> 1    </td><td>black     </td><td>黒     </td><td> </td><td style="background-image:url(../image/W_black.png);">   </td></tr>
218     *   <tr><td> 2    </td><td>brown     </td><td>茶     </td><td> </td><td style="background-image:url(../image/W_brown.png);">   </td></tr>
219     *   <tr><td> 3    </td><td>green     </td><td>緑     </td><td> </td><td style="background-image:url(../image/W_green.png);">   </td></tr>
220     *   <tr><td> 4    </td><td>lightblue </td><td>薄青   </td><td> </td><td style="background-image:url(../image/W_lightblue.png);">  </td></tr>
221     *   <tr><td> 5    </td><td>lightgreen</td><td>薄緑   </td><td> </td><td style="background-image:url(../image/W_lightgreen.png);">  </td></tr>
222     *   <tr><td> 6    </td><td>orange    </td><td>オレンジ</td><td> </td><td style="background-image:url(../image/W_orange.png);">  </td></tr>
223     *   <tr><td> 7    </td><td>pink      </td><td>ピンク </td><td> </td><td style="background-image:url(../image/W_pink.png);">   </td></tr>
224     *   <tr><td> 8    </td><td>purple    </td><td>紫     </td><td> </td><td style="background-image:url(../image/W_purple.png);">   </td></tr>
225     *   <tr><td> 9    </td><td>red       </td><td>赤     </td><td> </td><td style="background-image:url(../image/W_red.png);">        </td></tr>
226     *   <tr><td> 10   </td><td>yellow    </td><td>黄     </td><td> </td><td style="background-image:url(../image/W_yellow.png);">  </td></tr>
227     *   <tr><td> 11   </td><td>navy      </td><td>濃紺   </td><td> </td><td style="background-image:url(../image/W_navy.png);">   </td></tr>
228     *   <tr><td> 12   </td><td>teal      </td><td>青緑   </td><td> </td><td style="background-image:url(../image/W_teal.png);">   </td></tr>
229     *   <tr><td> 13   </td><td>gray      </td><td>灰     </td><td> </td><td style="background-image:url(../image/W_gray.png);">     </td></tr>
230     *   <tr><td> 14   </td><td>indigo    </td><td>藍     </td><td> </td><td style="background-image:url(../image/W_indigo.png);">  </td></tr>
231     *   <tr><td> 15   </td><td>slategray </td><td>鉄色   </td><td> </td><td style="background-image:url(../image/W_slategray.png);">  </td></tr>
232     *   <tr><td> 16   </td><td>chocorlate</td><td>チョコレート</td><td> </td><td style="background-image:url(../image/W_chocorlate.png);">  </td></tr>
233     *   <tr><td> 17   </td><td>darkgreen </td><td>深緑   </td><td> </td><td style="background-image:url(../image/W_darkgreen.png);">  </td></tr>
234     *   <tr><td> 18   </td><td>violet    </td><td>すみれ </td><td> </td><td style="background-image:url(../image/W_violet.png);">  </td></tr>
235     *   <tr><td> 19   </td><td>darkslategray</td><td>深鉄色</td><td> </td><td style="background-image:url(../image/W_darkslategray.png);">  </td></tr>
236     *   <tr><td> 20   </td><td>lime      </td><td>緑     </td><td> </td><td style="background-image:url(../image/W_lime.png);">     </td></tr>
237     *   <tr><td> 21   </td><td>aqua      </td><td>水色   </td><td> </td><td style="background-image:url(../image/W_aqua.png);">   </td></tr>
238     *   <tr><td> 22   </td><td>maroon    </td><td>ひわだいろ</td><td> </td><td style="background-image:url(../image/W_maroon.png);">  </td></tr>
239     *   <tr><td> 23   </td><td>olive     </td><td>オリーブ</td><td> </td><td style="background-image:url(../image/W_olive.png);">   </td></tr>
240     *   <tr><td> 24   </td><td>silver    </td><td>銀     </td><td> </td><td style="background-image:url(../image/W_silver.png);">  </td></tr>
241     *   <tr><td> 25   </td><td>fuchsia   </td><td>赤紫   </td><td> </td><td style="background-image:url(../image/W_fuchsia.png);">  </td></tr>
242     *   <tr><td colspan="6"> </td></tr>
243     *   <tr><td> BK   </td><td>black2    </td><td>黒     </td><td> </td><td style="background-image:url(../image/W_black2.png);">  </td></tr>
244     *   <tr><td> WT   </td><td>white2    </td><td>白     </td><td> </td><td style="background-image:url(../image/W_white2.png);">  </td></tr>
245     *   <tr><td> BL   </td><td>blue2     </td><td>青     </td><td> </td><td style="background-image:url(../image/W_blue2.png);">    </td></tr>
246     *   <tr><td> RD   </td><td>red2      </td><td>赤     </td><td> </td><td style="background-image:url(../image/W_red2.png);">    </td></tr>
247     *   <tr><td> YL   </td><td>yellow2   </td><td>黄     </td><td> </td><td style="background-image:url(../image/W_yellow2.png);">  </td></tr>
248         * </table>
249         *
250         * @param   color グラフ要素の位置、長さ
251         */
252        public void setColor( final String color ) {
253                tag.add( "color",StringUtil.nval( getRequestParameter( color ),null ) );
254        }
255
256        /**
257         * 【TAG】グラフ要素の色番号を設定します。
258         *
259         * @og.tag
260         * 色番号は、色コードを直接指定するのではなく、番号で指定する場合に使用します。
261         * 棒グラフ要素(type="1"(横棒),"6"(縦棒))の色を設定します。
262         * "1~25 , BK,WT,BL,RD,YL" の色番号で指定します。
263         * 色番号は、与えた数字を内部色数で割り算した余を使用しますので、連番の場合でも
264         * 繰返し使われます。特殊な色として、BK,WT,BL,RD,YLは、番号ではなく記号で指定できます。
265         * 色コード と 色番号が同時に指定された場合は、色コード が優先されます。
266         *
267         * @param   clrNo グラフ要素の描画開始位置
268         * @see         #setColor( String )
269         */
270        public void setColorNo( final String clrNo ) {
271                tag.add( "colorNo",StringUtil.nval( getRequestParameter( clrNo ),null ) );
272        }
273
274        /**
275         * 【TAG】マイルストーンのアイコン画像(URIより設定)を設定します。
276         *
277         * @og.tag
278         * type="0:マイルストーン" の場合、表示するアイコンイメージの所在を指定します。
279         * 例:"../image/xxx.png" 
280         *
281         * @param   src マイルストーンのアイコン画像
282         */
283        public void setSrc( final String src ) {
284                tag.add( "src",StringUtil.nval( getRequestParameter( src ),null ) );
285        }
286
287        /**
288         * 【TAG】開始日(YYYYMMDD)、または開始時間(YYYYMMDDHH24MM)を設定します。
289         *
290         * @og.tag
291         * type="1:バー" の場合は、バー表示の場合の書き始め(開始)を指定します。
292         * この値は、バーでは、「含む」になります。
293         * type="0:マイルストーン" の場合は、マイルストンを左端に表示します。
294         *
295         * @param   start 開始日(YYYYMMDD)、または開始時間(YYYYMMDDHH24MM)
296         * @see         #setType( String )
297         * @see         #setEnd( String )
298         */
299        public void setStart( final String start ) {
300                tag.add( "start",StringUtil.nval( getRequestParameter( start ),null ) );
301        }
302
303        /**
304         * 【TAG】終了日(YYYYMMDD)、または終了時間(YYYYMMDDHH24MM)を設定します。
305         *
306         * @og.tag
307         * type="1:バー" の場合は、バー表示の場合の書き終わり(終了)を指定します。
308         * この値は、日付か時刻かで「含む」/「含まない」が異なります。
309         * 日付の場合は、この値を「含む」です。例えば、4/12 を指定した場合、4/12は含みます。
310         * 時刻の場合は、「含まない」です。4/12 070000 を指定した場合は、午前7時は含まないので、
311         * 6時59分59秒までのバーが引かれます。
312         * type="0:マイルストーン" の場合は、マイルストンを右端に表示します。
313         *
314         * @param   end 終了日(YYYYMMDD)、または終了時間(YYYYMMDDHH24MM)
315         * @see         #setType( String )
316         * @see         #setStart( String )
317         */
318        public void setEnd( final String end ) {
319                tag.add( "end",StringUtil.nval( getRequestParameter( end ),null ) );
320        }
321
322        /**
323         * 【TAG】バー上に表示するテキストを指定します。
324         *
325         * @og.tag
326         * バーの上に、値などの文字を重ねて表示できます。
327         *
328         * @param   text バー上に表示するテキスト
329         */
330        public void setText( final String text ) {
331                tag.add( "text",StringUtil.nval( getRequestParameter( text ),null ) );
332        }
333
334        /**
335         * 【TAG】リンク作成時の値を設定します。
336         *
337         * @og.tag
338         * バーの上の文字に対して、リンクを作成できます。
339         *
340         * @param   href バー上に表示するテキスト
341         * @see         #setTarget( String )
342         */
343        public void setHref( final String href ) {
344                tag.add( "href",StringUtil.nval( getRequestParameter( href ),null ) );
345        }
346
347        /**
348         * 【TAG】リンク作成時のターゲット名を指定します。
349         *
350         * @og.tag
351         * バーの上の文字に対して、リンクを作成するときの、ターゲット名を指定できます。
352         *
353         * @param   target リンク作成時のターゲット
354         * @see         #setHref( String )
355         */
356        public void setTarget( final String target ) {
357                tag.add( "target",StringUtil.nval( getRequestParameter( target ),null ) );
358        }
359
360        /**
361         * 【TAG】hrefで付加されるリンクの範囲にバー本体を含めるかどうか[true/false]を指定します(初期値:false)。
362         *
363         * @og.tag
364         * true を指定すると、hrefで付加されるリンクの範囲にバー本体を含めます。
365         *
366         * @param   barLink リンクの範囲にバー本体を含めるかどうか[true/false]
367         * @see         #setHref( String )
368         */
369        public void setBarLink( final String barLink ) {
370                tag.add( "barLink",StringUtil.nval( getRequestParameter( barLink ),null ) );
371        }
372
373        /**
374         * 【保留】ガント要素の開始日に紐付く入力欄を指定します。
375         *
376         * @og.tag
377         * この入力欄がないと、ガント要素は動かせません。
378         *
379         * @param   startInput 開始日に紐付く入力欄
380         * @see         #setStart( String )
381         */
382        public void setStartInput( final String startInput ) {
383                tag.add( "startInput",StringUtil.nval( getRequestParameter( startInput ),null ) );
384        }
385
386        /**
387         * 【保留】ガント要素の終了日に紐付く入力欄を指定します。
388         *
389         * @og.tag
390         * この入力欄がないと、ガント要素は動かせません。
391         *
392         * @param   endInput 終了日に紐付く入力欄
393         * @see         #setEnd( String )
394         */
395        public void setEndInput( final String endInput ) {
396                tag.add( "endInput",StringUtil.nval( getRequestParameter( endInput ),null ) );
397        }
398
399        /**
400         * 【TAG】行選択のチェックボックスを指定します。
401         *
402         * @og.tag
403         * 例えば、[ROW.ID] を指定する事で、選択行を指定する事ができます。
404         *
405         * @param   chbox 行選択のチェックボックス
406         */
407        public void setChbox( final String chbox ) {
408                tag.add( "chbox",StringUtil.nval( getRequestParameter( chbox ),null ) );
409        }
410
411        /**
412         * 【TAG】積み上げガントの工数を指定します。
413         *
414         * @og.tag
415         * 積み上げガントの工数を指定します。
416         * 開始日、終了日を利用して積上げ計算されます。
417         *
418         * @param   cost 積み上げガントの工数
419         */
420        public void setCost( final String cost ) {
421                tag.add( "cost",StringUtil.nval( getRequestParameter( cost ),null ) );
422        }
423
424        /**
425         * 【TAG】積上げの最大値(キャパシティ)を指定します。
426         *
427         * @og.tag
428         * 最大値を超えた場合は、マーカーされます。
429         *
430         * @param   capacity 積み上げガントの工数
431         */
432        public void setCapacity( final String capacity ) {
433                tag.add( "capacity",StringUtil.nval( getRequestParameter( capacity ),null ) );
434        }
435
436        /**
437         * タグの名称を、返します。
438         * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
439         *
440         * @return  タグの名称
441         */
442        @Override
443        protected String getTagName() {
444                return "iGanttBar" ;
445        }
446
447        /**
448         * このオブジェクトの文字列表現を返します。
449         * 基本的にデバッグ目的に使用します。
450         *
451         * @return このクラスの文字列表現
452         */
453        @Override
454        public String toString() {
455                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
456                                .println( "VERSION"             ,VERSION        )
457                                .println( "tag"                 ,tag.makeTag()  )
458                                .println( "Other..."    ,getAttributes().getAttribute() )
459                                .fixForm().toString() ;
460        }
461}