    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 とすると、５行１０列の
    045 * テキストエリアを最小範囲として設定できます。
    046 * 初期値は、HTML_COLUMS_MAXSIZE で指定の列数と、定義されているデータサイズ
    047 * 割る HTML_COLUMS_MAXSIZE で、５を超えない値を、行数としています。
    048 * 編集パラメータの、『行,列』指定で、同時に、最大行列数の指定も可能です。
    049 * 5-10,15-20 とすると、最小５行－最大１０行で、最小１５列－最大２０列の
    050 * テキストエリアを指定できます。編集パラメータでの最大値指定は、
    051 * システムパラメータでの最大値指定より、優先されます。
    052 *
    053 * このエディターでは、カラムの内容に応じて、書込み禁止属性を強制的に付与する
    054 * 事も可能です。
    055 * value (検索結果)の先頭１文字目が、アンダーバー(_) の場合は、
    056 * 編集モードになりません。(読取専用)
    057 * データベースに書き込むときには、通常のアンダーバー無しの文字列に変換して登録します。
    058 *
    059 *  カラムの表示に必要な属性は, DBColumn オブジェクト より取り出します。
    060 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
    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 = "6.0.4.0 (2014/11/28)" ;
    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         * コンストラクター。
    095         *
    096         * @og.rev 6.0.4.0 (2014/11/28) optionAttributes は、コンストラクタで設定します。
    097         *
    098         * @param       clm     DBColumnオブジェクト
    099         */
    100        private Editor_AUTOAREA( final DBColumn clm ) {
    101                super( clm );
    102                final String  disabled = clm.isWritable() ? null : "disabled" ;
    103
    104                final int r1 = clm.getTotalSize()/Integer.parseInt(size1) + 1;  // 4.0.0 (2005/01/31) メソッド名変更
    105                if( r1 > 5 ) { rows1 = 5; }
    106                else { rows1 = r1; }
    107
    108                final int r2 = clm.getTotalSize()/Integer.parseInt(size2) + 1;  // 4.0.0 (2005/01/31) メソッド名変更
    109                if( r2 > 5 ) { rows2 = 5; }
    110                else { rows2 = r2; }
    111
    112                // 3.8.0.2 (2005/07/11) size に、"rows-maxRow,cols-maxCols" を指定
    113                final String param = StringUtil.nval( clm.getEditorParam(),clm.getViewLength() );
    114                if( param != null && param.length() != 0 ) {
    115                        final int prmAdrs = param.indexOf( ',' );
    116                        if( prmAdrs > 0 ) {
    117                                final String rowStr = param.substring( 0,prmAdrs );
    118                                final String colStr = param.substring( prmAdrs+1 );
    119
    120                                final int rowAdrs = rowStr.indexOf( '-' );      // rows-maxRow 設定時 '-' がなければ、ただのrows
    121                                if( rowAdrs > 0 ) {
    122                                        rows1 = Integer.parseInt( rowStr.substring( 0,rowAdrs ) );
    123                                        maxRowSize = Integer.parseInt( rowStr.substring( rowAdrs+1 ) );
    124                                }
    125                                else {
    126                                        rows1 = Integer.parseInt( rowStr );
    127                                }
    128                                rows2 = rows1 ;
    129
    130                                final int colAdrs = colStr.indexOf( '-' );      // cols-maxCols 設定時 '-' がなければ、ただのcols
    131                                if( colAdrs > 0 ) {
    132                                        cols1 = Integer.parseInt( colStr.substring( 0,colAdrs ) );
    133                                        maxColSize = Integer.parseInt( colStr.substring( colAdrs+1 ) );
    134                                }
    135                                else {
    136                                        cols1 = Integer.parseInt( colStr );
    137                                }
    138                                cols2 = cols1;
    139                        }
    140                }
    141
    142                // 6.1.1.0 (2015/01/17) Attributesの連結記述
    143                attributes = new Attributes()
    144                                        .set( "disabled"        ,disabled )
    145                                        .set( clm.getEditorAttributes() )                               // #addAttributes( Attributes ) の代替え
    146                                        .add( "class"           ,clm.getDbType() );                     // 4.0.0 (2005/01/31)
    147
    148                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    149                tagBuffer.add( XHTMLTag.textareaAttri( attributes ) )
    150                                 .add( attributes.get( "optionAttributes" ) );          // 6.0.4.0 (2014/11/28)
    151
    152                // 6.1.1.0 (2015/01/17) 固定値の設定
    153                if(  maxRowSize > 0 ) {
    154                        autoArea = "autoArea( this," + maxRowSize + " );" ;
    155                }
    156
    157        }
    158
    159        /**
    160         * 各オブジェクトから自分のインスタンスを返します。
    161         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
    162         * まかされます。
    163         *
    164         * @param       clm     DBColumnオブジェクト
    165         *
    166         * @return      CellEditorオブジェクト
    167         */
    168        public CellEditor newInstance( final DBColumn clm ) {
    169                return new Editor_AUTOAREA( clm );
    170        }
    171
    172        /**
    173         * データの編集用文字列を返します。
    174         *
    175         * @og.rev 4.3.7.2 (2009/06/15) 属性でidが出力される場合は、idを出力しない
    176         * @og.rev 5.1.2.0 (2010/01/01) 先頭の'_'による書き込み制御を行わない。(他のクラスとの実装の共通化)
    177         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
    178         *
    179         * @param   value 値
    180         *
    181         * @return  データの編集用文字列
    182         * @og.rtnNotNull
    183         */
    184        @Override
    185        public String getValue( final String value ) {
    186                final int[] rowcol = getRowsCols( value,cols1,rows1 );
    187
    188                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    189                return new TagBuffer( "textarea" )
    190                                                .add( "name"    , name )
    191                                                .add( "id"              , name , isNull( attributes.get( "id" ) ) )             // 4.3.7.2 (2009/06/15)
    192                                                .add( "cols"    , String.valueOf( rowcol[COL] ) )
    193                                                .add( "rows"    , String.valueOf( rowcol[ROW] ) )
    194                                                .add( "onKeyup" , autoArea )
    195                                                .add( tagBuffer.makeTag() )
    196                                                .addBody( value )
    197                                                .makeTag();
    198
    199        }
    200
    201        /**
    202         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
    203         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し,
    204         * リクエスト情報を１つ毎のフィールドで処理できます。
    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         *
    241         * @param   value       表示文字列
    242         * @param   cols        最小カラム数
    243         * @param   rows        最小行数
    244         *
    245         * @return      自動計算した行列の配列
    246         * @og.rtnNotNull
    247         */
    248        private int[] getRowsCols( final String value,final int cols, final int rows ) {
    249                if( value == null ) {
    250                        return new int[] { cols,rows };                                 // 6.3.9.1 (2015/11/27) 逆だったが、今まで大丈夫だった？
    251                }
    252
    253                final StringTokenizer token = new StringTokenizer( value, "\n", true );
    254
    255                int cntRow = 1;
    256                int maxCol = 0;
    257                while( token.hasMoreTokens() ) {
    258                        final String val = token.nextToken();
    259                        if( "\n".equals( val ) ) { cntRow++; }
    260                        else {
    261                                final byte[] byteValue = StringUtil.makeByte( val,CODE );       // 3.5.5.3 (2004/04/09)
    262                                final int byteSize = byteValue.length;
    263                                if( maxColSize > 0 && byteSize > maxColSize ) {         // 最大列数
    264                                        cntRow += byteSize / maxColSize;
    265                                        maxCol = maxColSize ;
    266                                }
    267                                else if( byteSize > maxCol ) { maxCol = byteSize; }
    268                        }
    269                        if( maxRowSize > 0 && cntRow >= maxRowSize ) {          // 最大行数
    270                                cntRow = maxRowSize;
    271                                break;
    272                        }
    273                }
    274
    275                maxCol += 2;    // マージン。フォントや画面サイズに影響する為、比率のほうがよい？
    276
    277                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
    278
    279                //                                      COL                                                     ROW
    280                return new int[] { Math.max( cols,maxCol ) , Math.max( rows,cntRow ) } ;        // 6.3.9.1 (2015/11/27)
    281        }
    282}