/*
 * 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.fukurou.util.TagBuffer;
import org.opengion.fukurou.util.ToString;						// 6.1.1.0 (2015/01/17)

import static org.opengion.fukurou.util.StringUtil.nval ;		// 6.1.0.0 (2014/12/26)

/**
 * 明細棒グラフで、バー部のヘッダーに、進捗率を示す線を表示します。
 *
 * iHead タグは、ガントの ヘッダー部に使用されます。
 * 進捗率を示す線は、２本あり、デフォルトでは、中間点と最大値になります。
 * グラフの右に、何かを表示する場合は、幅(width)を指定する必要があります。
 *
 * @og.formSample
 * ●形式：&lt;og:iHead  ... /&gt;
 * ●body：なし
 * ●前提：headタグで、adjustEvent="Bar" を指定してください。
 *
 * ●Tag定義：
 *   &lt;og:iHead
 *       width              【TAG】グラフ部分の横幅を[px]で指定します。
 *       leftVal            【TAG】左線のヘッダ部分の文字を指定します（初期値:最大桁の半分）
 *       leftLoc            【TAG】左線のヘッダ部文字（及び線）の位置を左からの割合で指定します。
 *       leftBorderStyle    【TAG】左線のスタイルを指定します(初期値=dotted gray 1px)。
 *       adjustLeft         【TAG】左線のヘッダ部分の文字の上下位置をピクセル単位で指定します(負の数で下方向)。
 *       rightVal           【TAG】右線のヘッダ部分の文字を指定します（初期値:最大桁）
 *       rightLoc           【TAG】右線のヘッダ部文字（及び線）の位置を左からの割合で指定します。
 *       rightBorderStyle   【TAG】右線のスタイルを指定します(初期値=dotted gray 1px)。
 *       adjustRight        【TAG】右線のヘッダ部分の文字の上下位置をピクセル単位で指定します(負の数で下方向)。
 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
 *   /&gt;
 *
 * ●使用例
 *    &lt;og:view
 *        viewFormType = "HTMLCustomTable"
 *        command      = "{&#064;command}"
 *        writable     = "false"
 *        useScrollBar = "false"
 *        headerSkipCount="10"
 *    &gt;
 *      &lt;og:thead rowspan="2"&gt;
 *        &lt;tr&gt;
 *          &lt;td rowspan="2"&gt;[NOORDER]&lt;/td&gt;
 *          &lt;td rowspan="2"&gt;
 *              &lt;og:iHead width="150px"
 *                      leftVal ="now"      leftLoc ="0.8"  leftBorderStyle ="solid red 1px"    adjustLeft ="15px" 
 *                      rightVal="Target"   rightLoc="1.0"  rightBorderStyle="dashed red 2px"   adjustRight="-15px"
 *              /&gt;
 *          &lt;td rowspan="2"&gt;[SINTYOKU]&lt;/td&gt;
 *        &lt;/tr&gt;
 *      &lt;/og:thead&gt;
 *      &lt;og:tbody rowspan="2"&gt;
 *          &lt;td rowspan="2"&gt;[NOORDER]&lt;/td&gt;
 *          &lt;td rowspan="2"&gt;
 *              &lt;iBar id="B0_[I]" type="0" value="[SINTYOKU]" baseVal="[KNORDER]" /&gt;
 *              &lt;iBar id="B1_[I]" type="1" value="[KNORDER_G]" color="[COLOR]" text="[KNORDER]" /&gt;
 *              &lt;br/&gt;
 *              &lt;iBar id="B2_[I]" type="1" value="[KNJISK_G],[KNMIKM_G]" color="black,green" /&gt;
 *              &lt;iBar id="B3_[I]" type="2" value="[KNJISK_G],[KNMIKM_G]" baseVal="[KNORDER_G]" color="green" /&gt;
 *          &lt;td rowspan="2"&gt;[SINTYOKU]&lt;/td&gt;
 *      &lt;/og:tbody&gt;
 *    &lt;/og:view&gt;
 *
 * @og.rev 5.6.3.2 (2013/04/12) 新規作成
 * @og.group 画面部品
 *
 * @version  5.0
 * @author	 Kazuhiko Hasegawa
 * @since    JDK6.0,
 */
