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.hayabusa.common.HybsSystem;
022import org.opengion.hayabusa.resource.CodeData;                                                 // 7.4.2.0 (2021/04/30)
023// import org.opengion.fukurou.system.OgBuilder;                                                // 7.4.2.0 (2021/04/30) // 8.0.0.0 (2021/07/31) Delete
024import org.opengion.fukurou.util.XHTMLTag;
025import org.opengion.fukurou.util.TagBuffer;
026import org.opengion.fukurou.util.StringUtil;                                                    // 8.5.4.2 (2024/01/12) import static … を個別に記述
027
028// import static org.opengion.fukurou.util.StringUtil.isNull;                   // 6.3.3.0 (2015/07/25)
029
030/**
031 * カラムのデータをチェックボックスで編集する場合に使用するエディタークラスです。
032 *
033 * 値としては、"0" と、"1" のみ 有効です。("0" がOFF状態で、"1"がON状態です。)
034 * チェックボックスは、通常チェックが入らないと何も送信されません。"0"から"1"への
035 * 状態変化は、チェックされるためリクエスト値が送信されますが、"1"から"0"の場合は、
036 * 送信されない為、データのクリアを取得することが出来ません。
037 * このクラスでは、状態にかかわらず、hidden で、"0" を送信しています。受信側では、
038 * 常に"0"がくる為、何もチェックされない場合は、"0"が設定されたことになります。
039 * "1"が設定されると、"0"と"1"が両方(同じキーで)取得されます。その場合は、"1"を
040 * 見つけることで、"1"をセットされたことが判ります。
041 *
042 * 編集パラメータに"SEQ"と記述することで正方向にしか選べないシークチェックボックスを実現できます。
043 * これにより、シーケンスにステータスを順に挙げていくような、チェックボックス
044 * を作成することが出来ます。(逆に戻れないメニュー)
045 *
046 * このエディタはeventColumnに対応していません。
047 *
048 * カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
049 * このクラスは、DBColumn オブジェクト毎に1つ作成されます。
050 *
051 * 7.4.2.0 (2021/04/30)
052 *   コードリソースの値を利用して、ラベルを付けることができるようにします。
053 *   (値は、0,1 のみで、ラベルが付くのは、1 のみです。)
054 *   ラベル表示が必要な場合は、編集パラメータに、"useLabel"と
055 *   記述しておくことで、ラベルを出力することが可能です。
056 *
057 * @og.rev 3.5.3.1 (2003/10/31) 新規作成
058 * @og.group データ編集
059 *
060 * @version     4.0
061 * @author      Kazuhiko Hasegawa
062 * @since       JDK5.0,
063 */
064public class Editor_CHBOX extends AbstractEditor {
065        /** このプログラムのVERSION文字列を設定します。 {@value} */
066        private static final String VERSION = "8.5.3.0 (2023/09/08)" ;
067
068        private final boolean seqFlag ;                 // 3.6.0.6 (2004/10/22)
069        private final String  HIDDEN0 ;                 // 3.6.0.6 (2004/10/22) 6.1.1.0 (2015/01/17) 大文字に変更
070        private final String  HIDDEN1 ;                 // 3.6.0.6 (2004/10/22) 6.1.1.0 (2015/01/17) 大文字に変更
071        private final boolean useLabel;                 // 7.4.2.0 (2021/04/30)
072        private final String  labelTag;                 // 7.4.2.0 (2021/04/30)
073        private final String  shortlbl;                 // 7.4.2.0 (2021/04/30)
074
075        /**
076         * デフォルトコンストラクター。
077         * このコンストラクターで、基本オブジェクトを作成します。
078         *
079         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能(seqFlag)を追加します
080         * @og.rev 3.6.0.6 (2004/10/22) 値が"1"の場合は、hiddenで "0" を出すことでクリアに対応
081         * @og.rev 7.4.2.0 (2021/04/30) 編集パラメータに、"useLabel"と記述しておくことで、ラベルを出力することが可能
082         */
083        public Editor_CHBOX() {
084                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
085                // 4.3.4.4 (2009/01/01)
086                seqFlag         = false;        // 3.6.0.6 (2004/10/22)
087                HIDDEN0         = "";
088                HIDDEN1         = "";
089                useLabel        = false;        // 7.4.2.0 (2021/04/30)
090                labelTag        = "";           // 7.4.2.0 (2021/04/30)
091                shortlbl        = "";           // 7.4.2.0 (2021/04/30)
092        }
093
094        /**
095         * DBColumnオブジェクトを指定したprivateコンストラクター。
096         *
097         * @og.rev 3.5.6.0 (2004/06/18) XHTMLTag の 内部配列 INPUT_KEY を隠蔽します。
098         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能(seqFlag)を追加します
099         * @og.rev 3.6.0.6 (2004/10/22) 値が"1"の場合は、hiddenで "0" を出すことでクリアに対応
100         * @og.rev 6.3.3.0 (2015/07/25) maxlength は不要なので削除
101         * @og.rev 7.4.2.0 (2021/04/30) 編集パラメータに、"useLabel"と記述しておくことで、ラベルを出力することが可能
102         * @og.rev 8.5.3.0 (2023/09/08) DynamicAttributes対応
103         *
104         * @param       clm     DBColumnオブジェクト
105         */
106        private Editor_CHBOX( final DBColumn clm ) {
107                super( clm );
108                seqFlag    = "SEQ".equals( clm.getEditorParam() );      // 3.6.0.6 (2004/10/22)
109                final String  readonly = clm.isWritable() ? null : "readonly" ;
110
111                attributes.set( "type"          , "checkbox"    );
112                attributes.set( "readonly"      ,  readonly             );
113                attributes.set( "p_NO_MAXLEN", "true"           );                      // 6.3.3.0 (2015/07/25) maxlength は不要なので削除 8.5.3.0 (2023/09/08) 先頭に"p_"付与
114
115                tagBuffer.add( XHTMLTag.inputAttri( attributes ) );
116
117                HIDDEN0 = "<input type=\"hidden\" value=\"0\" name=\"" + name ;         // 3.6.0.6 (2004/10/22)
118                HIDDEN1 = "<input type=\"hidden\" value=\"1\" name=\"" + name ;         // 3.6.0.6 (2004/10/22)
119
120                // 7.4.2.0 (2021/04/30) 編集パラメータに、"useLabel"と記述しておくことで、ラベルを出力することが可能
121                // 本来は、CHBOX2では、Selection を使いますが、CHBOXは、1 の時のラベルのみ使うので、直接CodeDataから取り出します。
122                useLabel = "useLabel".equalsIgnoreCase( clm.getEditorParam() );
123                if( useLabel ) {
124                        final StringBuilder buf = new StringBuilder().append( "<label" );
125
126                        final String cls = attributes.get( "class" );
127                        if( cls != null && !cls.isEmpty() ) {
128                                buf.append( " class=\"" ).append( cls ).append( '"' );
129                        }
130                        labelTag = buf.append( '>' ).toString();
131
132                        final CodeData cdData = clm.getCodeData();
133                        if( cdData != null ) {
134                                shortlbl = cdData.getShortLabel(0);             // 無条件に最初のコードリソースのラベルを使用します。
135                        }
136                        else {
137                                shortlbl = "";
138                        }
139                }
140                else {
141                        labelTag = "";
142                        shortlbl = "";
143                }
144        }
145
146        /**
147         * 各オブジェクトから自分のインスタンスを返します。
148         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
149         * まかされます。
150         *
151         * @param       clm     DBColumnオブジェクト
152         *
153         * @return      CellEditorオブジェクト
154         * @og.rtnNotNull
155         */
156        public CellEditor newInstance( final DBColumn clm ) {
157                return new Editor_CHBOX( clm );
158        }
159
160        /**
161         * データの編集用文字列を返します。
162         *
163         * @og.rev 3.5.5.5 (2004/04/23) 新規に Attributes オブジェクトを作成する方式を止めます。
164         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能(seqFlag)を追加します
165         * @og.rev 3.6.0.6 (2004/10/22) 値が"1"の場合は、hiddenで "0" を出すことでクリアに対応
166         * @og.rev 3.8.0.1 (2005/06/17) 値にかかわらず、hiddenで "0" を出すことでクリアに対応
167         * @og.rev 6.3.3.0 (2015/07/25) CHBOX に、id属性を出力します。
168         * @og.rev 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"/>" 止めを、">" に変更します)。
169         * @og.rev 7.4.2.0 (2021/04/30) 編集パラメータに、"useLabel"と記述しておくことで、ラベルを出力することが可能
170         *
171         * @param       value   入力値
172         *
173         * @return      データの編集用文字列
174         * @og.rtnNotNull
175         */
176        @Override
177        public String getValue( final String value ) {
178                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
179                // 7.4.2.0 (2021/04/30)
180//              return new TagBuffer( "input" )
181                final String chbox = new TagBuffer( "input" )
182                                        .add( "name"            , name )
183                                        // 8.5.4.2 (2024/01/12) import static … を個別に記述
184                                        .add( "id"                      , name , StringUtil.isNull( attributes.get( "id" ) ) )          // 6.3.3.0 (2015/07/25)
185                                        .add( "value"           , "1" )
186                                        .add( tagBuffer.makeTag() )
187                                        .add( "checked"         , "checked"             , "1".equals( value ) )
188                                        .add( "disabled"        , "disabled"    , "1".equals( value ) && seqFlag )
189                                        .makeTag()
190                                // 3.6.0.6 (2004/10/22) seqFlag=trueで、値が"1"の場合、
191                                // disabled では値が飛ばないので、hidden で "1" を出力する。
192                                + ( "1".equals( value ) && seqFlag ? HIDDEN1 : HIDDEN0 )
193//                              + "\" />" ;
194                                + "\" >" ;                      // 7.0.1.0 (2018/10/15)
195
196                // 7.4.2.0 (2021/04/30)
197                return useLabel ? new StringBuilder( BUFFER_MIDDLE )
198                                                                .append( labelTag )
199                                                                .append( chbox )
200                                                                .append( shortlbl )
201                                                                .append( "</label>" )
202                                                                .toString()
203                                                : chbox ;
204        }
205
206        /**
207         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
208         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し、
209         * リクエスト情報を1つ毎のフィールドで処理できます。
210         *
211         * @og.rev 3.5.5.0 (2004/03/12) 名前と行番号の区切り記号("__")を、HybsSystem.JOINT_STRING  に変更。
212         * @og.rev 3.5.5.5 (2004/04/23) 新規に Attributes オブジェクトを作成する方式を止めます。
213         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能(seqFlag)を追加します
214         * @og.rev 3.6.0.6 (2004/10/22) 値が"1"の場合は、hiddenで "0" を出すことでクリアに対応
215         * @og.rev 3.8.0.1 (2005/06/17) 値にかかわらず、hiddenで "0" を出すことでクリアに対応
216         * @og.rev 6.3.3.0 (2015/07/25) CHBOX に、id属性を出力します。
217         * @og.rev 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"/>" 止めを、">" に変更します)。
218         * @og.rev 7.4.2.0 (2021/04/30) 編集パラメータに、"useLabel"と記述しておくことで、ラベルを出力することが可能
219         *
220         * @param       row             行番号
221         * @param       value   値
222         *
223         * @return      データ表示/編集用の文字列
224         * @og.rtnNotNull
225         */
226        @Override
227        public String getValue( final int row,final String value ) {
228                final String newName = name + HybsSystem.JOINT_STRING + row;                                            // 6.3.3.0 (2015/07/25)
229
230                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
231                // 7.4.2.0 (2021/04/30)
232//              return new TagBuffer( "input" )
233                final String chbox = new TagBuffer( "input" )
234                                        .add( "name"            , newName )
235                                        // 8.5.4.2 (2024/01/12) import static … を個別に記述
236                                        .add( "id"                      , newName , StringUtil.isNull( attributes.get( "id" ) ) )               // 6.3.3.0 (2015/07/25)
237                                        .add( "value"           , "1" )
238                                        .add( tagBuffer.makeTag() )
239                                        .add( "checked"         , "checked"             , "1".equals( value ) )
240                                        .add( "disabled"        , "disabled"    , "1".equals( value ) && seqFlag )
241                                        .makeTag( row,value )
242                                // 3.6.0.6 (2004/10/22) seqFlag=trueで、値が"1"の場合、
243                                // disabled では値が飛ばないので、hidden で "1" を出力する。
244                                + ( "1".equals( value ) && seqFlag ? HIDDEN1 : HIDDEN0 )
245//                              + HybsSystem.JOINT_STRING + row + "\" />" ;
246                                + HybsSystem.JOINT_STRING + row + "\" >" ;              // 7.0.1.0 (2018/10/15)
247
248                // 7.4.2.0 (2021/04/30)
249                return useLabel ? new StringBuilder( BUFFER_MIDDLE )
250                                                                .append( labelTag )
251                                                                .append( chbox )
252                                                                .append( shortlbl )
253                                                                .append( "</label>" )
254                                                                .toString()
255                                                : chbox ;
256        }
257}