    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.TagBuffer;
    024
    025import static org.opengion.fukurou.util.StringUtil.isNull;                              // 6.1.1.0 (2015/01/17)
    026
    027/**
    028 * HM エディターは、カラムのデータを時分編集する場合に使用するクラスです。
    029 * 選択用ピッカーが付属します。
    030 *
    031 * 編集パラメータは、starthour , endhour , minutedivisions , showminutes の順に、
    032 * CSV形式で与えます。
    033 * 変数の数が少ない場合は、初期値が設定されます。
    034 * 初期値は、starthour="6" endhour="20" minutedivisions="4" showminutes="true" です。
    035 *
    036 * ex) 6,19,4,true
    037 * starthour            ：ピッカーの開始時間(0-23)
    038 * endhour                      ：ピッカーの終了時間(0-23)
    039 * minutedivisions      ：単位「分」の分割数。4なら15分単位。(2-60)
    040 * showminutes          ：分ピッカーの表示(true/false)
    041 * usesecond            ：秒付き(6桁、秒は00固定)で値を返すかどうか(true/false)
    042 * layout                       ：表示の縦横(vertical/horizon)
    043 *
    044 * このエディタはeventColumnに対応していません。
    045 *
    046 *  カラムの表示に必要な属性は, DBColumn オブジェクト より取り出します。
    047 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
    048 *
    049 * @og.rev 5.6.5.2 (2013/06/21) 新規作成
    050 * @og.rev 5.9.12.3 (2016/09/23) usesecond追加
    051 * @og.rev 5.9.17.2 (2017/02/17) layout追加
    052 * @og.group データ編集
    053 *
    054 * @version  5.0
    055 * @author   Takahashi Masakazu
    056 * @since    JDK6.0,
    057 */
    058public class Editor_HM extends AbstractEditor {
    059        /** このプログラムのVERSION文字列を設定します。   {@value} */
    060        private static final String VERSION = "6.9.8.0 (2018/05/28)" ;
    061
    062        private static final String PIC1 = "<img src=\"../image/clock.png\" class=\"clockpick\"  valuefield=\""; // altは付けない
    063        // 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"／＞" 止めを、"＞" に変更します)。
    064//      private static final String PIC2 = " />";
    065        private static final String PIC2 = " >";                // 7.0.1.0 (2018/10/15)
    066
    067        // 6.9.8.0 (2018/05/28) 賛否両論:前のタグの終了属性を、入れておく事で、文字列連結数を減らす。(属性の飛ばしがないので、良しとします。)
    068        private static final String OPT1 = "starthour=\"";
    069//      private static final String OPT2 = "endhour=\"";
    070//      private static final String OPT3 = "minutedivisions=\"";
    071//      private static final String OPT4 = "showminutes=\"";
    072//      private static final String OPT5 = "usesecond=\"";                      // 5.9.12.3 (2016/09/23)
    073//      private static final String OPT6 = "layout=\"";                         // 5.9.17.2 (2017/02/17)
    074        private static final String OPT2 = "\" endhour=\"";
    075        private static final String OPT3 = "\" minutedivisions=\"";
    076        private static final String OPT4 = "\" showminutes=\"";
    077        private static final String OPT5 = "\" usesecond=\"";           // 5.9.12.3 (2016/09/23)
    078        private static final String OPT6 = "\" layout=\"";                      // 5.9.17.2 (2017/02/17)
    079        private static final String END_ATTR = "\" ";
    080
    081//      private final String options;
    082        private final String endTag;            // 6.9.8.0 (2018/05/28) END_ATTR + options + PIC2 を、コンストラクターで行う。
    083
    084        // 6.9.8.0 (2018/05/28) disabled 時に、時間ピッカーを出さない対応
    085        private final boolean disabled ;
    086
    087        /**
    088         * デフォルトコンストラクター。
    089         * このコンストラクターで、基本オブジェクトを作成します。
    090         *
    091         * @og.rev 6.9.8.0 (2018/05/28) disabled 時に、時間ピッカーを出さない対応
    092         */
    093        public Editor_HM() {
    094                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
    095                // 4.3.4.4 (2009/01/01)
    096//              options  = null;                // 6.9.8.0 (2018/05/28) options は、endTag に、入れておく。
    097                disabled = false;               // 6.9.8.0 (2018/05/28) disabled 時に、時間ピッカーを出さない対応
    098                endTag   = null;                // 6.9.8.0 (2018/05/28) endTag は、disabled="false" なので、何でも良い。
    099        }
    100
    101        /**
    102         * DBColumnオブジェクトを指定したprivateコンストラクター。
    103         *
    104         * @og.rev 6.9.8.0 (2018/05/28) disabled 時に、時間ピッカーを出さない対応
    105         *
    106         * @param       clm     DBColumnオブジェクト
    107         */
    108        private Editor_HM( final DBColumn clm ) {
    109                super( clm );
    110                // 6.9.8.0 (2018/05/28) END_ATTR + options + PIC2 を、コンストラクターで行う。
    111//              options = createOptions( clm.getEditorParam() );
    112                tagBuffer.add( XHTMLTag.inputAttri( attributes ) );
    113
    114                disabled = "disabled".equalsIgnoreCase( attributes.get( "disabled" ) );                 // 6.9.8.0 (2018/05/28) disabled対応
    115                endTag   = disabled ? null
    116                                                        : END_ATTR + createOptions( clm.getEditorParam() ) + PIC2 ;     // 6.9.8.0 (2018/05/28) options対応
    117        }
    118
    119        /**
    120         * 各オブジェクトから自分のインスタンスを返します。
    121         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
    122         * まかされます。
    123         *
    124         * @param       clm     DBColumnオブジェクト
    125         *
    126         * @return      CellEditorオブジェクト
    127         * @og.rtnNotNull
    128         */
    129        public CellEditor newInstance( final DBColumn clm ) {
    130                return new Editor_HM( clm );
    131        }
    132
    133        /**
    134         * データの編集用文字列を返します。
    135         *
    136         * @og.rev 6.9.8.0 (2018/05/28) disabled 時に、時間ピッカーを出さない対応
    137         *
    138         * @param       value 入力値
    139         *
    140         * @return      データの編集用文字列
    141         * @og.rtnNotNull
    142         */
    143        @Override
    144        public String getValue( final String value ) {
    145                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    146                final String tag = new TagBuffer( "input" )
    147                                                .add( "name"    , name )
    148                                                .add( "id"              , name , isNull( attributes.get( "id" ) ) )             // 4.3.7.2 (2009/06/15)
    149                                                .add( "value"   , value )
    150                                                .add( "size"    , size1 )
    151                                                .add( tagBuffer.makeTag() )
    152                                                .makeTag();
    153
    154//              return tag + PIC1 + name + END_ATTR + options + PIC2 ;
    155                return disabled ? tag                                                                           // 6.9.8.0 (2018/05/28) disabled 時に、時間ピッカーを出さない対応
    156                                                : tag + PIC1 + name + endTag ;                          // 6.9.8.0 (2018/05/28) END_ATTR + options + PIC2 を、コンストラクターで行う。
    157        }
    158
    159        /**
    160         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
    161         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し,
    162         * リクエスト情報を１つ毎のフィールドで処理できます。
    163         *
    164         * @og.rev 6.9.8.0 (2018/05/28) disabled 時に、時間ピッカーを出さない対応
    165         *
    166         * @param       row   行番号
    167         * @param       value 入力値
    168         *
    169         * @return      データ表示/編集用の文字列
    170         * @og.rtnNotNull
    171         */
    172        @Override
    173        public String getValue( final int row,final String value ) {
    174                final String name2 =  name + HybsSystem.JOINT_STRING + row ;
    175
    176                // 6.1.1.0 (2015/01/17) TagBufferの連結記述
    177                final String tag = new TagBuffer( "input" )
    178                                                .add( "name"    , name2 )
    179                                                .add( "id"              , name2 , isNull( attributes.get( "id" ) ) )            // 4.3.7.2 (2009/06/15)
    180                                                .add( "value"   , value )
    181                                                .add( "size"    , size2 )
    182                                                .add( tagBuffer.makeTag() )
    183                                                .makeTag( row,value );
    184
    185//              return tag + PIC1 + name2 + END_ATTR + options + PIC2 ;
    186                return disabled ? tag                                                                           // 6.9.8.0 (2018/05/28) disabled 時に、時間ピッカーを出さない対応
    187                                                : tag + PIC1 + name2 + endTag ;                         // 6.9.8.0 (2018/05/28) END_ATTR + options + PIC2 を、コンストラクターで行う。
    188        }
    189
    190        /**
    191         * 編集パラメータから、オプション文字列を作成します。
    192         * 編集パラメータは、starthour , endhour , minutedivisions , showminutes の順に、
    193         * CSV形式で与えます。
    194         * 変数の数が少ない場合は、初期値が設定されます。
    195         * 初期値は、starthour="6" endhour="20" minutedivisions="4" showminutes="true" です。
    196         *
    197         * @og.rev 5.9.12.3 (2016/09/23) usesecond対応
    198         * @og.rfv 5.9.17.2 (2017/02/15) layout対応
    199         * @og.rfv 6.9.8.0 (2018/05/28) 賛否両論:前のタグの終了属性を、入れておく事で、文字列連結数を減らす。(属性の飛ばしがないので、良しとします。)
    200         *
    201         * @param       editPrm  編集パラメータ
    202         *
    203         * @return      パラメータのオプション文字列
    204         * @og.rtnNotNull
    205         */
    206        private String createOptions( final String editPrm ){
    207                if( editPrm == null ) { return "" ;}
    208                // 6.0.2.5 (2014/10/31) null でないことがわかっている値の冗長な null チェックがあります。
    209                final String[] param = editPrm.split( "," ) ;
    210                final String start  = param.length > 0 ? param[0].trim() : "6" ;
    211                final String end    = param.length > 1 ? param[1].trim() : "20" ;
    212                final String step   = param.length > 2 ? param[2].trim() : "4" ;
    213                final String min    = param.length > 3 ? param[3].trim() : "true" ;
    214                final String sec    = param.length > 4 ? param[4].trim() : "false" ;                    // 5.9.12.3 (2016/09/23)
    215                final String layout = param.length > 5 ? param[5].trim() : "vertical" ;                 // 5.9.17.2 (2017/02/15)
    216
    217//              return OPT1 + start + END_ATTR + OPT2 + end + END_ATTR + OPT3 + step + END_ATTR + OPT4 + min + END_ATTR + OPT5 + sec + END_ATTR + OPT6 + layout + END_ATTR; // 5.9.12.3 (2016/09/23)
    218                return OPT1 + start + OPT2 + end + OPT3 + step + OPT4 + min + OPT5 + sec + OPT6 + layout + END_ATTR;            // 6.9.8.0 (2018/05/28)
    219        }
    220}