/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.hayabusa.taglib;

import org.opengion.hayabusa.common.HybsSystemException;
import org.opengion.hayabusa.html.TableFormatter;
import org.opengion.hayabusa.html.FormatterType;

import static org.opengion.fukurou.util.StringUtil.nval ;

/**
 * ヘッダ、フッター、ボディー部のフォーマットを汎用的に定義するタグです。
 *
 * thead,tfoot,tbody に代わる表示フォーマットをカスタマイズするときに使用する親クラスです。
 *
 * @og.rev 3.5.4.0 (2003/11/25) 新規追加
 * @og.rev 3.5.4.2 (2003/12/15) カスタムタグクラスから削除します。(abstract化)
 * @og.rev 4.0.0 (2006/01/31) カスタムタグクラスに復活させます。(public化)
 * @og.group 画面部品
 *
 * @version  4.0
 * @author	 Kazuhiko Hasegawa
 * @since    JDK5.0,
 */
public class TFormatTag extends CommonTagSupport {
	//* このプログラムのVERSION文字列を設定します。	{@value} */
	private static final String VERSION = "4.0.0 (2005/08/31)" ;

	private static final long serialVersionUID = 4000 ;	// 4.0.0 (2005/01/31)

	private String rowspan		= "2";
	private String noClass		= "false";
	private String usableKey	= null;
	private String usableList	= "1" ;
	private String itdBody		= "";			// 3.5.6.0 (2004/06/18)

	/**
	 * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
	 *
	 * @return	int
	 */
	@Override
	public int doStartTag() {
		return( EVAL_BODY_BUFFERED );	// Body を評価する。（ extends BodyTagSupport 時）
	}

	/**
	 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
	 *
	 * @og.rev 3.5.6.0 (2004/06/18) setItdBody メソッドによる itdBody の登録処理追加
	 * @og.rev 5.1.7.0 (2010/06/01) フォーマットの{@xxx}の値に[が含まれる場合は、サイニタイズ("\\]\\"に変換)する。
	 *
	 * @return	int
	 */
	@Override
	public int doEndTag() {
		debugPrint();		// 4.0.0 (2005/02/28)

		ViewFormTag viewform = (ViewFormTag)findAncestorWithClass( this,ViewFormTag.class );
		if( viewform == null ) {
			String errMsg = "<b>このタグは、ViewFormTagの内側(要素)に記述してください。</b>";
			throw new HybsSystemException( errMsg );
		}
		// 5.1.7.0 (2010/06/01) フォーマットの{@xxx}の値に[が含まれる場合は、サイニタイズ("\\]\\"に変換)する。
//		String bodyFormat = getBodyString();
		String bodyFormat = getSanitizedBodyString();

		TableFormatter format = new TableFormatter();
		format.setFormatType( getType() );
		format.setFormat( bodyFormat );
		format.setRowspan( rowspan );
		format.setNoClass( noClass );
		format.setUsableKey( usableKey );
		format.setUsableList( usableList );
		format.setItdBody( itdBody );		// 3.5.6.0 (2004/06/18)
		viewform.addFormatter( format );

		return(EVAL_PAGE);		// ページの残りを評価する。
	}

	/**
	 * タグリブオブジェクトをリリースします。
	 * キャッシュされて再利用されるので、フィールドの初期設定を行います。
	 *
	 * @og.rev 3.5.6.0 (2004/06/18) itdBody 属性の追加
	 *
	 */
	@Override
	protected void release2() {
		super.release2();
		rowspan		= "2";
		noClass		= "false";
		usableKey	= null;
		usableList	= "1" ;
		itdBody		= "";			// 3.5.6.0 (2004/06/18)
	}

	/**
	 * 【TAG】表示データを作成する場合のフォーマットの行数(rowspan)をセットします(初期値:2)。
	 *
	 * @og.tag
	 * 表示データを作成する場合のフォーマットの行数をセットします。
	 * 上位の viewFormタグより、こちらが優先されます。
	 *
	 * @param	span フォーマットの行数
	 */
	public void setRowspan( final String span ) {
		rowspan = span;
	}

	/**
	 * 【TAG】カラムのクラス名(VERCHAR2,NUMBER など)を使用するかどうか(true/false)を指定します(初期値:false)。
	 *
	 * @og.tag
	 * "true" で、クラス属性を設定しません。これは、ＣＳＳファイルに書かれている属性を
	 * 使用しないことを意味します。
	 * 初期値は、"false" です。
	 *
	 * @param	flag クラス名使用の有無（true:使用しない/false:使用する。）
	 */
	public void setNoClass( final String flag ) {
		this.noClass = flag;
	}

	/**
	 * このフォーマットのタイプを返します。
	 *
	 * タイプは、"head/body/foot" の中から、指定します。
	 *
	 * @og.rev 3.5.5.8 (2004/05/20) abstract します。
	 *
	 * @return	このフォーマットのタイプを返します。
	 */
	protected FormatterType getType() {
		String errMsg = "このメソッドは、THead/TBody/TFoot の各サブクラスで実装してください。";
		throw new UnsupportedOperationException( errMsg );
	}

//	protected String getType() {
//		String errMsg = "このメソッドは、THead/TBody/TFoot の各サブクラスで実装してください。";
//		throw new UnsupportedOperationException( errMsg );
//	}

	/**
	 * 【TAG】フォーマットの使用可否を判断するキーとなるカラム名を指定します。
	 *
	 * @og.tag
	 * キーが、usableList に含まれる場合は、このフォームを使用できます。
	 * キー（カラム名）が指定されない場合は、常に使用されます。
	 * ※ 現時点では、BODYタイプのみ使用しています。
	 *
	 * @param  key フォーマットの使用可否を判断するカラム名
	 */
	public void setUsableKey( final String key ) {
		usableKey = key;
	}

	/**
	 * 【TAG】フォーマットの使用可否を判断する文字列リストを指定します(初期値:"1")。
	 *
	 * @og.tag
	 * キーが、この文字列リスト中に存在する場合は、このフォームを使用できます。
	 * この文字列リストは、固定な文字列です。{&64;XXXX}は使用できますが、[XXXX]は
	 * 使用できません。
	 * 初期値は、"1" です。
	 * ※ 現時点では、BODYタイプのみ使用しています。
	 *
	 * @param  list フォーマットの使用可否を判断する文字列リスト
	 */
	public void setUsableList( final String list ) {
		usableList = nval( getRequestParameter(list),usableList );
	}

	/**
	 *  itdフォーマット文字列を設定します。
	 *
	 * itd ボディ部の文字列を指定します。
	 * itd ボディは、繰り返し処理を行います。これを、上位のボディ文字列の中の
	 * HYBS_ITD_MARKER 文字列 と置き換えます。
	 *
	 * @og.rev 3.5.6.0 (2004/06/18) itdフォーマット文字列の取り込み
	 *
	 * @param  itd itdフォーマットの文字列
	 */
	public void setItdBody( final String itd ) {
		if( itd != null ) {
			itdBody = itd;
		}
	}

	/**
	 * このオブジェクトの文字列表現を返します。
	 * 基本的にデバッグ目的に使用します。
	 *
	 * @return このクラスの文字列表現
	 */
	public String toString() {
		return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
	//			.println( "VERSION"		,VERSION	)
				.println( "rowspan"		,rowspan	)
				.println( "noClass"		,noClass	)
				.println( "usableKey"	,usableKey	)
				.println( "usableList"	,usableList	)
				.println( "itdBody"		,itdBody	)
				.println( "Other..."	,getAttributes().getAttribute() )
				.fixForm().toString() ;
	}
}
