    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.hayabusa.taglib;
    017
    018import org.opengion.fukurou.util.TagBuffer;
    019import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
    020
    021import static org.opengion.fukurou.util.StringUtil.nval ;               // 6.1.0.0 (2014/12/26)
    022
    023/**
    024 * option/ogTbodyMovable.js JavaScript を利用したマウスによる上下移動にシンクロ等させます。
    025 *
    026 * headタグで、useTbodyMovable="true" をセットすると、マウスまたはカーソルで、
    027 * tbody 部を上下に移動させることが可能です。
    028 * このタグは、その動作に関連付けて、同期して移動させたり、内容を入れ替えるカラムや
    029 * 内容に、＋１、－１するカラム、移動の制限（入替対象にしない、ドラッグできないなど）
    030 * を指定します。
    031 * 記述は、view の後で構いません。
    032 *
    033 * このタグを有効にするには、headタグで、useTbodyMovable="true" をセットする必要があります。
    034 * なお、この JavaScript は、１行単位に tbody を記述している view であれば、有効です。
    035 * 内部で、tr ではなく、tbody を処理しているためです。
    036 * （つまり、ガント専用ではありませんが、HTMLTableには使えません。）
    037 *
    038 * このタグは、span タグを出力し、ogTbodyMovable.js で処理しています。その際のキーとして、
    039 * span タグ には、class="tbodyMovable" を付けています。
    040 *
    041 * @og.formSample
    042 * ●形式：&lt;og:tbodyMovable  ... /&gt;
    043 * ●body：なし
    044 * ●前提：headタグで、useTbodyMovable="true" を指定してください。
    045 *
    046 * ●Tag定義：
    047 *   &lt;og:tbodyMovable
    048 *       seqclm             【TAG】移動時に値を入れ替えするカラム名(CSV形式で複数指定可能,先頭名称で判断)(初期値:SEQ)
    049 *       noMove             【TAG】入替制限する tbodyのクラス名(CSV形式で複数指定可能)
    050 *       noDrag             【TAG】マウスでドラッグできない tbodyのクラス名(CSV形式で複数指定可能)
    051 *       adjustSeq          【TAG】上移動(-1)、下移動(+1)で、値をセットするカラム名(１つのみ、seqclmで指定されている必要あり)
    052 *       sync               【TAG】他のTABLEを同期して移動させる場合に、クラス/IDを指定
    053 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
    054 *   /&gt;
    055 *
    056 * ●使用例
    057 *   &lt;og:tbodyMovable
    058 *      seqclm      = "DYORDER,SEQ"
    059 *      noMove      = "disMovable"
    060 *      noDrag      = "disDragable"
    061 *      adjustSeq   = "DYORDER"
    062 *      sync        = "fixBodyDiv"
    063 *   /&gt;
    064 *
    065 * @og.rev 5.6.3.3 (2013/04/19) 新規作成
    066 * @og.group 画面部品
    067 *
    068 * @version  5.0
    069 * @author       Kazuhiko Hasegawa
    070 * @since    JDK6.0,
    071 */
    072public class TbodyMovableTag extends CommonTagSupport {
    073        /** このプログラムのVERSION文字列を設定します。   {@value} */
    074        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
    075        private static final long serialVersionUID = 642020160129L ;
    076
    077        private transient TagBuffer tag = new TagBuffer( "span" ) ;             // 6.0.2.4 (2014/10/17) transient化
    078
    079        /**
    080         * デフォルトコンストラクター
    081         *
    082         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    083         */
    084        public TbodyMovableTag() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    085
    086        /**
    087         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    088         *
    089         * @return      後続処理の指示
    090         */
    091        @Override
    092        public int doEndTag() {
    093                debugPrint();           // 4.0.0 (2005/02/28)
    094
    095                tag.add( "class","tbodyMovable" );
    096                jspPrint( tag.makeTag() );
    097
    098                return EVAL_PAGE ;              // ページの残りを評価する。
    099        }
    100
    101        /**
    102         * タグリブオブジェクトをリリースします。
    103         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    104         *
    105         */
    106        @Override
    107        protected void release2() {
    108                super.release2();
    109                tag = new TagBuffer( "span" );
    110        }
    111
    112        /**
    113         * 【TAG】移動時に値を入れ替えするカラム名を指定します(CSV形式,先頭名称で判断)(初期値:SEQ)。
    114         *
    115         * @og.tag
    116         * 該当タグのseqclm属性値が存在する場合はシーケンスカラム名とします。
    117         * 上下移動で、同期して動きますが、このカラムの値も入れ替わります。判りにくいですが、
    118         * つまり位置は入れ替わらないという事です。
    119         * 例えば、レコードに連番を振っておき、このカラムだけ移動しないので、当初の連番のままとなり、
    120         * その値を元に、計算しなおすことで、納期調整を行ったりします。
    121         * シーケンスは指定カラムの先頭名称で判断するので注意して下さい。
    122         * 　例：SEQの指定でSEQUENCEカラムが判定されてしまう。
    123         * seqclm属性はCSV形式で複数指定可能です。
    124         * 初期値 は、"SEQ" です。
    125         *
    126         * @param   seqclm SEQカラム名 移動時に値を入れ替えたいカラム名(CSV形式)
    127         */
    128        public void setSeqclm( final String seqclm ) {
    129                tag.add( "seqclm",nval( getRequestParameter( seqclm ),null ) );
    130        }
    131
    132        /**
    133         * 【TAG】入替制限(移動できない)する tbodyのクラス名を指定します(CSV形式)。
    134         *
    135         * @og.tag
    136         * tbodyが 入替制限する場合に、tbodyにここで指定した class 属性を付与しておくことで、
    137         * 入れ替え対象から除外されます。（簡単にいうと、これを飛び越えて移動できません）
    138         * 例えば、グループ化しているレコードの範囲でしか入れ替えたくない・・・などの時に使用します。
    139         *
    140         * ここでは、CSV形式で複数のクラス名を指定可能です。
    141         *
    142         * @param   noMove 入替制限クラス (CSV形式)
    143         */
    144        public void setNoMove( final String noMove ) {
    145                tag.add( "noMove",nval( getRequestParameter( noMove ),null ) );
    146        }
    147
    148        /**
    149         * 【TAG】マウスでドラッグできない tbodyのクラス名を指定します(CSV形式)。
    150         *
    151         * @og.tag
    152         * tbodyを ドラッグしたくない場合に、tbodyにここで指定した class 属性を付与しておくことで、
    153         * ドラッグ対象から除外されます。（簡単にいうと、掴めません）
    154         * これは、対象の tbody がつかめないだけで、その前後の tbody と入れ替えはされます。
    155         * 位置はどこに行くか判りませんが、ここで指定した tbody の順番は保証されます。
    156         *
    157         * 例えば、納期確定しているレコードは入れ替えたくない・・・などの時に使用します。
    158         *
    159         * ここでは、CSV形式で複数のクラス名を指定可能です。
    160         *
    161         * @param   noDrag ドラッグ制限クラス (CSV形式)
    162         */
    163        public void setNoDrag( final String noDrag ) {
    164                tag.add( "noDrag",nval( getRequestParameter( noDrag ),null ) );
    165        }
    166
    167        /**
    168         * 【TAG】上移動(-1)、下移動(+1)で、値をセットするカラム名(１つのみ、seqclmで指定されている必要あり)。
    169         *
    170         * @og.tag
    171         * adjustSeq属性で指定したカラム（seqclmで指定されている必要あり）は、
    172         * 上に動かした時は上の値から-1された値を、下に動かした時は下の値に+1した値を
    173         * セットするような動作になります。これは１つのみ指定可能です。
    174         *
    175         * 移動時に値を入れ替えするカラム名の特殊版といえます。
    176         * ここでは、カラム名は１つのみ指定可能で、かつ、seqclmで指定されている必要があります。
    177         *
    178         * @param   adjustSeq 値設定カラム (上移動(-1)、下移動(+1)で、値をセットするカラム名)
    179         */
    180        public void setAdjustSeq( final String adjustSeq ) {
    181                tag.add( "adjustSeq",nval( getRequestParameter( adjustSeq ),null ) );
    182        }
    183
    184        /**
    185         * 【TAG】他のTABLEを同期して移動させる場合に、クラス/IDを指定します。
    186         *
    187         * @og.tag
    188         * 左右分割やガント系のテーブル部とガント部に分かれているようなテーブルで、上下移動を
    189         * 行う場合に、ドラッグしているレコードに同期させて移動させることが可能です。
    190         * ここで指定するクラスは、tableか、table直上の要素のクラスのみ指定可能です。
    191         * また、tbodyMovableが複数ある場合は先頭の属性値がセットされます。
    192         *
    193         * @param   sync テーブル同期カラム (他のTABLEを同期して移動させる場合に指定するクラス/ID)
    194         */
    195        public void setSync( final String sync ) {
    196                tag.add( "sync",nval( getRequestParameter( sync ),null ) );
    197        }
    198
    199        /**
    200         * タグの名称を、返します。
    201         * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
    202         *
    203         * @return  タグの名称
    204         * @og.rtnNotNull
    205         */
    206        @Override
    207        protected String getTagName() {
    208                return "tbodyMovable" ;
    209        }
    210
    211        /**
    212         * このオブジェクトの文字列表現を返します。
    213         * 基本的にデバッグ目的に使用します。
    214         *
    215         * @return このクラスの文字列表現
    216         * @og.rtnNotNull
    217         */
    218        @Override
    219        public String toString() {
    220                return ToString.title( this.getClass().getName() )
    221                                .println( "VERSION"             ,VERSION        )
    222                                .println( "tag"                 ,tag.makeTag()  )
    223                                .println( "Other..."    ,getAttributes().getAttribute() )
    224                                .fixForm().toString() ;
    225        }
    226}