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