org.opengion.hayabusa.taglib

## クラス SpaceTag

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

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

      public class SpaceTag
      extends CommonTagSupport

       テーブルレイアウトで column タグ等の存在しない空欄箇所に挿入して、
       テーブルの行列の個数を合わせるタグです。

       通常の空欄は、ラベルと値という２つの項目を別々のカラムに登録するように
       <td></td>タグが、２つ続いた形式をしていますが、一般に、
       個数は表示上の都合で任意の個数の<td>タグを使用したいケースが
       あります。
       その場合、このSpaceTag を使っておけば,大量の作成済み画面を修正しなくても
       このクラスを修正するだけで,すべての空欄のデザインがキープできます。

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

         ●形式：<og:space />
         ●body：なし

         ●Tag定義：
           <og:space
               width              【TAG】全体の大きさ(width 属性)を指定します
               colspan            【TAG】td部分の colspan を指定します
               rowspan            【TAG】ラベル、フィールド共に rowspan を指定します
               labelWidth         【TAG】ラベル部分(前半部分)の大きさ(width 属性)を指定します
               valueWidth         【TAG】値部分(後半部分)の大きさ(width 属性)を指定します
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
              通常の、ラベル部、フィールド部が空の td タグを生成します。(tdタグを２つ作成します)
              <og:space />

              td タグの大きさを指定することができます。
              <og:space
                 labelWidth = "ラベル部分(前半部分)の大きさ(width 属性)を指定します。"
                 valueWidth = "値部分(後半部分)の大きさ(width 属性)を指定します。"
              />

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

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

    - ### クラスから継承されたフィールド 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`

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

    コンストラクタ
    コンストラクタと説明
    `SpaceTag()` デフォルトコンストラクター

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setColspan(String sp)` 【TAG】フィールド部分の colspan を指定します。
    `void` | `setLabelWidth(String width)` 【TAG】ラベル部分(前半部分)の大きさ(width 属性)を指定します。
    `void` | `setRowspan(String sp)` 【TAG】ラベル、フィールド共に rowspan を指定します。
    `void` | `setValueWidth(String width)` 【TAG】値部分(後半部分)の大きさ(width 属性)を指定します。
    `void` | `setWidth(String wd)` 【TAG】全体の大きさ(width 属性)を指定します。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

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

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doEndTag, doFinally, 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, getTagName, 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`

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

    - #### SpaceTag

          public SpaceTag()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

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

    - #### release2

          protected void release2()

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

        3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
        5.1.9.0 (2010/08/01) width , colspan 属性追加
        6.2.0.0 (2015/02/27) rowspan 属性を追加。初期値見直し

    - #### setWidth

          public void setWidth(String wd)

      【TAG】全体の大きさ(width 属性)を指定します。
      パラメータ:
        `wd` - 幅
      説明:

             通常の space タグは、td ２個分のタグを出力しますが、width 属性を
             指定した場合は、colspan="2" を自動セットして、width 属性を設定します。
             (colspan属性が未設定の場合。設定されていれば、その値が使用されます。)
             width 属性を設定した場合は、labelWidth、valueWidth は無視されます。
             単位(px,% など)は、引数で付けて下さい。

      変更履歴:

        5.1.9.0 (2010/08/01) 新規追加
        6.2.0.0 (2015/02/27) 初期値設定方法変更

    - #### setColspan

          public void setColspan(String sp)

      【TAG】フィールド部分の colspan を指定します。
      パラメータ:
        `sp` - フィールド部分のcolspan
      説明:

             何も指定しない場合は、tdタグを２つ作成しますが、colspan を指定すると、
             後ろの td に、ここで指定された、colspan 属性を付与します。
             ただし、width 属性を指定した場合だけ特殊で、td を一つだけ出力し、
             そこに、colspan 属性を付けます。(併用の場合のみ)

      変更履歴:

        5.1.9.0 (2010/08/01) 新規追加
        6.2.0.0 (2015/02/27) 初期値設定方法変更

    - #### setRowspan

          public void setRowspan(String sp)

      【TAG】ラベル、フィールド共に rowspan を指定します。
      パラメータ:
        `sp` - ラベル、フィールド部分のrowspan
      説明:

             通常は、ラベルとフィールドが、別のtdで囲われます。rowspan は、
             そのどちらの TDフィールドにも、設定します。
             初期値は、rowspan を付けないです。

             <og:space rowspan="3" />

      変更履歴:

        6.2.0.0 (2015/02/27) rowspan 属性を追加

    - #### setLabelWidth

          public void setLabelWidth(String width)

      【TAG】ラベル部分(前半部分)の大きさ(width 属性)を指定します。
      パラメータ:
        `width` - 属性
      説明:

             属性は td タグのラベル部分(前半部分)に、 width 属性で設定されます。
             colspan 属性は、このlabelWidth属性と同じ TD にはセットされません。
             ただし、通常のwidth 属性を使用した場合は、このlabelWidth属性は無視されます。

      変更履歴:

        6.2.0.0 (2015/02/27) 初期値設定方法変更

    - #### setValueWidth

          public void setValueWidth(String width)

      【TAG】値部分(後半部分)の大きさ(width 属性)を指定します。
      パラメータ:
        `width` - 属性
      説明:

             属性は td タグの width 属性に設定されます。
             colspan 属性を同時に指定した場合は、このvalueWidth属性と同じ TD にセットされます。
             ただし、通常のwidth 属性を使用した場合は、このvalueWidth属性は無視されます。

      変更履歴:

        6.2.0.0 (2015/02/27) 初期値設定方法変更

    - #### toString

          public String toString()

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

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