public class ViewIHeadTag extends CommonTagSupport {
	/** このプログラムのVERSION文字列を設定します。	{@value} */
	private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
	private static final long serialVersionUID = 642020160129L ;

	private transient TagBuffer tag = new TagBuffer( "iHead" ).addBody( "<!-- -->" );		// 6.1.1.0 (2015/01/17) TagBufferの連結記述

	/**
	 * デフォルトコンストラクター
	 *
	 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
	 */
	public ViewIHeadTag() {
		super();		// これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
	}

	/**
	 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
	 *
	 * @og.rev 6.0.2.5 (2014/10/31) HTML5対応。javaScriptで、BODYがないと入れ子になってしまう。
	 *
	 * @return	後続処理の指示
	 */
	@Override
	public int doEndTag() {
		debugPrint();		// 4.0.0 (2005/02/28)

		// 6.1.1.0 (2015/01/17) TagBufferの連結記述
		jspPrint( tag.makeTag() );

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

	/**
	 * タグリブオブジェクトをリリースします。
	 * キャッシュされて再利用されるので、フィールドの初期設定を行います。
	 *
	 */
	@Override
	protected void release2() {
		super.release2();
		tag = new TagBuffer( "iHead" ).addBody( "<!-- -->" );		// 6.1.1.0 (2015/01/17) TagBufferの連結記述
	}

	/**
	 * 【TAG】グラフ部分の横幅を[px]で指定します。
	 *
	 * @og.tag
	 * 指定しない場合は残りの横幅全てとなります。
	 * グラフの右側に何かを表示したい場合は指定する必要があります。
	 * 単位(px)は設定不要です。それ以外の単位は設定できません。
	 *
	 * @param   width グラフ部分の横幅
	 */
	public void setWidth( final String width ) {
		// JavaScript 側の都合で、px 単位は、削除します。
		String tmpW = nval( getRequestParameter( width ),null ) ;
		if( tmpW != null && tmpW.endsWith("px") ) {
			tmpW = tmpW.substring( 0,tmpW.length()-2 );
		}

		tag.add( "width",tmpW );
	}

	/**
	 * 【TAG】左線のヘッダ部分の文字を指定します（初期値:最大桁の半分）。
	 *
	 * @og.tag
	 * 左線のヘッダ部分に表示する文字を指定します。
	 * 左線は、中間データ、または、途中経過を意味しますので、その様な単語にします。
	 * なにも指定しない場合は、右側が最大桁以下を切り捨てした値となり、左側はその半分の値です。
	 * leftValに関しては、0.4,0.4のように複数の値をCSV形式で書く事が可能です。
	 *
	 * @param   leftVal 左線ヘッダ文字
	 */
	public void setLeftVal( final String leftVal ) {
		tag.add( "leftVal",nval( getRequestParameter( leftVal ),null ) );
	}

	/**
	 * 【TAG】左線のヘッダ部文字（及び線）の位置を左からの割合(小数)で指定します。
	 *
	 * @og.tag
	 * グラフ幅全体を1として、左からの割合で指定します。(左が0.3で右が0.9など）
	 * leftLocに関しては、0.4,0.4のように複数の値をCSV形式で書く事が可能です。
	 *
	 * @param   leftLoc 左線ヘッダ位置 (割合を小数指定)
	 */
	public void setLeftLoc( final String leftLoc ) {
		tag.add( "leftLoc",nval( getRequestParameter( leftLoc ),null ) );
	}

	/**
	 * 【TAG】左線のスタイルを指定します(初期値=dotted gray 1px)。
	 *
	 * @og.tag
	 * グラフに引かれる左線のスタイルを指定します。
	 * 初期値は、dotted gray 1px です。
	 *
	 * @param   leftBorderStyle 左線スタイル
	 */
	public void setLeftBorderStyle( final String leftBorderStyle ) {
		tag.add( "leftBorderStyle",nval( getRequestParameter( leftBorderStyle ),null ) );
	}

	/**
	 * 【TAG】左線のヘッダ部分の文字の上下位置をピクセル単位で指定します(負の数で下方向)。
	 *
	 * @og.tag
	 * 左右の文字が重なる可能性がある場合に利用します。
	 * 10と指定すると、10マイナスされて文字が上方向にずれます。
	 * 負の数を指定すると、文字が下方向にずれます。
	 * 単位(px)は設定不要です。それ以外の単位は設定できません。
	 *
	 * @param   adjustLeft 文字の上下位置指定
	 */
	public void setAdjustLeft( final String adjustLeft ) {
		// JavaScript 側の都合で、px 単位は、削除します。
		String tmpA = nval( getRequestParameter( adjustLeft ),null ) ;
		if( tmpA != null && tmpA.endsWith("px") ) {
			tmpA = tmpA.substring( 0,tmpA.length()-2 );
		}

		tag.add( "adjustLeft",tmpA );
	}

	/**
	 * 【TAG】右線のヘッダ部分の文字を指定します（初期値:最大桁）。
	 *
	 * @og.tag
	 * 右線のヘッダ部分に表示する文字を指定します。
	 * 右線は、最終データ、または、最大データを意味しますので、その様な単語にします。
	 * なにも指定しない場合は、右側が最大桁以下を切り捨てした値となり、左側はその半分の値です。
	 *
	 * @param   rightVal 右線ヘッダ文字
	 */
	public void setRightVal( final String rightVal ) {
		tag.add( "rightVal",nval( getRequestParameter( rightVal ),null ) );
	}

	/**
	 * 【TAG】右線のヘッダ部文字（及び線）の位置を左からの割合(小数)で指定します。
	 *
	 * @og.tag
	 * グラフ幅全体を1として、左からの割合で指定します。(左が0.3で右が0.9など）
	 *
	 * @param   rightLoc 右線ヘッダ位置 (割合を小数指定)
	 */
	public void setRightLoc( final String rightLoc ) {
		tag.add( "rightLoc",nval( getRequestParameter( rightLoc ),null ) );
	}

	/**
	 * 【TAG】右線のスタイルを指定します(初期値=dotted gray 1px)。
	 *
	 * @og.tag
	 * グラフに引かれる右線のスタイルを指定します。
	 * 初期値は、dotted gray 1px です。
	 *
	 * @param   rightBorderStyle 右線スタイル
	 */
	public void setRightBorderStyle( final String rightBorderStyle ) {
		tag.add( "rightBorderStyle",nval( getRequestParameter( rightBorderStyle ),null ) );
	}

	/**
	 * 【TAG】右線のヘッダ部分の文字の上下位置をピクセル単位で指定します(負の数で下方向)。
	 *
	 * @og.tag
	 * 左右の文字が重なる可能性がある場合に利用します。
	 * 10と指定すると、10マイナスされて文字が上方向にずれます。
	 * 負の数を指定すると、文字が下方向にずれます。
	 * 単位(px)は設定不要です。それ以外の単位は設定できません。
	 *
	 * @param   adjustRight 文字の上下位置指定
	 */
	public void setAdjustRight( final String adjustRight ) {
		// JavaScript 側の都合で、px 単位は、削除します。
		String tmpA = nval( getRequestParameter( adjustRight ),null ) ;
		if( tmpA != null && tmpA.endsWith("px") ) {
			tmpA = tmpA.substring( 0,tmpA.length()-2 );
		}

		tag.add( "adjustRight",tmpA );
	}

	/**
	 * タグの名称を、返します。
	 * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
	 *
	 * @return  タグの名称
	 * @og.rtnNotNull
	 */
	@Override
	protected String getTagName() {
		return "iHead" ;
	}

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