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.common.HybsSystem;
019import org.opengion.hayabusa.db.AbstractEditor;
020import org.opengion.hayabusa.db.CellEditor;
021import org.opengion.hayabusa.db.DBColumn;
022import org.opengion.fukurou.util.XHTMLTag;
023import org.opengion.fukurou.util.Attributes;
024import org.opengion.fukurou.util.TagBuffer;
025
026import org.opengion.hayabusa.db.Selection;                                                              // 6.4.4.0 (2016/03/11)
027import org.opengion.hayabusa.db.SelectionFactory;                                               // 6.4.4.0 (2016/03/11)
028
029/**
030 * CHBOX2 ｴﾃﾞｨﾀｰは、ｶﾗﾑのﾃﾞｰﾀをﾁｪｯｸﾎﾞｯｸｽで編集する場合に使用するｸﾗｽです。
031 *
032 * このｴﾃﾞｨﾀｰは、CHBOXとは異なりﾁｪｯｸﾎﾞｯｸｽ特有の制御を全く行いません。
033 * 特性としては、typeがcheckboxであるという1点を除いて、TEXT ｴﾃﾞｨﾀｰと同じです
034 *
035 * ﾗﾍﾞﾙ表示が必要な場合は、編集ﾊﾟﾗﾒｰﾀに、"useLabel"と
036 * 記述しておくことで、ﾗﾍﾞﾙを出力することが可能です。
037 *
038 * ｶﾗﾑの表示に必要な属性は、DBColumn ｵﾌﾞｼﾞｪｸﾄ より取り出します。
039 * このｸﾗｽは、DBColumn ｵﾌﾞｼﾞｪｸﾄ毎に１つ作成されます。
040 *
041 * 6.4.4.0 (2016/03/11)
042 * ﾁｪｯｸﾎﾞｯｸｽとして、ﾁｪｯｸした値を送信する機能に、ｺｰﾄﾞﾘｿｰｽの値を
043 * 指定できるようにします。これは、ﾌﾟﾙﾀﾞｳﾝﾒﾆｭｰのﾏﾙﾁﾌﾟﾙと同じ効果が
044 * 期待できます。
045 * ｺｰﾄﾞﾘｿｰｽは、無くてもかまいません。
046 *
047 * @og.group ﾃﾞｰﾀ編集
048 *
049 * @version     6.4
050 * @author      Kazuhiko Hasegawa
051 * @since       JDK8.0,
052 */
053public class Editor_CHBOX2 extends AbstractEditor {
054        /** このﾌﾟﾛｸﾞﾗﾑのVERSION文字列を設定します。 {@value} */
055        private static final String VERSION = "8.5.3.0 (2023/09/08)" ;
056
057        /** 6.4.4.0 (2016/03/11) CHBOX2 は、Selection は、必須ではなく、定義されていれば使う程度 */
058        private final Selection selection ;             // 6.4.4.0 (2016/03/11)
059        private final boolean writable  ;
060        private final boolean useLabel  ;               // 4.3.3.0 (2008/10/01)
061
062        /**
063         * ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ。
064         * このｺﾝｽﾄﾗｸﾀｰで、基本ｵﾌﾞｼﾞｪｸﾄを作成します。
065         *
066         * @og.rev 6.4.4.0 (2016/03/11) CHBOX2は、ｺｰﾄﾞﾘｿｰｽも使用できるように変更。
067         */
068        public Editor_CHBOX2() {
069                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
070                selection = null;
071                writable  = false;
072                useLabel  = false;
073        }
074
075        /**
076         * DBColumnｵﾌﾞｼﾞｪｸﾄを指定したprivateｺﾝｽﾄﾗｸﾀｰ。
077         *
078         * @og.rev 6.3.3.0 (2015/07/25) maxlength は不要なので削除
079         * @og.rev 6.4.4.0 (2016/03/11) CHBOX2は、ｺｰﾄﾞﾘｿｰｽも使用できるように変更。
080         * @og.rev 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
081         * @og.rev 8.5.3.0 (2023/09/08) DynamicAttributes対応
082         *
083         * @param       clm     DBColumnｵﾌﾞｼﾞｪｸﾄ
084         */
085        private Editor_CHBOX2( final DBColumn clm ) {
086                super( clm );
087                attributes.set( "type"          , "checkbox"    );
088                attributes.set( "p_NO_MAXLEN", "true"           );                      // 6.3.3.0 (2015/07/25) maxlength は不要なので削除 8.5.3.0 (2023/09/08) 先頭に"p_"付与
089
090                tagBuffer.add( XHTMLTag.inputAttri( attributes ) );
091
092                // CHBOX2 は、ｺｰﾄﾞﾘｿｰｽ(selection)が存在しない場合もありうる。
093                final String addKeyLabel = clm.getAddKeyLabel();                // 6.2.0.0 (2015/02/27) ｷｰ:ﾗﾍﾞﾙ形式
094                selection = SelectionFactory.newSelection( "CHBOX" , clm.getCodeData(), addKeyLabel );
095
096                // 6.4.4.0 (2016/03/11) CHBOX2は、ｺｰﾄﾞﾘｿｰｽも使用できるように変更。
097                writable = clm.isWritable();
098
099                // 6.1.1.0 (2015/01/17) Attributesの連結記述
100                attributes = new Attributes()
101                                        .set( clm.getEditorAttributes() )                               // #addAttributes( Attributes ) の代替え
102                                        .add( "class","CHBOX" );
103
104                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
105                // 7.0.5.1 (2019/09/27) optionAttributes が二重に設定されていたため、削除
106                tagBuffer.add( XHTMLTag.inputAttri( attributes ) );
107//                               .add( attributes.get( "optionAttributes" ) );          // 6.0.4.0 (2014/11/28)
108
109                useLabel = "useLabel".equalsIgnoreCase( clm.getEditorParam() );
110        }
111
112        /**
113         * 各ｵﾌﾞｼﾞｪｸﾄから自分のｲﾝｽﾀﾝｽを返します。
114         * 自分自身をｷｬｯｼｭするのか、新たに作成するのかは、各ｻﾌﾞｸﾗｽの実装に
115         * まかされます。
116         *
117         * @param       clm     DBColumnｵﾌﾞｼﾞｪｸﾄ
118         *
119         * @return      CellEditorｵﾌﾞｼﾞｪｸﾄ
120         * @og.rtnNotNull
121         */
122        public CellEditor newInstance( final DBColumn clm ) {
123                return new Editor_CHBOX2( clm );
124        }
125
126        /**
127         * ﾃﾞｰﾀの編集用文字列を返します。
128         *
129         * @og.rev 6.4.4.0 (2016/03/11) ﾁｪｯｸﾎﾞｯｸｽの横に値をﾗﾍﾞﾙ表示します
130         *
131         * @param       value   値
132         *
133         * @return      ﾃﾞｰﾀの編集用文字列
134         * @og.rtnNotNull
135         */
136        @Override
137        public String getValue( final String value ) {
138                final String chbox ;
139
140                if( selection == null ) {
141                        chbox = new StringBuilder( BUFFER_MIDDLE )
142                                                        .append( "<label>" )
143                                                        .append( super.getValue( value ) )
144                                                        .append( value )
145                                                        .append( "</label>" )
146                                                        .toString();
147                }
148                else {
149                        if( writable ) {
150                                chbox = selection.getOption( name,value,true );                 // 6.2.2.4 (2015/04/24)
151                        }
152                        else {
153                                chbox = selection.getValueLabel( value,true );                  // 6.2.2.4 (2015/04/24) useLabel
154                        }
155                }
156
157                return new TagBuffer( "pre" )
158                                        .add( tagBuffer.makeTag() )
159                                        .addBody( chbox )
160                                        .makeTag();
161        }
162
163        /**
164         * name属性を変えた、ﾃﾞｰﾀ表示/編集用のHTML文字列を作成します。
165         * ﾃｰﾌﾞﾙ上の name に 行番号を付加して、名前_行番号 で登録するｷｰを作成し、
166         * ﾘｸｴｽﾄ情報を１つ毎のﾌｨｰﾙﾄﾞで処理できます。
167         *
168         * @og.rev 6.4.4.0 (2016/03/11) ﾁｪｯｸﾎﾞｯｸｽの横に値をﾗﾍﾞﾙ表示します。
169         *
170         * @param       row             行番号
171         * @param       value   値
172         *
173         * @return      ﾃﾞｰﾀ表示/編集用の文字列
174         * @og.rtnNotNull
175         */
176        @Override
177        public String getValue( final int row,final String value ) {
178                final String chbox ;
179
180                if( selection == null ) {
181                        chbox = new StringBuilder( BUFFER_MIDDLE )
182                                                .append( "<label>" )
183                                                .append( super.getValue( row,value ) )
184                                                .append( useLabel ? value : "" )
185                                                .append( "</label>" )
186                                                .toString();
187                }
188                else {
189                        if( writable ) {
190                                chbox = selection.getOption( name + HybsSystem.JOINT_STRING + row,value,useLabel );             // 6.2.2.4 (2015/04/24)
191                }
192                else {
193                                chbox = selection.getValueLabel( value,useLabel );              // 6.2.2.4 (2015/04/24)
194                        }
195                }
196
197                return new TagBuffer( "pre" )
198                                        .add( tagBuffer.makeTag() )
199                                        .addBody( chbox )
200                                        .makeTag( row,value );
201        }
202}