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.view;
017
018import java.util.List;
019
020import org.opengion.hayabusa.common.HybsSystem;
021import org.opengion.hayabusa.common.HybsSystemException;
022import org.opengion.hayabusa.html.TableFormatter;
023
024/**
025 * フォーマットを外部から指定して作成する自由レイアウトの、テキストフィールド表示クラスです。
026 *
027 * AbstractViewForm により、setter/getterメソッドのデフォルト実装を提供しています。
028 * 各HTMLのタグに必要な setter/getterメソッドのみ、追加定義しています。
029 * [XXXX]は、カラムを指定します。ラベル+入力フィールドをそれぞれtdで囲います。
030 * [#XXXX]は、テーブルタグのtdを使用せず、ラベルと入力フィールドを出力します。
031 * [$XXXX]は、ラベルもtdも出さずに、入力フィールドのみ出力します。
032 * [!XXXX]は、値のみ出力します。
033 * 特殊記号の解釈は、HTMLFormatTextField系とHTMLFormatTable系で異なりますので
034 * ご注意ください。
035 *
036 * AbstractViewForm を継承している為、ロケールに応じたラベルを出力させる事が出来ます。
037 *
038 * @og.group 画面表示
039 *
040 * @version  4.0
041 * @author   Kazuhiko Hasegawa
042 * @since    JDK5.0,
043 */
044public class ViewForm_HTMLFormatTextField extends ViewForm_HTMLTextField {
045        /** このプログラムのVERSION文字列を設定します。   {@value} */
046        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
047
048        /** 4.0.0 (2005/01/31) HTML_LABEL_SEPARATOR を boolean 変数として取得します。 */
049        private final String CLM = HybsSystem.sysBool( "HTML_LABEL_SEPARATOR" ) ? ":" : "" ;
050
051        /** 3.5.4.0 (2003/11/25) TableFormatter クラス追加 */
052        private TableFormatter format   ;
053
054        /**
055         * デフォルトコンストラクター
056         *
057         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
058         */
059        public ViewForm_HTMLFormatTextField() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
060
061        /**
062         * フォーマットを設定します。
063         *
064         * @og.rev 3.5.4.0 (2003/11/25) 新規作成
065         * @og.rev 6.2.0.0 (2015/02/27) フォーマット系の noDisplay 対応。ロジックを共通にするため、処理を移動
066         *
067         * @param       list    TableFormatterのリスト
068         */
069        @Override
070        public void setFormatterList( final List<TableFormatter> list ) {               // 4.3.3.6 (2008/11/15) Generics警告対応
071                format = list.get(0);           // 4.3.3.6 (2008/11/15) Generics警告対応
072        }
073
074        /**
075         * DBTableModel から HTML文字列を作成して返します。
076         * startNo(表示開始位置)から、pageSize(表示件数)までのView文字列を作成します。
077         * 表示残りデータが pageSize 以下の場合は、残りのデータをすべて出力します。
078         *
079         * @og.rev 2.0.1.0 (2002/10/10) ラベルだけ、フィールドだけを取り出すフォーマットを追加
080         * @og.rev 2.0.1.0 (2002/10/10) ラベルとフィールドのセパレーターとして、コロン(:)を使用するかどうかを指定できる
081         * @og.rev 3.2.4.0 (2003/06/12) makeFormat() する位置を移動。
082         * @og.rev 3.5.4.0 (2003/11/25) TableFormatter クラスを使用するように変更。
083         * @og.rev 3.5.5.0 (2004/03/12) systemFormat(例:[KEY.カラム名]形式等)の対応
084         * @og.rev 5.0.0.2 (2009/09/15) フォーマットが設定されていない場合のエラー追加
085         * @og.rev 5.6.2.3 (2013/03/22) DBColumn に、useSLabel="false" の値をセットします。
086         *
087         * @param  startNo    表示開始位置
088         * @param  pageSize   表示件数
089         *
090         * @return  DBTableModelから作成された HTML文字列
091         * @og.rtnNotNull
092         */
093        @Override
094        public String create( final int startNo, final int pageSize )  {
095                if( getRowCount() == 0 ) { return ""; } // 暫定処置
096
097                noSLabelSetting();              // 5.6.2.3 (2013/03/22) DBColumn に、useSLabel="false" の値をセットします。
098
099                // 4.3.1.0 (2008/09/08)
100                if( format == null ) {
101                        final String errMsg = "ViewTagで canUseFormat() = true の場合、Formatter は必須です。";
102                        throw new HybsSystemException( errMsg );
103                }
104                // 6.2.0.0 (2015/02/27) フォーマット系の noDisplay 対応
105                // ※ makeFormat の直後に setFormatNoDisplay を実行する順番を他のクラスと合わせます。
106                // 元の場所では、setColumnDisplay のタイミングが後なので、うまく動きません
107                format.makeFormat( getDBTableModel() );         // 6.2.0.0 (2015/02/27) #setFormatterList( List<TableFormatter> ) から移動
108                setFormatNoDisplay( format );
109
110                final StringBuilder out = new StringBuilder( BUFFER_LARGE )
111                        .append( getCountForm( startNo,pageSize ) )
112                        .append( makeSelectNo( startNo ) ).append( CR )
113                        .append( format.getTrTag() );
114
115                int cl = 0;
116                for( ; cl<format.getLocationSize(); cl++ ) {
117                        out.append( format.getFormat(cl) );
118                        final int loc = format.getLocation(cl);
119                        if( loc < 0 ) {
120                                out.append(  format.getSystemFormat(startNo,loc) ); // 5.0.0.2 (2009/09/15)
121                                continue ;
122                        }
123
124                        final char type = format.getType(cl);
125                        if( type == '#' ) {
126                                out.append("<span id=\"label\">")
127                                        .append( getColumnLabel(loc) )
128                                        .append( CLM )
129                                        .append("</span>");
130                        }
131                        else if( type == '$' ) {
132                                out.append( getValueLabel(startNo,loc) );
133                        }
134                        else if( type == '!' ) {
135                                out.append( getValue(startNo,loc) );
136                        }
137                        else {
138                                out.append("<td id=\"label\">")
139                                        .append( getColumnLabel(loc) )
140                                        .append( CLM )
141                                        .append("</td><td>")
142                                        .append( getValueLabel(startNo,loc) )
143                                        .append("</td>");
144                        }
145                }
146                out.append( format.getFormat(cl) );
147
148                return out.toString();
149        }
150
151        /**
152         * 内容をクリア(初期化)します。
153         *
154         * @og.rev 2.0.1.0 (2002/10/10) ラベルだけ、フィールドだけを取り出すフォーマットを追加
155         * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
156         * @og.rev 3.5.4.0 (2003/11/25) TableFormatter クラスを使用するように変更。
157         *
158         */
159        @Override
160        public void clear() {
161                super.clear();
162                format          = null;
163        }
164
165        /**
166         * フォーマットメソッドを使用できるかどうかを問い合わせます。
167         *
168         * @return  使用可能(true)/ 使用不可能 (false)
169         */
170        @Override
171        public boolean canUseFormat() {
172                return true;
173        }
174
175        /**
176         * 表示項目の編集(並び替え)が可能かどうかを返します。
177         *
178         * @og.rev 5.1.6.0 (2010/05/01) 新規追加
179         *
180         * @return      表示項目の編集(並び替え)が可能かどうか(false:不可能)
181         */
182        @Override
183        public boolean isEditable() {
184                return false;
185        }
186}