クラス TFormatImpl

すべての実装されたインタフェース:
BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable
直系の既知のサブクラス:
TbodyTag, TfootTag, TheadTag

ヘッダ、フッター、ボディー部のフォーマットを汎用的に定義するタグです。 thead,tfoot,tbody に代わる表示フォーマットをカスタマイズするときに使用する親クラスです。 このクラス自身がタグとしては表に現れません。
変更履歴:
3.5.4.0 (2003/11/25) 新規追加, 3.5.4.2 (2003/12/15) カスタムタグクラスから削除します。(abstract化), 4.0.0.0 (2006/01/31) カスタムタグクラスに復活させます。(public化), 6.3.4.0 (2015/08/01) TFormatTag.java → TFormatImpl.java
機能分類
画面部品
形式サンプル:
●形式:(タグとしては使われません) ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
導入されたバージョン:
JDK5.0,
  • コンストラクタの詳細

    • TFormatImpl

      public TFormatImpl()
      デフォルトコンストラクター
      変更履歴:
      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
      戻り値:
      後続処理の指示( EVAL_BODY_BUFFERED )
      変更履歴:
      5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
    • doEndTag

      public int doEndTag()
      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
      doEndTag インタフェース内 Tag
      オーバーライド:
      doEndTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示(EVAL_PAGE)
      変更履歴:
      3.5.6.0 (2004/06/18) setItdBody メソッドによる itdBody の登録処理追加, 5.1.7.0 (2010/06/01) フォーマットの{@XXXX}の値に[が含まれる場合は、サイニタイズ("\\]\\"に変換)する。, 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応, 5.7.6.3 (2014/05/23) useKeyBreak 属性の追加
    • release2

      protected void release2()
      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
      release2 クラス内 CommonTagSupport
      変更履歴:
      3.5.6.0 (2004/06/18) itdBody 属性の追加, 5.7.6.3 (2014/05/23) useTrCut,useKeyBreak 属性の追加
    • setRowspan

      public void setRowspan(String span)
      【TAG】表示データを作成する場合のフォーマットの行数(rowspan)をセットします(初期値:2)。
      パラメータ:
      span - フォーマットの行数
      変更履歴:
      7.3.1.0 (2021/02/02) リクエスト変数処理を行います。
      説明:
      表示データを作成する場合のフォーマットの行数をセットします。 上位の viewFormタグより、こちらが優先されます。
    • setNoClass

      public void setNoClass(String flag)
      【TAG】カラムのクラス名(VERCHAR2,NUMBER など)を使用しないかどうか[true:未使用/false:使用]を指定します(初期値:false)。
      パラメータ:
      flag - クラス名未使用可否 [true:未使用/false:使用]
      変更履歴:
      7.3.1.0 (2021/02/02) リクエスト変数処理を行います。
      説明:
      "true" で、クラス属性を設定しません。これは、CSSファイルに書かれている属性を 使用しないことを意味します。 初期値は、"false" です。
    • getType

      protected FormatterType getType()
      このフォーマットのタイプを返します。 タイプは、"head/body/foot" の中から、指定します。
      戻り値:
      このフォーマットのタイプを返します。
      変更履歴:
      3.5.5.8 (2004/05/20) abstract します。
    • setUsableKey

      public void setUsableKey(String key)
      【TAG】フォーマットの使用可否を判断するキーとなるカラム名を指定します。
      パラメータ:
      key - 使用可否判定カラム
      説明:
      キーが、usableList に含まれる場合は、このフォームを使用できます。 キー(カラム名)が指定されない場合は、常に使用されます。 ※ 現時点では、BODYタイプのみ使用しています。 ※ この属性は、リクエスト変数処理を行いません。
    • setUsableList

      public void setUsableList(String list)
      【TAG】フォーマットの使用可否を判断する文字列リストを指定します(初期値:"1")。
      パラメータ:
      list - 使用可否判定リスト
      説明:
      キーが、この文字列リスト中に存在する場合は、このフォームを使用できます。 この文字列リストは、固定な文字列です。{@XXXX}は使用できますが、[XXXX]は 使用できません。 初期値は、"1" です。 ※ 現時点では、BODYタイプのみ使用しています。
    • setItdBody

      public void setItdBody(String itd)
      itdフォーマット文字列を設定します。 itd ボディ部の文字列を指定します。 itd ボディは、繰り返し処理を行います。これを、上位のボディ文字列の中の HYBS_ITD_MARKER 文字列 と置き換えます。 ※ この属性は、リクエスト変数処理を行いません。
      パラメータ:
      itd - itdフォーマットの文字列
      変更履歴:
      3.5.6.0 (2004/06/18) itdフォーマット文字列の取り込み
    • setKeyBreakClm

      public void setKeyBreakClm(String kclm)
      【TAG】ここで指定したカラムの値が、キーブレイクした場合、このタグを使用します(初期値:null)。
      パラメータ:
      kclm - キーブレイクカラム
      変更履歴:
      5.7.6.3 (2014/05/23) 新規追加
      説明:
      usableKey,usableList の様に、予め決められた値の時に、適用されるのではなく、 キーブレイクで 使用可否を指定する為の機能です。 この設定値は、usableKey,usableList とは、独立しているため、それぞれで 有効になれば、使用されると判断されます。 キーブレイク判定では、最初の1件目は、必ず使用されると判断されます。
    • setUseTrCut

      public void setUseTrCut(String useFlg)
      【TAG】 先頭trタグを削除するかどうか[true/false]を指定します(初期値:true)。
      パラメータ:
      useFlg - TRタグの削除 [true:削除する/false:削除しない]
      変更履歴:
      5.5.0.3 (2012/03/13) 新規追加
      説明:
      フォーマットの先頭がtrタグの場合は削除する処理がありますが、 CustomDataのような場合では削除したくありません。 falseを指定すると削除処理を行わないようになります。
    • toString

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