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.XHTMLTag;
019
020import org.opengion.fukurou.util.StringUtil;
021
022/**
023 * 【入力】複数行の入力が可能なテキスト入力フィールドを作成するHTML拡張タグです。
024 *
025 * name 属性に ラベルリソース のキーを与えることで、 ロケールにあわせたリソースを使用して、
026 * 画面に表示します。
027 * ロケールは、ユーザー情報の lang 属性を初期値で使用し、 セットされていない場合は、
028 * リクエスト情報のロケールから取得します。
029 * ラベル部分と入力フィールド部分がテーブルタグの <td> により左右に分割されます。
030 * HTML 表示時は、前後に<tr>タグで囲って、 整形できます。
031 *
032 * @og.formSample
033 * ●形式:<og:queryOption >
034 *             SELECT文 
035 *         </og:queryOption >
036 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
037 *
038 * ●Tag定義:
039 *   <og:textarea
040 *       name             ○【HTML】名前を指定します(必須)。
041 *       lbl                【TAG】ラベルリソースのラベルIDを指定します
042 *       rows               【HTML】高さ(行数)を指定します
043 *       cols               【HTML】横幅(カラム数)を指定します
044 *       must               【TAG】必須入力を表す色に変えるかどうか[true/false]を指定します(初期値:false)
045 *       mustAny            【TAG】選択必須入力(どれかひとつ必須)を表す色[true/mustAny/その他]を指定します(初期値:無指定)
046 *       useMustHidden      【TAG】必須の自動チェック用Hiddenを出力するかどうか[true/false]を指定します(初期値:true)
047 *       aimai              【TAG】曖昧検索可能フィールドとして、曖昧検索方法を指定します(初期値:null)
048 *       id                 【HTML】要素に対して固有の名前(id)をつける場合に設定します
049 *       lang               【HTML】要素の内容と他の属性値の言語(lang,xml:lang)を指定します
050 *       dir                【HTML】文字表記の方向(dir)を指定します
051 *       title              【HTML】要素に対する補足的情報(title)を設定します
052 *       style              【HTML】この要素に対して適用させるスタイルシート(style)を設定します
053 *       readonly           【TAG】その部品に対して変更が出来ないように(readonly)指定します(サーバーに送信される)
054 *       disabled           【TAG】その部品に対して、選択や変更が出来ないように(disabled)指定します(サーバーに送信されない)
055 *       tabindex           【HTML】タブの移動順(tabindex)を指定します(0 ~ 32767)
056 *       accesskey          【HTML】アクセスキー(alt+キーで直接指定)を割り当てます
057 *       clazz              【HTML】要素に対して class 属性を設定します
058 *       language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
059 *       onClick            【HTML】JavaScriptのイベント onClick を設定します(例:onClick="renew('query.jsp','QUERY');")
060 *       onBlur             【HTML】JavaScriptのイベント onBlur を設定します(例:onBlur="this.value=value.toUpperCase();")
061 *       onFocus            【HTML】JavaScriptのイベント onFocus を設定します
062 *       ondblClick         【HTML】JavaScriptのイベント ondblClick を設定します
063 *       onMouseDown        【HTML】JavaScriptのイベント onMouseDown を設定します
064 *       onMouseUp          【HTML】JavaScriptのイベント onMouseUp を設定します
065 *       onMouseMove        【HTML】JavaScriptのイベント onMouseMove を設定します
066 *       onMouseOut         【HTML】JavaScriptのイベント onMouseOut を設定します
067 *       onMouseOver        【HTML】JavaScriptのイベント onMouseOver を設定します
068 *       onSelect           【HTML】JavaScriptのイベント onSelect を設定します
069 *       onKeydown          【HTML】JavaScriptのイベント onKeydown を設定します
070 *       onKeypress         【HTML】JavaScriptのイベント onKeypress を設定します
071 *       onKeyup            【HTML】JavaScriptのイベント onKeyup を設定します
072 *       autofocus          【HTML5】指定した入力欄にカーソルが当たって自動的にフォーカスされます。
073 *       placeholder        【HTML5】入力欄に初期表示する内容を指定します。
074 *       required           【HTML5】入力必須を指定します
075 *       roles              【TAG】ロールをセットします
076 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
077 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
078 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない)
079 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない)
080 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
081 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
082 *   >   ... Body ...
083 *   </og:textarea>
084 *
085 * ●使用例
086 *     <og:textarea name="BUN" />
087 *
088 *     <og:textarea name="BUN">            初期値に値をセットしたいとき
089 *         test
090 *     </og:textarea name="BUN">
091 *
092 * @og.group 画面部品
093 *
094 * @version  4.0
095 * @author   Kazuhiko Hasegawa
096 * @since    JDK5.0,
097 */
098public class TextareaTag extends HTMLTagSupport {
099        /** このプログラムのVERSION文字列を設定します。   {@value} */
100        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
101        private static final long serialVersionUID = 642020160129L ;
102
103        /**
104         * デフォルトコンストラクター
105         *
106         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
107         */
108        public TextareaTag() { super(); }               // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
109
110        /**
111         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
112         *
113         * @og.rev 6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応
114         *
115         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
116         */
117        @Override
118        public int doStartTag() {
119                // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method
120                // 反転注意
121                return useTag()
122                                ? EVAL_BODY_BUFFERED            // Body を評価する。( extends BodyTagSupport 時)
123                                : SKIP_BODY ;
124
125        }
126
127        /**
128         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
129         *
130         * @og.rev 3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。
131         * @og.rev 3.1.1.0 (2003/03/28) body 属性に、 {@XXXX} パース機能を付加する。
132         *
133         * @return      後続処理の指示(SKIP_BODY)
134         */
135        @Override
136        public int doAfterBody() {
137                final String str = getBodyString();
138
139                if( str != null && str.length() > 0 ) {
140                        final String label = StringUtil.htmlFilter( str );
141                        if( label != null && label.length() > 0 ) {
142                                set( "body",label );
143                        }
144                }
145
146                return SKIP_BODY ;
147        }
148
149        /**
150         * 検索条件の入力用のテキストフィールドを作成します。
151         *
152         * テーブルタグによりフィールドは分割されます。
153         * 使用時は、テーブルタグを前後に使用して下さい。
154         *
155         * @og.rev 4.3.7.1 (2009/06/08) id=labelのclass化
156         * @og.rev 5.2.1.0 (2010/10/01) must , mustAny 属性を自動化します。
157         * @og.rev 6.2.0.0 (2015/02/27) aimai 属性を追加。
158         *
159         * @return  入力用のテキストフィールドタグ
160         * @og.rtnNotNull
161         */
162        @Override
163        protected String makeTag() {
164                final String name = get( "name" );                                                      // 6.2.0.0 (2015/02/27) 後で使うので変数化
165
166                if( getMsglbl()  == null ) { setLbl( name ); }
167
168                final StringBuilder rtn = new StringBuilder( BUFFER_MIDDLE )
169                // 4.3.7.1 (2009/06/08) id=labelのclass化
170                // rtn.append( "<td id=\"label\">" );
171                        .append( "<td class=\"label\">" )
172                        .append( getLongLabel() )               // 4.0.0 (2005/01/31)
173                        .append( "</td>" )
174                        .append( "<td>" )
175                        .append( XHTMLTag.textarea( getAttributes() ) )
176                        .append( "</td>" )
177                        .append( makeAimaiPicker( name ) )              // 6.2.0.0 (2015/02/27) aimai 属性を追加
178                        .append( makeMustHidden( name ) );              // 6.2.0.0 (2015/02/27) , 5.6.2.2 (2013/03/15)
179
180                return rtn.toString() ;
181        }
182
183        /**
184         * 【HTML】名前を指定します。
185         *
186         * @og.tag 名前を指定します。
187         *
188         * @param   name 名前
189         */
190        public void setName( final String name ) {
191                set( "name",getRequestParameter( name ) );
192        }
193
194        /**
195         * 【HTML】高さ(行数)を指定します。
196         *
197         * @og.tag 高さ(行数)を指定します。
198         *
199         * @param   rows 高さ(行数)
200         */
201        public void setRows( final String rows ) {
202                set( "rows",getRequestParameter( rows ) );
203        }
204
205        /**
206         * 【HTML】横幅(カラム数)を指定します。
207         *
208         * @og.tag 横幅を指定します。
209         *
210         * @param   cols 横幅(カラム数)
211         */
212        public void setCols( final String cols ) {
213                set( "cols",getRequestParameter( cols ) );
214        }
215}