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
027// import static org.opengion.fukurou.util.StringUtil.isNull;                           // // 8.5.4.2 (2024/01/12) import static … を個別に記述
028
029/**
030 * TEXTAREA エディターは、カラムのデータをテキストエリアで編集する場合に
031 * 使用するクラスです。
032 *
033 * 従来との違いは、cols 属性の最大値を、検索時(query画面)では、HTML_COLUMNS_MAXSIZE を、
034 * 登録時(result画面)では、HTML_VIEW_COLUMNS_MAXSIZE を使用します。
035 * エリアの大きさは、デフォルト値を使用するか、編集パラメータに、x,y形式で
036 * 指定します。
037 *  カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
038 * このクラスは、DBColumn オブジェクト毎に1つ作成されます。
039 *
040 * @og.rev 4.0.0.0 (2005/01/31) 新規作成
041 * @og.rev 8.5.6.1 (2024/03/29) 継承で使えるように、一部修正します。
042 * @og.group データ編集
043 *
044 * @version  8.5
045 * @author   Kazuhiko Hasegawa
046 * @since    JDK21.0,
047 */
048public class Editor_TEXTAREA extends AbstractEditor {
049        /** このプログラムのVERSION文字列を設定します。   {@value} */
050        private static final String VERSION = "8.5.6.1 (2024/03/29)" ;
051
052        // 6.9.6.0 (2018/05/07) protected に変更します。
053        /** 検索時の列数1 */ protected String cols1;          // 6.4.4.2 (2016/04/01) size1 を使わずに、cols1 を使用
054        /** 検索時の行数1 */ protected String rows1;
055        /** 登録時の列数2 */ protected String cols2;          // 6.4.4.2 (2016/04/01) size2 を使わずに、cols2 を使用
056        /** 登録時の行数2 */ protected String rows2;
057
058        /**
059         * デフォルトコンストラクター。
060         * このコンストラクターで、基本オブジェクトを作成します。
061         *
062         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
063         *
064         */
065        public Editor_TEXTAREA() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
066
067        /**
068         * コンストラクター。
069         *
070         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
071         * @og.rev 3.2.4.0 (2003/06/12) パラメータより、行列(row,column)情報があれば、その値を利用する。
072         * @og.rev 3.3.1.1 (2003/07/03) name , attributes 属性を final にする。
073         * @og.rev 3.4.0.0 (2003/09/01) 表示パラメータ、編集パラメータ、文字パラメータの追加。
074         * @og.rev 3.5.5.0 (2004/03/12) 漢字入力(IMEモード)をONにするのを、"K" と、"KX" のみとします。
075         * @og.rev 3.5.6.0 (2004/06/18) XHTMLTag の 内部配列 TEXTAREA_KEY を隠蔽します。
076         * @og.rev 4.0.0.0 (2005/01/31) DBColumn の getClassName() を getDbType() に変更
077         * @og.rev 6.4.4.2 (2016/04/01) size1,size2 を使わずに、cols1,cols2 を使用。
078         * @og.rev 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
079         * @og.rev 8.0.0.0 (2021/08/20) rows,cols がattributes に設定されていた場合の処理。
080         * @og.rev 8.5.5.1 (2024/02/29) spotbugs CT_CONSTRUCTOR_THROW(コンストラクタで、Excweptionを出さない)
081         * @og.rev 8.5.6.1 (2024/03/29) クラス名を RowSizeUtil → ColumnUtil に変更します。
082         *
083         * @param       clm     DBColumnオブジェクト
084         */
085        protected Editor_TEXTAREA( final DBColumn clm ) {
086                super( clm );
087                final String  disabled = clm.isWritable() ? null : "disabled" ;
088
089                // 8.5.5.1 (2024/02/29) spotbugs CT_CONSTRUCTOR_THROW(コンストラクタで、Excweptionを出さない)
090//              final int r1 = clm.getTotalSize()/Integer.parseInt(size1) + 1;          // 4.0.0 (2005/01/31) メソッド名変更
091//              if( r1 > 5 ) { rows1 = "5"; }
092//              else { rows1 = String.valueOf( r1 ); }
093//
094//              final int r2 = clm.getTotalSize()/Integer.parseInt(size2) + 1;          // 4.0.0 (2005/01/31) メソッド名変更
095//              if( r2 > 5 ) { rows2 = "5"; }
096//              else { rows2 = String.valueOf( r2 ); }
097                final int totalSize = clm.getTotalSize();                       // 8.5.5.1 (2024/02/29)
098//              rows1 = RowSizeUtil.getRowSize( totalSize,size1 );      // 8.5.5.1 (2024/02/29)
099//              rows2 = RowSizeUtil.getRowSize( totalSize,size2 );      // 8.5.5.1 (2024/02/29)
100                rows1 = ColumnUtil.getRowSize( totalSize,size1 );       // 8.5.6.1 (2024/03/29)
101                rows2 = ColumnUtil.getRowSize( totalSize,size2 );       // 8.5.6.1 (2024/03/29)
102
103                // 3.7.0.4 (2005/03/14) size に、"rows,cols" を指定できるように変更
104                final String param = StringUtil.nval( clm.getEditorParam(),clm.getViewLength() );
105                if( param != null && param.length() != 0 ) {
106                        final int st = param.indexOf( ',' );
107                        if( st > 0 ) {
108                                rows1 = param.substring( 0,st );
109                                rows2 = rows1 ;
110                                cols1 = param.substring( st+1 );
111                                cols2 = cols1;
112                        }
113                }
114
115                // 6.4.4.2 (2016/04/01) size1,size2 を使わずに、cols1,cols2 を使用。
116                if( cols1 == null || cols2 == null ) {
117                        cols1   = size1  ;
118                        cols2   = size2  ;
119                }
120
121                // 8.0.0.0 (2021/08/20) rows,cols がattributes に設定されていた場合の処理。
122                // clm から取得したオブジェクトを remove しないと、反映されない。
123                final Attributes editAttri = clm.getEditorAttributes();
124                final String attRows = editAttri.remove( "rows" );
125                if( attRows != null ) { rows1 = attRows; rows2 = attRows; }
126
127                final String attCols = editAttri.remove( "cols" );
128                if( attCols != null ) { cols1 = attCols; cols2 = attCols; }
129
130                // 6.1.1.0 (2015/01/17) Attributesの連結記述
131                attributes = new Attributes()
132                                        .set( "disabled"        , disabled )
133//                                      .set( clm.getEditorAttributes() )                               // #addAttributes( Attributes ) の代替え
134                                        .set( editAttri )                                                               // #addAttributes( Attributes ) の代替え
135                                        .add( "class"           , clm.getDbType() );            // 4.0.0 (2005/01/31)
136
137                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
138                // 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
139                tagBuffer.add( XHTMLTag.textareaAttri( attributes ) );
140//                               .add( attributes.get( "optionAttributes" ) );          // 6.0.4.0 (2014/11/28)
141        }
142
143        /**
144         * 各オブジェクトから自分のインスタンスを返します。
145         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
146         * まかされます。
147         *
148         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
149         * @og.rev 3.1.2.1 (2003/04/10) synchronized を、削除します。
150         *
151         * @param       clm     DBColumnオブジェクト
152         *
153         * @return      CellEditorオブジェクト
154         * @og.rtnNotNull
155         */
156        public CellEditor newInstance( final DBColumn clm ) {
157                return new Editor_TEXTAREA( clm );
158        }
159
160        /**
161         * データの編集用文字列を返します。
162         *
163         * @og.rev 4.3.7.2 (2009/06/15) 属性でidが出力される場合は、idを出力しない
164         * @og.rev 5.1.2.0 (2010/01/01) 先頭の'_'による書き込み制御を行わない。(他のクラスとの実装の共通化)
165         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
166         * @og.rev 6.4.4.2 (2016/04/01) size1,size2 を使わずに、cols1,cols2 を使用。
167         *
168         * @param   value 入力値
169         *
170         * @return  データの編集用文字列
171         * @og.rtnNotNull
172         */
173        @Override
174        public String getValue( final String value ) {
175//              // 6.1.1.0 (2015/01/17) TagBufferの連結記述
176//              return new TagBuffer( "textarea" )
177//                                              .add( "name"    , name )
178//                                              // 8.5.4.2 (2024/01/12) import static … を個別に記述
179//                                              .add( "id"              , name , StringUtil.isNull( attributes.get( "id" ) ) )          // 4.3.7.2 (2009/06/15)
180//                                              .add( "cols"    , cols1 )                               // 6.4.4.2 (2016/04/01)
181//                                              .add( "rows"    , rows1 )
182//                                              .add( tagBuffer.makeTag() )
183//                                              .addBody( value )
184//                                              .makeTag();
185
186                return makeTagBuffer( name,cols1,rows1 )
187                                        .add( "id", name , StringUtil.isNull( attributes.get( "id" ) ) )                // 4.3.7.2 (2009/06/15)
188                                        .addBody( value )
189                                        .makeTag();
190        }
191
192        /**
193         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
194         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し、
195         * リクエスト情報を1つ毎のフィールドで処理できます。
196         *
197         * @og.rev 3.1.0.0 (2003/03/20) 名前と行番号の区切り記号を "^" から "__" に変更。
198         * @og.rev 3.5.5.0 (2004/03/12) 名前と行番号の区切り記号("__")を、HybsSystem.JOINT_STRING  に変更。
199         * @og.rev 4.3.7.2 (2009/06/15) 属性でidが出力される場合は、idを出力しない
200         * @og.rev 5.1.2.0 (2010/01/01) 先頭の'_'による書き込み制御を行わない。(他のクラスとの実装の共通化)
201         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
202         * @og.rev 6.4.4.2 (2016/04/01) size1,size2 を使わずに、cols1,cols2 を使用。
203         *
204         * @param   row   行番号
205         * @param   value 入力値
206         *
207         * @return  データ表示/編集用の文字列
208         * @og.rtnNotNull
209         */
210        @Override
211        public String getValue( final int row,final String value ) {
212                final String newName = name + HybsSystem.JOINT_STRING + row;
213
214//              // 6.1.1.0 (2015/01/17) TagBufferの連結記述
215//              return new TagBuffer( "textarea" )
216//                                              .add( "name"    , newName )
217//                                              // 8.5.4.2 (2024/01/12) import static … を個別に記述
218//                                              .add( "id"              , newName , StringUtil.isNull( attributes.get( "id" ) ) )               // 4.3.7.2 (2009/06/15)
219//                                              .add( "cols"    , cols2 )                               // 6.4.4.2 (2016/04/01)
220//                                              .add( "rows"    , rows2 )
221//                                              .add( tagBuffer.makeTag() )
222//                                              .addBody( value )
223//                                              .makeTag( row,value );
224
225                return makeTagBuffer( newName,cols2,rows2 )
226                                        .add( "id" , newName , StringUtil.isNull( attributes.get( "id" ) ) )            // 4.3.7.2 (2009/06/15)
227                                        .addBody( value )
228                                        .makeTag( row,value );
229        }
230
231        /**
232         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
233         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し、
234         * リクエスト情報を1つ毎のフィールドで処理できます。
235         *
236         * @og.rev 8.5.6.1 (2024/03/29) 継承で使えるように、一部修正します。
237         *
238         * @param       name    カラム名称
239         * @param       cols    検索時/登録時の列数
240         * @param       rows    検索時/登録時の行数
241         *
242         * @return      新しく構築された TagBuffer オブジェクト
243         * @og.rtnNotNull
244         */
245        protected TagBuffer makeTagBuffer( final String name, final String cols, final String rows ) {
246                return  new TagBuffer( "textarea" )
247                                        .add( "name"    , name )
248                                        .add( "cols"    , cols )
249                                        .add( "rows"    , rows )
250                                        .add( tagBuffer.makeTag() );
251        }
252}