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.db.DBTableModel;
019
020/**
021 * 各フィールド情報から、動的にカラムを作成する動的カラム一覧表示クラスです。
022 *
023 * AbstractViewForm により、setter/getterメソッドのデフォルト実装を提供しています。
024 * 各HTMLのタグに必要な setter/getterメソッドのみ、追加定義しています。
025 *
026 * AbstractViewForm を継承している為、ロケールに応じたラベルを出力させる事が出来ます。
027 *
028 * @og.group 画面表示
029 *
030 * @version  4.0
031 * @author   Kazuhiko Hasegawa
032 * @since    JDK5.0,
033 */
034public class ViewForm_HTMLDynamic extends ViewForm_HTMLTable  {
035        /** このプログラムのVERSION文字列を設定します。   {@value} */
036        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
037
038        /** カラムの値を返す場合の、カラムキー名称 {@value} */
039        public static final String COLUMN_RETURN_KEY = "COLUMN_RETURN";
040        private int rtnColumnNo = -1;   // column_return カラムの番号
041
042        /**
043         * デフォルトコンストラクター
044         *
045         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
046         */
047        public ViewForm_HTMLDynamic() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
048
049        /**
050         * 初期化します。
051         * ここでは、内部で使用されているキャッシュをクリアし、
052         * 新しいモデル(DBTableModel)と言語(lang) を元に内部データを再構築します。
053         * ただし、設定情報は、以前の状態がそのままキープされています。
054         *
055         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
056         * @og.rev 3.5.6.1 (2004/06/25) lang 言語コード 属性を削除します。
057         *
058         * @param       table   DBTableModelオブジェクト
059         */
060        @Override
061        public void init( final DBTableModel table ) {
062                super.init( table );
063                final int clmCnt = getColumnCount();
064                for( int i=0; i<clmCnt; i++ ) {
065                        if( COLUMN_RETURN_KEY.equalsIgnoreCase( getColumnName(i) )) {
066                                rtnColumnNo = i;
067                                break;
068                        }
069                }
070        }
071
072        /**
073         * DBTableModel から HTML文字列を作成して返します。
074         * startNo(表示開始位置)から、pageSize(表示件数)までのView文字列を作成します。
075         * 表示残りデータが pageSize 以下の場合は、残りのデータをすべて出力します。
076         *
077         * @og.rev 3.5.4.0 (2003/11/25) getBgColorCycleClass の返す文字列を変更する。
078         * @og.rev 3.5.6.4 (2004/07/16) ヘッダーとボディー部をJavaScriptで分離
079         *
080         * @param  startNo    表示開始位置
081         * @param  pageSize   表示件数
082         *
083         * @return  DBTableModelから作成された HTML文字列
084         * @og.rtnNotNull
085         */
086        @Override
087        public String create( final int startNo, final int pageSize )  {
088                if( getRowCount() == 0 ) { return ""; } // 暫定処置
089
090                final int lastNo = getLastNo( startNo, pageSize );
091
092                final StringBuilder out = new StringBuilder( BUFFER_LARGE )
093                        .append( getCountForm( startNo,pageSize ) )
094                        .append( getHeader() );
095
096                int rowIndex = 0;
097                out.append("<tbody>").append( CR )
098                        .append(" <tr").append( getBgColorCycleClass( rowIndex++ ) )
099                        .append('>').append( CR );                                              // 6.0.2.5 (2014/10/31) char を append する。
100                final int clmCnt = getColumnCount();                            // 3.5.5.7 (2004/05/10)
101                for( int row=startNo; row<lastNo; row++ ) {
102                        for( int column=0; column<clmCnt; column++ ) {
103                                if( isColumnReturn( row,column ) ) {
104                                        out.append(" </tr>").append( CR ).append(" <tr ")
105                                                .append( getBgColorCycleClass( rowIndex++ ) )
106                                                .append('>').append( CR );                      // 6.0.2.5 (2014/10/31) char を append する。
107                                }
108                                else if( isColumnDisplay( column ) ) {
109                                        out.append("  <td>")
110                                                .append( getValueLabel(row,column) )
111                                                .append("</td>").append( CR );
112                                }
113                        }
114                }
115                out.append(" </tr>").append( CR )
116                        .append("</tbody>").append( CR )
117                        .append("</table>").append( CR )
118                        .append( getScrollBarEndDiv() );        // 3.8.0.3 (2005/07/15)
119
120                return out.toString();
121        }
122
123        /**
124         * DBTableModel から テーブルのタグ文字列を作成して返します。
125         *
126         * @return  テーブルのタグ文字列
127         * @og.rtnNotNull
128         */
129        @Override
130        protected String getTableHead() {
131                // ヘッダーは，不要です。
132                return "";
133        }
134
135        /**
136         * カラムが表示可能かどうかを返します。
137         * もし、表示不可の場合は、このカラムの全データが表示対象から外されます。
138         *
139         * @param   row         行番号
140         * @param   column      カラム番号
141         *
142         * @return  表示可能(true)／不可能(false)
143         */
144        private boolean isColumnReturn( final int row,final int column ) {
145                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
146                return rtnColumnNo == column && "1".equals( getValue( row,column ) ) ;
147        }
148
149        /**
150         * 表示項目の編集(並び替え)が可能かどうかを返します。
151         *
152         * @og.rev 5.1.6.0 (2010/05/01) 新規追加
153         *
154         * @return      表示項目の編集(並び替え)が可能かどうか(false:不可能)
155         */
156        @Override
157        public boolean isEditable() {
158                return false;
159        }
160}