org.opengion.hayabusa.taglib

## クラス ViewIBarTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.opengion.hayabusa.taglib.CommonTagSupport
      - - org.opengion.hayabusa.taglib.ViewIBarTag

- すべての実装されたインタフェース:
    Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally

      public class ViewIBarTag
      extends CommonTagSupport

       明細棒グラフ（横棒、縦棒）に使用します。

       iBar タグは、TDタグの繰返し部に記述することで、横棒、縦棒グラフを作成します。
       使用するには、headタグで、xxxx ="true" を設定する必要があります。
       これにより、common/option/adjustBar.js が読み込まれます。

       type は、グラフ要素の表示形式を指定します。0～9 が予約語で、0,1,2,6 が現時点で実装済みです。
          0:ラベル表示 1:横棒 2:差分枠 6:縦棒

         棒グラフ 描画方向
         横方向描画                  縦方向描画
         0ラベル表示（比率、進捗率など）5(保留  未実装)
         1横棒                          6縦棒
         2差分枠                        7(保留  未実装)
         3(保留  未実装)                8(保留  未実装)
         4(保留  未実装)                9(保留  未実装)

       value は、位置、長さを設定します。設定方法は、type 毎に異なります。
       baseVal は、グラフ要素の描画開始位置を設定します。
       type=2:差分枠 は、value ＞ baseVal の場合は、超過を、value ＜ baseValの場合は、不足を表します。

         type 別設定方法
         type設定値           説明
         0   [V1]             xx% または 0.xx　の比率を設定する。（一つのみ） , 描画位置＝baseValの各カラムの合計値 * カラムV1の値
         1   [V1],[V2],…,[Vn]棒の長さ＝[V1],[V2],…,[Vn]各カラムの合計値
         2   [V1],[V2],…,[Vn]描画位置＝baseValの各カラムの合計値 , 差分枠の長さ＝valueの各カラムの合計値 - baseValの各カラム合計値
         6   [V1],[V2],…,[Vn]棒の長さ＝[V1],[V2],…,[Vn]各カラムの合計値

       color は、棒グラフ要素（type="1"(横棒),"6"(縦棒)）の色コードを設定します。
             このコードは、予め決められた色画像を呼び出しますので、任意の色が使えるという事ではありません。

         色番号 対応表
         色番号設定値 棒色  　横棒サンプル縦棒サンプル
          0blue  青
          1black 黒
          2brown 茶
          3green 緑
          4lightblue 薄青
          5lightgreen 薄緑
          6orange オレンジ
          7pink  ピンク
          8purple 紫
          9red  赤
          10yellow 黄
          11navy  濃紺
          12teal  青緑
          13gray  灰
          14indigo 藍
          15slategray 鉄色
          16chocorlate チョコレート
          17darkgreen 深緑
          18violet すみれ
          19darkslategray深鉄色
          20lime  緑
          21aqua  水色
          22maroon ひわだいろ
          23olive オリーブ
          24silver 銀
          25fuchsia 赤紫

          BKblack2 黒
          WTwhite2 白
          BLblue2 青
          RDred2  赤
          YLyellow2 黄

       colorNo 色番号は、色コードを直接指定するのではなく、番号で指定する場合に使用します。
               棒グラフ要素（type="1"(横棒),"6"(縦棒)）の色を設定します。
               "1～25 , BK,WT,BL,RD,YL" の色番号で指定します。
               色番号は、与えた数字を内部色数で割り算した余を使用しますので、連番の場合でも
               繰返し使われます。特殊な色として、BK,WT,BL,RD,YLは、番号ではなく記号で指定できます。

       zeroBorder は、"true" で、値がゼロの時にも、最小のバーを表示する。

       graphThick は、グラフのバーの幅を指定します。

  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:iBar  ... />
         ●body：なし
         ●前提：headタグで、adjustEvent="Bar" を指定してください。

         ●Tag定義：
           <og:iBar
               type             ○【TAG】グラフ要素の表示形式を設定(0:ラベル表示 1:横棒 2:差分枠 6:縦棒)(必須)
               value            ○【TAG】グラフ要素の位置、長さを設定(typeにより設定方法が異なる)(必須)
               baseVal            【TAG】グラフ要素の描画開始位置を設定(type=0,2の場合必須)
               color              【TAG】棒グラフ要素（type="1"(横棒),"6"(縦棒)）の色コードを設定する。
               colorNo            【TAG】"1～25 , BK,WT,BL,RD,YL" の色番号を設定する。
               text               【TAG】バー上に表示するテキストを指定します。
               href               【TAG】リンク作成時の値を設定します。
               target             【TAG】リンク作成時のターゲット名を指定します。
               optionAttributes   【TAG】 {kay:val,key:val} 形式で、属性を追加します。
               zeroBorder         【TAG】最小のバーを表示するかどうか[true/false]を指定します(初期値:false)
               graphThick         【TAG】グラフのバーの幅を指定します。
               paddingLeft        【TAG】ガントバーの間の左区切りスペースを指定します(初期値=null)
               paddingRigth       【TAG】ガントバーの間の右区切りスペースを指定します(初期値=null)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
            <og:view command="{@command}" />
              <og:tbody rowspan="1" >
                <tr>
                  <og:td>
                    <og:iBar
                          type    = "X"
                          value   = "[V1],[V2],…,[Vn]"
                          baseVal = "[BV1],[BV2],…,[BVn]"
                          color   = "C1,C2,…,Cn"
                    />
                </td> </tr>
              </og:tbody>
            </og:view>

  変更履歴:

    5.6.3.2 (2013/04/12) 新規作成

  機能分類
    画面部品
  バージョン
    5.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK1.7,

