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.plugin.view;
017
018import org.opengion.hayabusa.common.HybsSystem;
019import org.opengion.fukurou.util.StringUtil;
020import org.opengion.fukurou.util.XHTMLTag;
021import org.opengion.hayabusa.html.AbstractViewForm;
022import org.opengion.hayabusa.html.ViewCalendarParam;
023import static org.opengion.fukurou.system.HybsConst.BR; // 6.1.0.0 (2014/12/26) refactoring
024
025import java.util.Calendar;
026
027/**
028 * 1ヶ月分のカレンダー形式で、検索結果を表示する、カレンダー表示クラスです。
029 *
030 * AbstractViewForm により、setter/getterメソッドのデフォルト実装を提供しています。
031 * 各HTMLのタグに必要な setter/getterメソッドのみ,追加定義しています。
032 *
033 * AbstractViewForm を継承している為,ロケールに応じたラベルを出力させる事が出来ます。
034 *
035 * @og.group 画面表示
036 *
037 * @version  4.0
038 * @author   Kazuhiko Hasegawa
039 * @since    JDK5.0,
040 */
041public class ViewForm_HTMLCalendar extends AbstractViewForm {
042        /** このプログラムのVERSION文字列を設定します。   {@value} */
043        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
044
045        private static final String[] WEEK_JA = { "日" ,"月" ,"火" ,"水" ,"木" ,"金" ,"土" ,"日" ,"月" };        // 6.4.1.1 (2016/01/16) WEEK_ja  → WEEK_JA  refactoring
046        private static final String[] WEEK_EN = { "SUN","MON","TUE","WED","THU","FRI","SAT","SUN","MON" };      // 6.4.1.1 (2016/01/16) WEEK_en  → WEEK_EN  refactoring
047        private static final String[] WEEK_MK = { "SUN","",   "",   "",   "",   "",   "SAT","SUN",""    };
048
049        private String[] week              ;
050        private String[] viewKeys          ;            // カレンダを指定するキー配列        // 3.6.0.0 (2004/09/17)
051        private String   ymKey             ;            // 年月のカラム名
052        private String   dayKey            ;            // 休日(0:通常、1:休日)のカラム名
053        private String   valKey            ;            // カレンダに表示する値のカラム名
054        private boolean  valueBrFlag   ;                // 日付けと値の間に、BRタグを入れるかどうか
055        private int              firstWeek         ;            // 曜日の開始(0:日曜 1:月曜)
056        private int              columnSize        ;            // カレンダの横方向の繰り返し数       // 3.6.0.0 (2004/09/17)
057
058        /**
059         * デフォルトコンストラクター
060         *
061         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
062         */
063        public ViewForm_HTMLCalendar() { super(); }             // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
064
065        /**
066         * DBTableModel から HTML文字列を作成して返します。
067         * startNo(表示開始位置)から、pageSize(表示件数)までのView文字列を作成します。
068         * 表示残りデータが pageSize 以下の場合は,残りのデータをすべて出力します。
069         *
070         * @og.rev 3.5.2.1 (2003/10/27) 属性値の指定のシングルクオートをダブルクオートに変更。
071         * @og.rev 3.6.0.0 (2004/09/17) 複数カレンダに対応
072         * @og.rev 3.6.0.5 (2004/10/18) calenderParam の viewKeys バグ対応。
073         * @og.rev 3.7.0.1 (2005/01/31) 全件チェックコントロール処理変更
074         *
075         * @param  startNo    表示開始位置
076         * @param  pageSize   表示件数
077         *
078         * @return  DBTableModelから作成された HTML文字列
079         * @og.rtnNotNull
080         */
081        public String create( final int startNo, final int pageSize )  {
082                if( getRowCount() == 0 ) { return ""; } // 暫定処置
083
084                paramInit();
085
086                final int lastNo = getLastNo( startNo, pageSize );
087
088                final StringBuilder out = new StringBuilder( BUFFER_LARGE )
089                        .append( "<table><tr>" ).append( CR );
090
091                final boolean onlyOne = ( lastNo - startNo ) == 1 ;     // 互換性のため、1件の処理のみ変更
092
093                // 3.7.0.1 (2005/01/31) 全件チェックコントロール処理変更
094                if( ! onlyOne && isUseCheckControl() && "checkbox".equals( getSelectedType() ) ) {
095                        out.append( "<tr><td>" ).append( getAllCheckControl() ).append( "</td></tr>");
096                }
097
098                for( int row=startNo; row<lastNo; row++ ) {
099                        out.append( "<td valign=\"top\">" );
100
101                        if( isWritable( row ) ) {
102                                if( onlyOne ) {
103                                        out.append( XHTMLTag.hidden( HybsSystem.ROW_SEL_KEY,String.valueOf( row ) ) )
104                                                .append( CR );
105                                }
106                                else {
107                                        out.append( "<input type=\"" ).append( getSelectedType() )
108                                                .append( "\" name=\"" ).append( HybsSystem.ROW_SEL_KEY ).append( '"' );
109                                        if( isChecked( row ) ) { out.append( " checked=\"checked\"" ); }
110                                        out.append( " value=\"" ).append( row ).append( "\" />" );
111                                }
112                        }
113
114                        // 3.6.0.5 (2004/10/18)
115                        for( int col=0; col<viewKeys.length; col++ ) {
116                                if( "_".equals( viewKeys[col] ) ) { continue; }
117                                final int newCol = getColumnNo( viewKeys[col] );
118                                out.append("<span id=\"label\">")
119                                        .append( getColumnLabel( newCol ) )
120                                        .append( ":</span>" )
121                                        .append( getValueLabel(row,newCol) )
122                                        .append( "&nbsp;" );
123                        }
124                        out.append( BR )
125                                .append( makeCalendarData( row ) )
126                                .append( "</td>" );
127                        if( (row+1) % columnSize == 0 ) {
128                                out.append( "</tr><tr>" ).append( CR );
129                        }
130                }
131                out.append( "</tr></table>" ).append( CR );
132
133                return out.toString();
134        }
135
136        /**
137         * DBTableModel の指定の行番号より、カレンダのHTML文字列を作成して返します。
138         *
139         * @og.rev 3.6.0.0 (2004/09/17) create( int startNo, int pageSize ) のロジックを移動
140         * @og.rev 3.6.0.5 (2004/10/18) 印刷時の罫線出力関連機能の追加。id 属性を出力します。
141         *
142         * @param  row    指定の行番号
143         *
144         * @return  指定の行番号のカレンダのHTML文字列
145         * @og.rtnNotNull
146         */
147        private String makeCalendarData( final int row ) {
148                final String yyyymm = getValue( row,getColumnNo( ymKey ));
149                final Calendar currentCal = getCalendar( yyyymm );
150
151                final StringBuilder out = new StringBuilder( BUFFER_LARGE )
152                        .append( "<table id=\"viewCalendar\" border=\"0\" cellpadding=\"1\" cellspacing=\"2\">" )
153                        .append( CR )                                                                           // 3.6.0.5 (2004/10/18)
154                        .append( " <tr><td class=\"titleStyle\" colspan=\"7\">" )
155                        .append( getValueLabel( row,getColumnNo( ymKey )) )
156                        .append( "</td></tr>" ).append( CR );
157
158                // 今月の最終日
159                final int daysInMonth = currentCal.getActualMaximum(Calendar.DAY_OF_MONTH);
160                // カレンダーの週の初めを設定する。月曜開始のカレンダーを作成するときに利用
161                currentCal.setFirstDayOfWeek( Calendar.SUNDAY + firstWeek );
162
163                // 週を表す番号  0~6 の間
164                int culDay = ( currentCal.get(Calendar.DAY_OF_WEEK)
165                                                + ( 7 - currentCal.getFirstDayOfWeek() ) ) % 7 ;
166
167                // 曜日欄を記述します。
168                out.append(" <tr>").append( CR );
169                for( int i=0; i<7; i++ ) {
170                        out.append("  <td width=\"14%\" class=\"dayHead" )
171                                .append( WEEK_MK[i+firstWeek] ).append( "\">" )
172                                .append( week[i+firstWeek] ).append( "</td>" )
173                                .append( CR );
174                }
175                out.append(" </tr>").append( CR )
176                        .append(" <tr>").append( CR );                          // 6.1.0.0 (2014/12/26) refactoring
177
178                // 第一週の日付欄の空きスペースの計算
179                if( culDay != 0 ) {
180                        out.append("  <td colspan=\"" ).append( culDay ).append( "\">&nbsp;</td>" ).append( CR );
181                }
182
183                // 日付欄を埋めます。
184                final String BR = valueBrFlag ? "<br />" : "" ;
185                for( int day=1; day <= daysInMonth; day++ ) {
186                        final int    daycol = getColumnNo( dayKey + day );      // 動的日付けカラム番号取得
187                        final String daylbl = getValueLabel( row,daycol,day );  // ローカルの日付けラベルを求めるメソッド
188                        // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
189                        final String vallbl = valKey == null ? "" : BR + getValueLabel( row,getColumnNo( valKey + day ) );              // 動的値カラム番号取得
190
191                        if( "1".equals( getValue( row,daycol ))) {
192                                out.append("  <td class=\"holyday\">" );
193                        } else {
194                                out.append("  <td class=\"day" )
195                                        .append( WEEK_MK[culDay+firstWeek] )
196                                        .append("\">");
197                        }
198                        out.append( daylbl )
199                                .append( vallbl )
200                                .append("</td>")
201                                .append( CR );
202
203                        // 週の終わりで、行を折り返す。
204                        if( culDay == 6 ) {
205                                out.append(" </tr>" ).append( CR )
206                                        .append( " <tr>").append( CR );                 // 6.1.0.0 (2014/12/26) refactoring
207                                culDay = 0;
208                        } else {
209                                culDay++;
210                        }
211                }
212
213                // 最終週の日付欄の空きスペースの計算
214                if( 7 != culDay ) {                             // 6.4.2.1 (2016/02/05) PMD refactoring. Useless parentheses.
215                        out.append( "  <td colspan=\"" ).append( 7-culDay ).append( "\">&nbsp;</td>" );
216                }
217                out.append( CR )
218                        .append( " </tr>" ).append( CR )
219                        .append( "</table>" ).append( CR );
220
221                return out.toString();
222        }
223
224        /**
225         * このビーに対する特別な初期化を行う。
226         *
227         * @og.rev 3.5.4.0 (2003/11/25) TableFormatter クラスを使用するように変更。
228         * @og.rev 3.5.5.9 (2004/06/07) ヘッダーの日付け表示に、Locale を加味できるように変更
229         * @og.rev 3.6.0.0 (2004/09/17) viewKeys , columnSize 属性の追加
230         *
231         */
232        private void paramInit() {
233
234                final String viewKeysCd = getParam( ViewCalendarParam.VIEW_KEYS                 ,ViewCalendarParam.VIEW_VALUES                  );      // 3.6.0.0 (2004/09/17)
235                ymKey                           = getParam( ViewCalendarParam.YM_KEY                    ,ViewCalendarParam.YM_VALUE                             );
236                dayKey                          = getParam( ViewCalendarParam.DAY_KEY                   ,ViewCalendarParam.DAY_VALUE                    );
237                valKey                          = getParam( ViewCalendarParam.VALUE_KEY                 ,null                                                                   );
238                final String valueBrCd  = getParam( ViewCalendarParam.VALUE_BR_FLAG_KEY ,ViewCalendarParam.VALUE_BR_FLAG_VALUE  );
239                final String firstWeekCd        = getParam( ViewCalendarParam.FIRSTWEEK_KEY             ,ViewCalendarParam.FIRSTWEEK_VALUE              );
240                final String headerLocale       = getParam( ViewCalendarParam.HEADER_LOCALE_KEY ,ViewCalendarParam.HEADER_LOCALE_VALUE  );
241                final String columnSizeCd       = getParam( ViewCalendarParam.COLUMN_SIZE_KEY   ,ViewCalendarParam.COLUMN_SIZE_VALUE    );      // 3.6.0.0 (2004/09/17)
242
243                viewKeys    = StringUtil.csv2Array( viewKeysCd );
244                firstWeek   = Integer.parseInt( firstWeekCd );
245                valueBrFlag = Boolean.parseBoolean( valueBrCd );                // 6.1.0.0 (2014/12/26) refactoring
246                columnSize  = Integer.parseInt( columnSizeCd );                 // 3.6.0.0 (2004/09/17)
247
248                // 曜日ヘッダーをコピーして作成します。
249                if( "ja".equals( headerLocale ) ) {
250                        week = WEEK_JA;
251                }
252                else {
253                        week = WEEK_EN;
254                }
255        }
256
257        /**
258         * row行,colum列 のデータの値をHTML文字列に変換して返します。
259         * リソースバンドルが登録されている場合は,リソースに応じた
260         * HTML文字列を作成します。
261         * カレンダーViewに特化した、ラベル値を返します。
262         *
263         * @og.rev 3.8.0.9 (2005/10/17) writableControl 追加による引数変更
264         *
265         * @param       row             行番号
266         * @param       column  カラム番号
267         * @param       day             日付
268         *
269         * @return      row行,colum列 のデータの値
270         * @og.rtnNotNull
271         */
272        private String getValueLabel( final int row, final int column, final int day ) {
273                // 6.3.9.1 (2015/11/27) A method should have only one exit point, and that should be the last statement in the method.(PMD)
274                final String rtn ;
275                if( isColumnWritable( column ) && isWritable( row ) ) {
276                        final String val = getValue( row,column ) ;
277                        rtn = day + getEditorValue( row,column,val );
278                }
279                else {
280                        rtn = String.valueOf( day );
281                }
282                return rtn ;
283        }
284
285        /**
286         * 指定のYYYYMM文字列から、カレンダーオブジェクトを作成して返します。
287         * 日にちは、1日にセットされます。
288         *
289         * @param   ym YYYYMM文字列
290         *
291         * @return  カレンダーオブジェクト
292         */
293        private Calendar getCalendar( final String ym ) {
294                final Calendar cal = Calendar.getInstance();
295
296                if( ym != null && ym.length() == 6 ) {
297                        final int yyyy = Integer.parseInt( ym.substring( 0,4 ) );
298                        final int mm   = Integer.parseInt( ym.substring( 4,6 ) ) - 1;
299                        final int dd   = 1;
300                        cal.set( yyyy,mm,dd,0,0,0 );
301                }
302                else {
303                        // カレンダーを今月の1日に設定する。
304                        cal.set(Calendar.DAY_OF_MONTH, 1);
305                }
306
307                return cal ;
308        }
309
310        /**
311         * フォーマットメソッドを使用できるかどうかを問い合わせます。
312         *
313         * @og.rev 3.6.0.0 (2004/09/17) 親クラス変更に伴なう、追加
314         *
315         * @return  使用可能(true)/ 使用不可能 (false)
316         */
317        public boolean canUseFormat() {
318                return false;
319        }
320
321        /**
322         * 表示項目の編集(並び替え)が可能かどうかを返します。
323         *
324         * @og.rev 5.1.6.0 (2010/05/01) 新規追加
325         *
326         * @return      表示項目の編集(並び替え)が可能かどうか(false:不可能)
327         */
328        @Override
329        public boolean isEditable() {
330                return false;
331        }
332}