    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.TagBuffer;
    024
    025import static org.opengion.fukurou.util.StringUtil.isNull;                              // 6.3.3.0 (2015/07/25)
    026
    027/**
    028 * カラムのデータをチェックボックスで編集する場合に使用するエディタークラスです。
    029 *
    030 * 値としては、"0" と、"1" のみ 有効です。("0" がOFF状態で、"1"がON状態です。)
    031 * チェックボックスは、通常チェックが入らないと何も送信されません。"0"から"1"への
    032 * 状態変化は、チェックされるためリクエスト値が送信されますが、"1"から"0"の場合は、
    033 * 送信されない為、データのクリアを取得することが出来ません。
    034 * このクラスでは、状態にかかわらず、hidden で、"0" を送信しています。受信側では、
    035 * 常に"0"がくる為、何もチェックされない場合は、"0"が設定されたことになります。
    036 * "1"が設定されると、"0"と"1"が両方(同じキーで)取得されます。その場合は、"1"を
    037 * 見つけることで、"1"をセットされたことが判ります。
    038 *
    039 * 編集パラメータに"SEQ"と記述することで正方向にしか選べないシークチェックボックスを実現できます。
    040 * これにより、シーケンスにステータスを順に挙げていくような、チェックボックス
    041 * を作成することが出来ます。(逆に戻れないメニュー)
    042 *
    043 * このエディタはeventColumnに対応していません。
    044 *
    045 * カラムの表示に必要な属性は, DBColumn オブジェクト より取り出します。
    046 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
    047 *
    048 * @og.rev 3.5.3.1 (2003/10/31) 新規作成
    049 * @og.group データ編集
    050 *
    051 * @version  4.0
    052 * @author   Kazuhiko Hasegawa
    053 * @since    JDK5.0,
    054 */
    055public class Editor_CHBOX extends AbstractEditor {
    056        /** このプログラムのVERSION文字列を設定します。   {@value} */
    057        private static final String VERSION = "7.0.1.0 (2018/10/15)" ;
    058
    059        private final boolean seqFlag ;                 // 3.6.0.6 (2004/10/22)
    060        private final String  HIDDEN0 ;                 // 3.6.0.6 (2004/10/22) , 6.1.1.0 (2015/01/17) 大文字に変更
    061        private final String  HIDDEN1 ;                 // 3.6.0.6 (2004/10/22) , 6.1.1.0 (2015/01/17) 大文字に変更
    062
    063        /**
    064         * デフォルトコンストラクター。
    065         * このコンストラクターで、基本オブジェクトを作成します。
    066         *
    067         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能(seqFlag)を追加します
    068         * @og.rev 3.6.0.6 (2004/10/22) 値が"1"の場合は、hiddenで "0" を出すことでクリアに対応
    069         */
    070        public Editor_CHBOX() {
    071                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
    072                // 4.3.4.4 (2009/01/01)
    073                seqFlag   = false;      // 3.6.0.6 (2004/10/22)
    074                HIDDEN0 = "";
    075                HIDDEN1 = "";
    076        }
    077
    078        /**
    079         * DBColumnオブジェクトを指定したprivateコンストラクター。
    080         *
    081         * @og.rev 3.5.6.0 (2004/06/18) XHTMLTag の 内部配列 INPUT_KEY を隠蔽します。
    082         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能(seqFlag)を追加します
    083         * @og.rev 3.6.0.6 (2004/10/22) 値が"1"の場合は、hiddenで "0" を出すことでクリアに対応
    084         * @og.rev 6.3.3.0 (2015/07/25) maxlength は不要なので削除
    085         *
    086         * @param       clm     DBColumnオブジェクト
    087         */
    088        private Editor_CHBOX( final DBColumn clm ) {
    089                super( clm );
    090                seqFlag    = "SEQ".equals( clm.getEditorParam() );      // 3.6.0.6 (2004/10/22)
    091                final String  readonly = clm.isWritable() ? null : "readonly" ;
    092
    093                attributes.set( "type"          , "checkbox"    );
    094                attributes.set( "readonly"      ,  readonly             );
    095                attributes.set( "NO_MAXLEN"     , "true"                );                      // 6.3.3.0 (2015/07/25) maxlength は不要なので削除
    096
    097                tagBuffer.add( XHTMLTag.inputAttri( attributes ) );
    098
    099                HIDDEN0 = "<input type=\"hidden\" value=\"0\" name=\"" + name ;         // 3.6.0.6 (2004/10/22)
    100                HIDDEN1 = "<input type=\"hidden\" value=\"1\" name=\"" + name ;         // 3.6.0.6 (2004/10/22)
    101        }
    102
    103        /**
    104         * 各オブジェクトから自分のインスタンスを返します。
    105         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
    106         * まかされます。
    107         *
    108         * @param       clm     DBColumnオブジェクト
    109         *
    110         * @return      CellEditorオブジェクト
    111         * @og.rtnNotNull
    112         */
    113        public CellEditor newInstance( final DBColumn clm ) {
    114                return new Editor_CHBOX( clm );
    115        }
    116
    117        /**
    118         * データの編集用文字列を返します。
    119         *
    120         * @og.rev 3.5.5.5 (2004/04/23) 新規に Attributes オブジェクトを作成する方式を止めます。
    121         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能(seqFlag)を追加します
    122         * @og.rev 3.6.0.6 (2004/10/22) 値が"1"の場合は、hiddenで "0" を出すことでクリアに対応
    123         * @og.rev 3.8.0.1 (2005/06/17) 値にかかわらず、hiddenで "0" を出すことでクリアに対応
    124         * @og.rev 6.3.3.0 (2015/07/25) CHBOX に、id属性を出力します。
    125         * @og.rev 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"／＞" 止めを、"＞" に変更します)。
    126         *
    127         * @param       value 入力値
    128         *
    129         * @return      データの編集用文字列
    130         * @og.rtnNotNull
    131         */
    132        @Override
    133        public String getValue( final String value ) {
    134                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    135                return new TagBuffer( "input" )
    136                                        .add( "name"            , name )
    137                                        .add( "id"                      , name , isNull( attributes.get( "id" ) ) )             // 6.3.3.0 (2015/07/25)
    138                                        .add( "value"           , "1" )
    139                                        .add( tagBuffer.makeTag() )
    140                                        .add( "checked"         , "checked"             , "1".equals( value ) )
    141                                        .add( "disabled"        , "disabled"    , "1".equals( value ) && seqFlag )
    142                                        .makeTag()
    143                                // 3.6.0.6 (2004/10/22) seqFlag=trueで、値が"1"の場合、
    144                                // disabled では値が飛ばないので、hidden で "1" を出力する。
    145                                + ( "1".equals( value ) && seqFlag ? HIDDEN1 : HIDDEN0 )
    146//                              + "\" />" ;
    147                                + "\" >" ;                      // 7.0.1.0 (2018/10/15)
    148        }
    149
    150        /**
    151         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
    152         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し,
    153         * リクエスト情報を１つ毎のフィールドで処理できます。
    154         *
    155         * @og.rev 3.5.5.0 (2004/03/12) 名前と行番号の区切り記号("__")を、HybsSystem.JOINT_STRING  に変更。
    156         * @og.rev 3.5.5.5 (2004/04/23) 新規に Attributes オブジェクトを作成する方式を止めます。
    157         * @og.rev 3.6.0.6 (2004/10/22) シーケンスアクセス機能(seqFlag)を追加します
    158         * @og.rev 3.6.0.6 (2004/10/22) 値が"1"の場合は、hiddenで "0" を出すことでクリアに対応
    159         * @og.rev 3.8.0.1 (2005/06/17) 値にかかわらず、hiddenで "0" を出すことでクリアに対応
    160         * @og.rev 6.3.3.0 (2015/07/25) CHBOX に、id属性を出力します。
    161         * @og.rev 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"／＞" 止めを、"＞" に変更します)。
    162         *
    163         * @param   row   行番号
    164         * @param   value 値
    165         *
    166         * @return  データ表示/編集用の文字列
    167         * @og.rtnNotNull
    168         */
    169        @Override
    170        public String getValue( final int row,final String value ) {
    171                final String newName = name + HybsSystem.JOINT_STRING + row;                                            // 6.3.3.0 (2015/07/25)
    172
    173                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    174                return new TagBuffer( "input" )
    175                                        .add( "name"            , newName )
    176                                        .add( "id"                      , newName , isNull( attributes.get( "id" ) ) )          // 6.3.3.0 (2015/07/25)
    177                                        .add( "value"           , "1" )
    178                                        .add( tagBuffer.makeTag() )
    179                                        .add( "checked"         , "checked"             , "1".equals( value ) )
    180                                        .add( "disabled"        , "disabled"    , "1".equals( value ) && seqFlag )
    181                                        .makeTag( row,value )
    182                                // 3.6.0.6 (2004/10/22) seqFlag=trueで、値が"1"の場合、
    183                                // disabled では値が飛ばないので、hidden で "1" を出力する。
    184                                + ( "1".equals( value ) && seqFlag ? HIDDEN1 : HIDDEN0 )
    185//                              + HybsSystem.JOINT_STRING + row + "\" />" ;
    186                                + HybsSystem.JOINT_STRING + row + "\" >" ;              // 7.0.1.0 (2018/10/15)
    187        }
    188}