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