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