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.fukurou.util.StringUtil;
019import org.opengion.hayabusa.db.AbstractEditor;
020import org.opengion.hayabusa.db.CellEditor;
021import org.opengion.hayabusa.db.DBColumn;
022import org.opengion.fukurou.util.XHTMLTag;
023
024/**
025 * NUMBER エディターは、カラムのデータを数字編集する場合に使用するクラスです。
026 *
027 *  カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
028 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
029 *
030 * @og.group データ編集
031 *
032 * @version  4.0
033 * @author       Kazuhiko Hasegawa
034 * @since    JDK5.0,
035 */
036public class Editor_NUMBER extends AbstractEditor {
037        /** このプログラムのVERSION文字列を設定します。   {@value} */
038        private static final String VERSION = "4.0.0.0 (2005/08/31)" ;
039
040        private final int        minFraction;
041
042        /**
043         * デフォルトコンストラクター。
044         * このコンストラクターで、基本オブジェクトを作成します。
045         *
046         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
047         * @og.rev 3.3.0.0 (2003/06/23) 初期値設定追加。
048         *
049         */
050        public Editor_NUMBER() {
051                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
052                // 4.3.4.4 (2009/01/01)
053                minFraction = 0;
054        }
055
056        /**
057         * DBColumnオブジェクトを指定したprivateコンストラクター。
058         *
059         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
060         * @og.rev 3.3.0.0 (2003/06/23) 初期値設定追加。NumberFormatクラスは、廃止します。
061         * @og.rev 3.5.6.0 (2004/06/18) XHTMLTag の 内部配列 INPUT_KEY を隠蔽します。
062         *
063         * @param       clm     DBColumnオブジェクト
064         */
065        private Editor_NUMBER( final DBColumn clm ) {
066                super( clm );
067                minFraction = clm.getSizeY();
068
069                // -XXX,XXX,XXX.YYY 形式では、カンマ、小数点、マイナスなどの項目が入ります。
070                final int maxlength = (int)(clm.getSizeX() * 4.0/3.0) + minFraction + 2 ;       // +2 は、マイナスと小数点
071                attributes.set( "maxlength"   ,String.valueOf( maxlength ) );
072                tagBuffer.add( XHTMLTag.inputAttri( attributes ) );
073        }
074
075        /**
076         * 各オブジェクトから自分のインスタンスを返します。
077         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
078         * まかされます。
079         *
080         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
081         * @og.rev 3.1.2.1 (2003/04/10) synchronized を、削除します。
082         *
083         * @param       clm     DBColumnオブジェクト
084         *
085         * @return      CellEditorオブジェクト
086         * @og.rtnNotNull
087         */
088        public CellEditor newInstance( final DBColumn clm ) {
089                return new Editor_NUMBER( clm );
090        }
091
092        /**
093         * データの編集用文字列を返します。
094         *
095         * @param   value 入力値
096         *
097         * @return  データの編集用文字列
098         */
099        @Override
100        public String getValue( final String value ) {
101                return super.getValue( formatValue( value ) );
102        }
103
104        /**
105         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
106         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し、
107         * リクエスト情報を１つ毎のフィールドで処理できます。
108         *
109         * @param       row   行番号
110         * @param       value 入力値
111         *
112         * @return      データ表示/編集用の文字列
113         */
114        @Override
115        public String getValue( final int row,final String value ) {
116                return super.getValue( row,formatValue( value ) );
117        }
118
119        /**
120         * 内部的なフォーマット変換後の文字列を返します。
121         *
122         * @og.rev 3.3.0.0 (2003/06/23) NumberFormatクラスは、廃止します。
123         *
124         * @param       value 入力値
125         *
126         * @return      データの表示用文字列
127         */
128        private String formatValue( final String value ) {
129                return StringUtil.numberFormat( value,minFraction );
130        }
131}