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