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.fukurou.system.OgBuilder;                                   // 6.4.4.1 (2016/03/18)
019import org.opengion.fukurou.util.XHTMLTag;
020import org.opengion.hayabusa.common.HybsSystem;
021import org.opengion.hayabusa.html.AbstractViewForm;
022import org.opengion.hayabusa.db.DBColumn;
023import org.opengion.hayabusa.db.DBColumnConfig;
024
025/**
026 * 検索結果から、ﾃｷｽﾄﾌｨｰﾙﾄﾞﾀｸﾞを自動生成する、ﾃｷｽﾄﾌｨｰﾙﾄﾞ作成ｸﾗｽです。
027 *
028 * AbstractViewForm により、setter/getterﾒｿｯﾄﾞのﾃﾞﾌｫﾙﾄ実装を提供しています。
029 * 各HTMLのﾀｸﾞに必要な setter/getterﾒｿｯﾄﾞのみ、追加定義しています。
030 *
031 * AbstractViewForm を継承している為、ﾛｹｰﾙに応じたﾗﾍﾞﾙを出力させる事が出来ます。
032 *
033 * @og.group 画面表示
034 *
035 * @version  4.0
036 * @author   Kazuhiko Hasegawa
037 * @since    JDK5.0,
038 */
039public class ViewForm_HTMLTextField extends AbstractViewForm {
040        /** このﾌﾟﾛｸﾞﾗﾑのVERSION文字列を設定します。 {@value} */
041        private static final String VERSION = "8.5.4.0 (2023/12/01)" ;
042
043        /** 4.0.0 (2005/01/31) HTML_LABEL_SEPARATOR を boolean 変数として取得します。 */
044        private final String CLM = HybsSystem.sysBool( "HTML_LABEL_SEPARATOR" ) ? ":" : "" ;
045
046        /** 項目間のｽﾍﾟｰｽ */
047        private String columnSpace = HybsSystem.sys( "HTML_COLUMS_SPACE" ) ;
048        /** 縦方向の最大表示件数 */
049        private int maxRowNumber   = HybsSystem.sysInt( "HTML_MAXROW_NUMBER" ) ;
050        private static final int PAGE_SIZE = 1;
051
052        /**
053         * ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
054         *
055         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
056         */
057        public ViewForm_HTMLTextField() { super(); }            // これも、自動的に呼ばれるが、空のﾒｿｯﾄﾞを作成すると警告されるので、明示的にしておきます。
058
059        /**
060         * DBTableModel から HTML文字列を作成して返します。
061         * startNo(表示開始位置)から、pageSize(表示件数)までのView文字列を作成します。
062         * 表示残りﾃﾞｰﾀが pageSize 以下の場合は、残りのﾃﾞｰﾀをすべて出力します。
063         *
064         * @og.rev 2.0.1.0 (2002/10/10) ﾗﾍﾞﾙとﾌｨｰﾙﾄﾞのｾﾊﾟﾚｰﾀｰとして、ｺﾛﾝ(：)を使用するかどうかを指定できる
065         * @og.rev 3.6.0.5 (2004/10/18) 印刷時の罫線出力関連機能の追加。id 属性を出力します。
066         * @og.rev 5.6.2.3 (2013/03/22) DBColumn に、useSLabel="false" の値をｾｯﾄします。
067         * @og.rev 8.2.0.2 (2022/06/24) HTML5廃止対応
068         *
069         * @param       startNo         表示開始位置
070         * @param       pageSize        表示件数
071         * @return      DBTableModelから作成された HTML文字列
072         * @og.rtnNotNull
073         */
074        public String create( final int startNo, final int pageSize ) {
075                if( getRowCount() == 0 ) { return ""; } // 暫定処置
076
077                noSLabelSetting();              // 5.6.2.3 (2013/03/22) DBColumn に、useSLabel="false" の値をｾｯﾄします。
078
079                final int numberOfColumns = getColumnDisplayCount() ;
080                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
081                final String[] label = new String[numberOfColumns];
082                final String[] value = new String[numberOfColumns];
083
084                final int realCount = getColumnCount();
085                int clmNo = 0;
086                for( int i=0; i<realCount; i++ ) {
087                        if( isColumnDisplay(i) ) {
088                                label[clmNo] = getColumnLabel(i);
089                                value[clmNo] = getValueLabel(startNo,i);
090                                clmNo++ ;
091                        }
092                }
093
094                final int columnNumber = numberOfColumns / maxRowNumber + 1 ;
095
096                final StringBuilder out = new StringBuilder( BUFFER_LARGE )
097                        .append( getCountForm( startNo,pageSize ) )
098                        .append( makeSelectNo( startNo ) ).append( CR )
099//                      .append("<table id=\"viewTextField\" border=\"0\" summary=\"ViewForm_HTMLTextField\" >");       // 3.6.0.5 (2004/10/18)
100//                      .append("<table id=\"viewTextField\" border=\"0\" >");                          // 8.2.0.2 (2022/06/24) Modify
101                        .append("<table id=\"viewTextField\" >");                                                       // 8.5.4.0 (2023/12/01) HTML5廃止対応(border属性削除)
102
103                final int rowNumber = (numberOfColumns +1 )/ columnNumber ;
104                for( int row=0; row<rowNumber; row++ ) {
105                        out.append("<tr>").append( CR );
106                        for( int clm=0; clm<columnNumber; clm++ ) {
107                                final int realClm = row + clm * rowNumber ;
108                                out.append("<td id=\"label\">");
109                                if( realClm < numberOfColumns ) {
110                                        out.append( label[realClm] )
111                                                .append( CLM );
112                                }
113                                out.append("</td>").append( CR )
114                                        .append("<td>");
115                                if( realClm < numberOfColumns ) { out.append( value[realClm] ); }
116                                out.append("</td>").append( CR )
117//                                      .append("<td width=\"").append( columnSpace ).append("\">　</td>").append( CR );
118                                        .append("<td style=\"width:").append( columnSpace ).append(";\">　</td>").append( CR );  // 8.2.0.2 (2022/06/24) Modify
119                        }
120                        out.append("</tr>").append( CR );
121                }
122                out.append("</table>");
123
124                return out.toString();
125        }
126
127        /**
128         * DBColumn に、useSLabel="false" の値をｾｯﾄします。
129         *
130         * @og.rev 5.6.2.3 (2013/03/22) 新規追加
131         *
132         */
133        protected void noSLabelSetting() {
134                final int realCount = getColumnCount();
135
136                for( int clmNo=0; clmNo<realCount; clmNo++ ) {
137                        final DBColumnConfig config = getDBColumn( clmNo ).getConfig();
138                        config.setUseSLabel( "false" );
139
140                        setDBColumn( clmNo, new DBColumn( config ) );
141                }
142        }
143
144        /**
145         * 画面に選択された番号を表示します。
146         * また、書き込み許可がある場合は、選択用の隠しﾌｨｰﾙﾄﾞを作成します。
147         *
148         * @og.rev 3.5.5.5 (2004/04/23) hidden の出力に、XHTMLTag.hidden を使用します。
149         * @og.rev 6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。
150         *
151         * @param       row     行番号
152         * @return      隠しﾌｨｰﾙﾄﾞのHTML文字列
153         * @og.rtnNotNull
154         */
155        protected String makeSelectNo( final int row ) {
156                return new OgBuilder()
157                                        .appendIf( isWritable( row ) , String.valueOf( row )
158                                                                , rowKey -> XHTMLTag.hidden( HybsSystem.ROW_SEL_KEY,rowKey ) )
159                                        .toString();
160        }
161
162        /**
163         * 内容をｸﾘｱ(初期化)します。
164         *
165         * @og.rev 3.1.1.0 (2003/03/28) 同期ﾒｿｯﾄﾞ(synchronized付き)を非同期に変更する。
166         *
167         */
168        @Override
169        public void clear() {
170                super.clear();
171                columnSpace  = HybsSystem.sys( "HTML_COLUMS_SPACE" ) ;                  // 項目間のｽﾍﾟｰｽ
172                maxRowNumber = HybsSystem.sysInt( "HTML_MAXROW_NUMBER" ) ;              // 縦方向の最大表示件数
173        }
174
175        /**
176         * 表示件数を取得します。
177         *
178         * @return      表示件数
179         */
180        @Override
181        public int getPageSize() {
182                return PAGE_SIZE;
183        }
184
185        /**
186         * ﾌｫｰﾏｯﾄﾒｿｯﾄﾞを使用できるかどうかを問い合わせます。
187         *
188         * @return      ﾌｫｰﾏｯﾄﾒｿｯﾄﾞの使用有無 [true:使用可能/false:使用不可能]
189         */
190        public boolean canUseFormat() {
191                return false;
192        }
193
194        /**
195         * ｶﾗﾑのﾗﾍﾞﾙ名(長)を返します。
196         * ｶﾗﾑの項目名に対して、見える形の文字列を返します。
197         * 一般には、ﾘｿｰｽﾊﾞﾝﾄﾞﾙと組合せて、各国ﾛｹｰﾙ毎にﾗﾍﾞﾙを切替えます。
198         *
199         * @og.rev 4.0.0.0 (2005/01/31) 新規追加( longLabel を返します。)
200         *
201         * @param       column  ｶﾗﾑ番号
202         * @return      ｶﾗﾑのﾗﾍﾞﾙ名(長)
203         */
204        @Override
205        protected String getColumnLabel( final int column ) {
206                return getDBColumn( column ).getLongLabel();
207        }
208
209        /**
210         * 表示項目の編集(並び替え)が可能かどうかを返します。
211         *
212         * @og.rev 5.1.6.0 (2010/05/01) 新規追加
213         *
214         * @return      表示項目の編集可否 [true:可能/false:不可能]
215         */
216        @Override
217        public boolean isEditable() {
218                return false;
219        }
220}