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.column;
017
018import org.opengion.hayabusa.db.AbstractEditor;
019import org.opengion.hayabusa.db.CellEditor;
020import org.opengion.hayabusa.db.DBColumn;
021import org.opengion.fukurou.util.XHTMLTag;
022import org.opengion.hayabusa.common.HybsSystem;
023import org.opengion.fukurou.util.Attributes;
024import org.opengion.fukurou.util.StringUtil;
025import org.opengion.fukurou.util.TagBuffer;
026
027import static org.opengion.fukurou.util.StringUtil.isNull;                              // 6.1.1.0 (2015/01/17)
028
029import java.util.StringTokenizer ;
030
031/**
032 * AUTOAREA エディターは、カラムのデータをテキストエリアで編集する場合に
033 * 使用するクラスです。
034 *
035 * エリアの大きさは、表示する文字列によって、自動的に変更されます。
036 * 初期値や、文字数が小さい場合のサイズは、デフォルト値を使用するか、
037 * 編集パラメータに、x,y形式で指定された値を使います。
038 * 列方向での最大桁数を、指定することが可能です。システムパラメータで
039 * HTML_AUTOAREA_MAX_COL_SIZE を指定することで、折り返し列数の調整も
040 * 同時に行われます。0 が指定された場合は、無制限になります。
041 * HTML_AUTOAREA_MAX_ROW_SIZE を指定することで、行数の最大値を
042 * 指定することが可能です。0 が指定された場合は、無制限になります。
043 *
044 * 編集パラメータは、『行,列』指定可能です。例えば、5,10 とすると、5行10列の
045 * テキストエリアを最小範囲として設定できます。
046 * 初期値は、HTML_COLUMS_MAXSIZE で指定の列数と、定義されているデータサイズ
047 * 割る HTML_COLUMS_MAXSIZE で、5を超えない値を、行数としています。
048 * 編集パラメータの、『行,列』指定で、同時に、最大行列数の指定も可能です。
049 * 5-10,15-20 とすると、最小5行-最大10行で、最小15列-最大20列の
050 * テキストエリアを指定できます。編集パラメータでの最大値指定は、
051 * システムパラメータでの最大値指定より、優先されます。
052 *
053 * このエディターでは、カラムの内容に応じて、書込み禁止属性を強制的に付与する
054 * 事も可能です。
055 * value (検索結果)の先頭1文字目が、アンダーバー(_) の場合は、
056 * 編集モードになりません。(読取専用)
057 * データベースに書き込むときには、通常のアンダーバー無しの文字列に変換して登録します。
058 *
059 *  カラムの表示に必要な属性は, DBColumn オブジェクト より取り出します。
060 * このクラスは、DBColumn オブジェクト毎に1つ作成されます。
061 *
062 * @og.rev 3.8.0.2 (2005/06/30) 新規追加。
063 * @og.group データ編集
064 *
065 * @version  4.0
066 * @author   Kazuhiko Hasegawa
067 * @since    JDK5.0,
068 */
069public class Editor_AUTOAREA extends AbstractEditor {
070        /** このプログラムのVERSION文字列を設定します。   {@value} */
071        private static final String VERSION = "7.0.5.1 (2019/09/27)" ;
072
073        private static final int COL = 0 ;
074        private static final int ROW = 1 ;
075        private static final String CODE = "Windows-31J";
076
077        private String autoArea = "autoArea( this );" ;         // 6.1.1.0 (2015/01/17) 固定値の設定
078
079        private int     cols1   ;
080        private int     cols2   ;
081        private int     rows1   ;
082        private int     rows2   ;
083        private int maxColSize = HybsSystem.sysInt( "HTML_AUTOAREA_MAX_COL_SIZE" );
084        private int maxRowSize = HybsSystem.sysInt( "HTML_AUTOAREA_MAX_ROW_SIZE" );
085
086        /**
087         * デフォルトコンストラクター。
088         * このコンストラクターで、基本オブジェクトを作成します。
089         *
090         */
091        public Editor_AUTOAREA() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
092
093        /**
094         * DBColumnオブジェクトを指定したprivateコンストラクター。
095         *
096         * @og.rev 6.0.4.0 (2014/11/28) optionAttributes は、コンストラクタで設定します。
097         * @og.rev 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
098         *
099         * @param       clm     DBColumnオブジェクト
100         */
101        private Editor_AUTOAREA( final DBColumn clm ) {
102                super( clm );
103                final String  disabled = clm.isWritable() ? null : "disabled" ;
104
105                final int r1 = clm.getTotalSize()/Integer.parseInt(size1) + 1;  // 4.0.0 (2005/01/31) メソッド名変更
106                if( r1 > 5 ) { rows1 = 5; }
107                else { rows1 = r1; }
108
109                final int r2 = clm.getTotalSize()/Integer.parseInt(size2) + 1;  // 4.0.0 (2005/01/31) メソッド名変更
110                if( r2 > 5 ) { rows2 = 5; }
111                else { rows2 = r2; }
112
113                // 3.8.0.2 (2005/07/11) size に、"rows-maxRow,cols-maxCols" を指定
114                final String param = StringUtil.nval( clm.getEditorParam(),clm.getViewLength() );
115                if( param != null && param.length() != 0 ) {
116                        final int prmAdrs = param.indexOf( ',' );
117                        if( prmAdrs > 0 ) {
118                                final String rowStr = param.substring( 0,prmAdrs );
119                                final String colStr = param.substring( prmAdrs+1 );
120
121                                final int rowAdrs = rowStr.indexOf( '-' );      // rows-maxRow 設定時 '-' がなければ、ただのrows
122                                if( rowAdrs > 0 ) {
123                                        rows1 = Integer.parseInt( rowStr.substring( 0,rowAdrs ) );
124                                        maxRowSize = Integer.parseInt( rowStr.substring( rowAdrs+1 ) );
125                                }
126                                else {
127                                        rows1 = Integer.parseInt( rowStr );
128                                }
129                                rows2 = rows1 ;
130
131                                final int colAdrs = colStr.indexOf( '-' );      // cols-maxCols 設定時 '-' がなければ、ただのcols
132                                if( colAdrs > 0 ) {
133                                        cols1 = Integer.parseInt( colStr.substring( 0,colAdrs ) );
134                                        maxColSize = Integer.parseInt( colStr.substring( colAdrs+1 ) );
135                                }
136                                else {
137                                        cols1 = Integer.parseInt( colStr );
138                                }
139                                cols2 = cols1;
140                        }
141                }
142
143                // 6.1.1.0 (2015/01/17) Attributesの連結記述
144                attributes = new Attributes()
145                                        .set( "disabled"        ,disabled )
146                                        .set( clm.getEditorAttributes() )                               // #addAttributes( Attributes ) の代替え
147                                        .add( "class"           ,clm.getDbType() );                     // 4.0.0 (2005/01/31)
148
149                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
150                // 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
151                tagBuffer.add( XHTMLTag.textareaAttri( attributes ) );
152//                               .add( attributes.get( "optionAttributes" ) );          // 6.0.4.0 (2014/11/28)
153
154                // 6.1.1.0 (2015/01/17) 固定値の設定
155                if(  maxRowSize > 0 ) {
156                        autoArea = "autoArea( this," + maxRowSize + " );" ;
157                }
158        }
159
160        /**
161         * 各オブジェクトから自分のインスタンスを返します。
162         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
163         * まかされます。
164         *
165         * @param       clm     DBColumnオブジェクト
166         *
167         * @return      CellEditorオブジェクト
168         */
169        public CellEditor newInstance( final DBColumn clm ) {
170                return new Editor_AUTOAREA( clm );
171        }
172
173        /**
174         * データの編集用文字列を返します。
175         *
176         * @og.rev 4.3.7.2 (2009/06/15) 属性でidが出力される場合は、idを出力しない
177         * @og.rev 5.1.2.0 (2010/01/01) 先頭の'_'による書き込み制御を行わない。(他のクラスとの実装の共通化)
178         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
179         *
180         * @param   value 値
181         *
182         * @return  データの編集用文字列
183         * @og.rtnNotNull
184         */
185        @Override
186        public String getValue( final String value ) {
187                final int[] rowcol = getRowsCols( value,cols1,rows1 );
188
189                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
190                return new TagBuffer( "textarea" )
191                                                .add( "name"    , name )
192                                                .add( "id"              , name , isNull( attributes.get( "id" ) ) )             // 4.3.7.2 (2009/06/15)
193                                                .add( "cols"    , String.valueOf( rowcol[COL] ) )
194                                                .add( "rows"    , String.valueOf( rowcol[ROW] ) )
195                                                .add( "onKeyup" , autoArea )
196                                                .add( tagBuffer.makeTag() )
197                                                .addBody( value )
198                                                .makeTag();
199        }
200
201        /**
202         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
203         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し,
204         * リクエスト情報を1つ毎のフィールドで処理できます。
205         *
206         * @og.rev 4.3.7.2 (2009/06/15) 属性でidが出力される場合は、idを出力しない
207         * @og.rev 5.1.2.0 (2010/01/01) 先頭の'_'による書き込み制御を行わない。(他のクラスとの実装の共通化)
208         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
209         *
210         * @param   row   行番号
211         * @param   value 値
212         *
213         * @return  データ表示/編集用の文字列
214         * @og.rtnNotNull
215         */
216        @Override
217        public String getValue( final int row,final String value ) {
218                final int[] rowcol   = getRowsCols( value,cols2,rows2 );
219                final String newName = name + HybsSystem.JOINT_STRING + row;
220
221                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
222                return new TagBuffer( "textarea" )
223                                                .add( "name"    , newName )
224                                                .add( "id"              , newName , isNull( attributes.get( "id" ) ) )          // 4.3.7.2 (2009/06/15)
225                                                .add( "cols"    , String.valueOf( rowcol[COL] ) )
226                                                .add( "rows"    , String.valueOf( rowcol[ROW] ) )
227                                                .add( "onKeyup" , autoArea )
228                                                .add( tagBuffer.makeTag() )
229                                                .addBody( value )
230                                                .makeTag( row,value );
231        }
232
233        /**
234         * 自動表示する行列の数を求めます。
235         * 行数は、引数の文字列中に含まれる 改行コードの個数を求めます。
236         * 列数は、各行数のなかの最大桁数より求めます。これには半角、全角が含まれる為、
237         * 半角換算での文字数ということになります。
238         * 行数と列数が、初期設定の行数と列数より小さい場合は、初期設定値が使用されます。
239         *
240         * @param   value       表示文字列
241         * @param   cols        最小カラム数
242         * @param   rows        最小行数
243         *
244         * @return      自動計算した行列の配列
245         * @og.rtnNotNull
246         */
247        private int[] getRowsCols( final String value,final int cols, final int rows ) {
248                if( value == null ) {
249                        return new int[] { cols,rows };                                 // 6.3.9.1 (2015/11/27) 逆だったが、今まで大丈夫だった?
250                }
251
252                final StringTokenizer token = new StringTokenizer( value, "\n", true );
253
254                int cntRow = 1;
255                int maxCol = 0;
256                while( token.hasMoreTokens() ) {
257                        final String val = token.nextToken();
258                        if( "\n".equals( val ) ) { cntRow++; }
259                        else {
260                                final byte[] byteValue = StringUtil.makeByte( val,CODE );       // 3.5.5.3 (2004/04/09)
261                                final int byteSize = byteValue.length;
262                                if( maxColSize > 0 && byteSize > maxColSize ) {         // 最大列数
263                                        cntRow += byteSize / maxColSize;
264                                        maxCol = maxColSize ;
265                                }
266                                else if( byteSize > maxCol ) { maxCol = byteSize; }
267                        }
268                        if( maxRowSize > 0 && cntRow >= maxRowSize ) {          // 最大行数
269                                cntRow = maxRowSize;
270                                break;
271                        }
272                }
273
274                maxCol += 2;    // マージン。フォントや画面サイズに影響する為、比率のほうがよい?
275
276                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
277
278                //                                      COL                                                     ROW
279                return new int[] { Math.max( cols,maxCol ) , Math.max( rows,cntRow ) } ;        // 6.3.9.1 (2015/11/27)
280        }
281}