- - ### フィールドのサマリー

    - ### クラスから継承されたフィールド org.opengion.hayabusa.taglib.CommonTagSupport

      `BR, BUFFER_MIDDLE, CR`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.BodyTagSupport

      `bodyContent`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.TagSupport

      `id, pageContext`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.BodyTag

      `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.IterationTag

      `EVAL_BODY_AGAIN`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.Tag

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `ViewIBarTag()`

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `protected String` | `getTagName()` タグの名称を、返します。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setBaseVal(String bval)` 【TAG】グラフ要素の描画開始位置を設定します。
    `void` | `setColor(String color)` 【TAG】棒グラフ要素（type="1"(横棒),"6"(縦棒)）の色コードを設定します。
    `void` | `setColorNo(String clrNo)` 【TAG】グラフ要素の色番号を設定します。
    `void` | `setGraphThick(String graphThick)` 【TAG】グラフのバーの幅を指定します。
    `void` | `setHref(String href)` 【TAG】リンク作成時の値を設定します。
    `void` | `setOptionAttributes(String optAtt)` 【TAG】既定の属性以外の属性を追加します。
    `void` | `setPaddingLeft(String paddingLeft)` 【TAG】バーの間の左区切りスペースをピクセルで指定します(初期値:null)。
    `void` | `setPaddingRigth(String paddingRigth)` 【TAG】バーの間の右区切りスペースをピクセルで指定します(初期値:null)。
    `void` | `setTarget(String target)` 【TAG】リンク作成時のターゲット名を指定します。
    `void` | `setText(String text)` 【TAG】バー上に表示するテキストを指定します。
    `void` | `setType(String type)` 【TAG】グラフ要素の表示形式を設定[0:ラベル表示 1:横棒 2:差分枠 6:縦棒]します。
    `void` | `setValue(String val)` 【TAG】グラフ要素の位置、長さを設定します(typeにより設定方法が異なる)。
    `void` | `setZeroBorder(String zeroBorder)` 【TAG】最小のバーを表示するかどうか[true/false]を指定します(初期値:false)。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

    - ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.CommonTagSupport

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.BodyTagSupport

      `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.TagSupport

      `findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### インタフェースから継承されたメソッド javax.servlet.jsp.tagext.Tag

      `getParent, setPageContext, setParent`

