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