- - ### コンストラクタの詳細

    - #### ViewIBarTag

          public ViewIBarTag()

  - ### メソッドの詳細

    - #### doEndTag

          public int doEndTag()

      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
        `doEndTag` インタフェース内 `Tag`
      オーバーライド:
        `doEndTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:

        6.0.2.5 (2014/10/31) HTML5対応。javaScriptで、BODYがないと入れ子になってしまう。

    - #### release2

          protected void release2()

      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
        `release2` クラス内 `CommonTagSupport`

    - #### setType

          public void setType(String type)

      【TAG】グラフ要素の表示形式を設定[0:ラベル表示 1:横棒 2:差分枠 6:縦棒]します。
      パラメータ:
        `type` - グラフ要素の表示形式 [0:ラベル表示 1:横棒 2:差分枠 6:縦棒]
      説明:

             type は、グラフ要素の表示形式を指定します。0～9 が予約語で、0,1,2,6 が現時点で実装済みです。
             0:ラベル表示 1:横棒 2:差分枠 6:縦棒

      変更履歴:

        6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え。
        6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。

    - #### setValue

          public void setValue(String val)

      【TAG】グラフ要素の位置、長さを設定します(typeにより設定方法が異なる)。
      パラメータ:
        `val` - 位置、長さ
      説明:

             value は、グラフ要素の位置、長さを設定します。設定方法は、type 毎に異なります。
             baseVal は、グラフ要素の描画開始位置を設定します。
             type=2:差分枠 は、value ＞ baseVal の場合は、超過を、value ＜ baseValの場合は、不足を表します。

               グラフのtype別設定方法
               type設定値           説明
               0   [V1]             xx% または 0.xx　の比率を設定する。（一つのみ）, 描画位置＝baseValの各カラムの合計値 * カラムV1の値
               1   [V1],[V2],…,[Vn]棒の長さ＝[V1],[V2],…,[Vn]各カラムの合計値
               2   [V1],[V2],…,[Vn]描画位置＝baseValの各カラムの合計値 , 差分枠の長さ＝valueの各カラムの合計値 - baseValの各カラム合計値
               6   [V1],[V2],…,[Vn]棒の長さ＝[V1],[V2],…,[Vn]各カラムの合計値

    - #### setBaseVal

          public void setBaseVal(String bval)

      【TAG】グラフ要素の描画開始位置を設定します。
      パラメータ:
        `bval` - 描画開始位置
      説明:

             この値は、type=0,2の場合、必須になります。
             type=2:差分枠 は、value ＞ baseVal の場合は、超過を、value ＜ baseValの場合は、不足を表します。

               グラフのtype別設定方法
               type設定値           説明
               0   [V1]             xx% または 0.xx　の比率を設定する。（一つのみ） , 描画位置＝baseValの各カラムの合計値 * カラムV1の値
               2   [V1],[V2],…,[Vn]描画位置＝baseValの各カラムの合計値 , 差分枠の長さ＝valueの各カラムの合計値 - baseValの各カラム合計値

    - #### setColor

          public void setColor(String color)

      【TAG】棒グラフ要素（type="1"(横棒),"6"(縦棒)）の色コードを設定します。
      パラメータ:
        `color` - 色コード
      説明:

             color は、棒グラフ要素（type="1"(横棒),"6"(縦棒)）の色コードを設定します。
             このコードは、予め決められた色画像を呼び出しますので、任意の色が使えるという事ではありません。
             色指定は、横棒の場合は、image/W_色コード.png で、縦棒の場合は、image/H_色コード.png の画像を使います。
             色コード と 色番号が同時に指定された場合は、色コード が優先されます。

             type=2:差分枠 は、value ＞ baseVal の場合は、超過を、value ＜ baseValの場合は、不足を表します。

               色番号 対応表
               色番号設定値 棒色  　横棒サンプル縦棒サンプル
                0blue  青
                1black 黒
                2brown 茶
                3green 緑
                4lightblue 薄青
                5lightgreen 薄緑
                6orange オレンジ
                7pink  ピンク
                8purple 紫
                9red  赤
                10yellow 黄
                11navy  濃紺
                12teal  青緑
                13gray  灰
                14indigo 藍
                15slategray 鉄色
                16chocorlate チョコレート
                17darkgreen 深緑
                18violet すみれ
                19darkslategray深鉄色
                20lime  緑
                21aqua  水色
                22maroon ひわだいろ
                23olive オリーブ
                24silver 銀
                25fuchsia 赤紫

                BKblack2 黒
                WTwhite2 白
                BLblue2 青
                RDred2  赤
                YLyellow2 黄

    - #### setColorNo

          public void setColorNo(String clrNo)

      【TAG】グラフ要素の色番号を設定します。
      パラメータ:
        `clrNo` - 色番号 [1～25/BK/WT/BL/RD/YL]
      関連項目:
        `setColor( String )`
      説明:

             色番号は、色コードを直接指定するのではなく、番号で指定する場合に使用します。
             棒グラフ要素（type="1"(横棒),"6"(縦棒)）の色を設定します。
             "1～25 , BK,WT,BL,RD,YL" の色番号で指定します。
             色番号は、与えた数字を内部色数で割り算した余を使用しますので、連番の場合でも
             繰返し使われます。特殊な色として、BK,WT,BL,RD,YLは、番号ではなく記号で指定できます。
             色コード と 色番号が同時に指定された場合は、色コード が優先されます。

    - #### setText

          public void setText(String text)

      【TAG】バー上に表示するテキストを指定します。
      パラメータ:
        `text` - テキスト
      説明:

             バーの上に、値などの文字を重ねて表示できます。

    - #### setHref

          public void setHref(String href)

      【TAG】リンク作成時の値を設定します。
      パラメータ:
        `href` - リンク
      関連項目:
        `setTarget( String )`
      説明:

             バーの上の文字に対して、リンクを作成できます。

    - #### setTarget

          public void setTarget(String target)

      【TAG】リンク作成時のターゲット名を指定します。
      パラメータ:
        `target` - ターゲット
      関連項目:
        `setHref( String )`
      説明:

             バーの上の文字に対して、リンクを作成するときの、ターゲット名を指定できます。

    - #### setOptionAttributes

          public void setOptionAttributes(String optAtt)

      【TAG】既定の属性以外の属性を追加します。
      パラメータ:
        `optAtt` - 追加属性
      説明:

             {kay:val,key:val} 形式で、属性を追加します。

    - #### setZeroBorder

          public void setZeroBorder(String zeroBorder)

      【TAG】最小のバーを表示するかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
        `zeroBorder` - 最小のバー表示可否 [true:する/false:しない]
      説明:

             設定値が、ゼロの場合に、バーを出したい場合は、true に、
             何も出したくない場合は、false に設定します。
             初期値は、false(バーを出さない) です。

    - #### setGraphThick

          public void setGraphThick(String graphThick)

      【TAG】グラフのバーの幅を指定します。
      パラメータ:
        `graphThick` - グラフのバーの幅
      説明:

             何も指定しない場合は、通常のバーの画像ファイルが適用されます。

    - #### setPaddingLeft

          public void setPaddingLeft(String paddingLeft)

      【TAG】バーの間の左区切りスペースをピクセルで指定します(初期値:null)。
      パラメータ:
        `paddingLeft` - 左区切りスペース
      関連項目:
        `setPaddingRigth( String )`
      説明:

             バー表示で連続して同じ色で繋げる場合、くっついて表示されます。
             これを、区別できるように、左区切りスペースをピクセルで指定します。

             初期値は、null(属性を出力しない) です。

      変更履歴:

        5.6.4.3 (2013/05/24) 新規追加

    - #### setPaddingRigth

          public void setPaddingRigth(String paddingRigth)

      【TAG】バーの間の右区切りスペースをピクセルで指定します(初期値:null)。
      パラメータ:
        `paddingRigth` - 左区切りスペース
      関連項目:
        `setPaddingLeft( String )`
      説明:

             バー表示で連続して同じ色で繋げる場合、くっついて表示されます。
             これを、区別できるように、右区切りスペースをピクセルで指定します。

             初期値は、null(属性を出力しない) です。

      変更履歴:

        5.6.4.3 (2013/05/24) 新規追加

    - #### getTagName

          protected String getTagName()

      タグの名称を、返します。 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
      オーバーライド:
        `getTagName` クラス内 `CommonTagSupport`
      戻り値:
        タグの名称
      関連項目:
        `CommonTagSupport.getDocumentLink()`
      このメソッドは、nullを返しません

    - #### toString

          public String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `CommonTagSupport`
      戻り値:
        このクラスの文字列表現
      このメソッドは、nullを返しません

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.