org.opengion.plugin.view

## クラス ViewForm_HTMLTable

- java.lang.Object
- - org.opengion.hayabusa.html.AbstractViewForm
  - - org.opengion.plugin.view.ViewForm_HTMLTable

- すべての実装されたインタフェース:
    ViewForm
  直系の既知のサブクラス:
    ViewForm_CustomData, ViewForm_HTMLCrossTable, ViewForm_HTMLCustomTable, ViewForm_HTMLCustomTreeBOM, ViewForm_HTMLDynamic, ViewForm_HTMLFormatTable, ViewForm_HTMLGanttTable, ViewForm_HTMLRotationTable, ViewForm_HTMLSeqClmTable, ViewForm_HTMLSimpleList, ViewForm_HTMLStackedGanttTable, ViewForm_HTMLTimeTable, ViewForm_HTMLTreeBOM, ViewForm_ImageTimeBar

      public class ViewForm_HTMLTable
      extends AbstractViewForm

       検索結果を自動的に表形式に変換する、テーブル作成クラスです。

       AbstractViewForm により、setter/getterメソッドのデフォルト実装を提供しています。
       各HTMLのタグに必要な setter/getterメソッドのみ，追加定義しています。

       AbstractViewForm を継承している為,ロケールに応じたラベルを出力させる事が出来ます。

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

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

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected java.lang.String` | `headerLine` ヘッダー部分のキャッシュ変数
    `protected static java.lang.String` | `NUMBER_DISPLAY`
    `protected boolean` | `useIE7Header`

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

      `BUFFER_LARGE, BUFFER_MIDDLE, CR`

    - ### インタフェースから継承されたフィールド org.opengion.hayabusa.html.ViewForm

      `DEFAULT_CLM_WRITABLE, DEFAULT_SKIP`

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `canUseFormat()` フォーマットメソッドを使用できるかどうかを問い合わせます。
    `void` | `clear()` 内容をクリア(初期化)します。
    `java.lang.String` | `create(int startNo, int pageSize)` DBTableModel から HTML文字列を作成して返します。
    `protected java.lang.String` | `getColumnLabel(int column)` カラムのラベル名(短)を返します。
    `protected java.lang.String` | `getHeader()` DBTableModel から テーブルのヘッダータグ文字列を作成して返します。
    `protected java.lang.String` | `getHeadLine()` ヘッダー繰り返し部を、getTableHead()メソッドから分離。
    `protected java.lang.String` | `getHeadLine(java.lang.String thTag)` ヘッダー繰り返し部を、getTableHead()メソッドから分離。
    `protected java.lang.String` | `getTableFoot(TableFormatter footerFormat)` DBTableModel から テーブルのタグ文字列を作成して返します。
    `protected java.lang.String` | `getTableHead()` DBTableModel から テーブルのタグ文字列を作成して返します。
    `protected java.lang.String` | `getTableTag()` DBTableModel から テーブルのタグ文字列を作成して返します。
    `protected java.lang.String` | `makeCheckbox(java.lang.String ckboxTD, int row, int blc)` 選択用のチェックボックスと行番号と変更タイプ(A,C,D)を表示します。
    `protected java.lang.String` | `makeCheckbox(java.lang.String ckboxTD, int row, int blc, boolean useS9)` 選択用のチェックボックスと行番号と変更タイプ(A,C,D)を表示します。
    `protected java.lang.StringBuilder` | `makeNthChild(java.lang.StringBuilder buf, int ad, java.lang.String dbType)` HTML5 で colgroup が効かない暫定対応の、処理をまとめるメソッド #viewTable td:nth-child(n) { text-align:right; } CSSを出力するメソッドをまとめました。
    `void` | `setPopupReturnKeys(java.lang.String rtnKeys)` ogPopup で検索結果の値を返すキーを、CSV形式で指定します。

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

      `create, create, getAllCheckControl, getBackLinkCount, getBgColorCycleClass, getBgColorCycleClass, getBoolParam, getClassName, getColumnCount, getColumnDbType, getColumnDisplayCount, getColumnName, getColumnNo, getColumnSize, getCountForm, getDBColumn, getDBTableModel, getEditorValue, getGamenId, getHeaderSkipCount, getHiddenRowValue, getId, getIntParam, getLastNo, getName, getNumberData, getNumberHeader, getOptionTypeAttributes, getPageSize, getParam, getParam, getRendererValue, getRendererValue, getResourceManager, getRowCount, getScrollBarEndDiv, getScrollBarStartDiv, getSelectedType, getSortedColumnLabel, getStartNo, getTableClass, getTypeCaseValue, getValue, getValueLabel, getViewArrayList, getViewClass, getViewClms, getViewClms, getViewFormType, init, isChecked, isClmBulkSet, isColumnDisplay, isColumnWritable, isEditable, isFirstChecked, isMarked, isMustAnyColumn, isMustColumn, isNoTransition, isNumberDisplay, isSkip, isSkipNoEdit, isUseCheckControl, isWritable, makeTableSorterQuery, markerSet, setBackLinkCount, setBgColorClsClm, setBgColorCycle, setColumnBulkSet, setColumnDisplay, setColumnDisplay, setColumnGroup, setColumnWritable, setColumnWritable, setDBColumn, setEditMarker, setFormatNoDisplay, setFormatterList, setGamenId, setGroupClass, setGroupDir, setHeaderSkipCount, setHeight, setId, setName, setNoDisplay, setNoGroup, setNoMessage, setNoTransition, setNoWritable, setNumberType, setOptionTypeAttributes, setPageSize, setParam, setResourceManager, setScrollRowNo, setSelectedType, setSkip, setSkipNoEdit, setStartNo, setTableClass, setTableSorterKeys, setUseCheckControl, setUseScrollBar, setUseTableSorter, setViewArrayList, setViewClass, setViewLink, setViewMarker, setWidth, setWritableControl`

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

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

- - ### フィールドの詳細

    - #### NUMBER_DISPLAY

          protected static final java.lang.String NUMBER_DISPLAY

    - #### useIE7Header

          protected final boolean useIE7Header

    - #### headerLine

          protected java.lang.String headerLine

      ヘッダー部分のキャッシュ変数

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

    - #### ViewForm_HTMLTable

          public ViewForm_HTMLTable()

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

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

  - ### メソッドの詳細

    - #### clear

          public void clear()

      内容をクリア(初期化)します。
      定義:
        `clear` インタフェース内 `ViewForm`
      オーバーライド:
        `clear` クラス内 `AbstractViewForm`
      変更履歴:

        3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。
        3.5.2.0 (2003/10/20) ヘッダー繰り返し属性( headerSkipCount )を採用
        3.5.5.5 (2004/04/23) cacheTag,isCache 属性追加(チェックボックス作成用)
        3.5.6.2 (2004/07/05) bgColorCycle 変数の削除。
        3.8.6.1 (2006/10/20) popup の値を返す為のカラム番号配列(popupClmNo)追加
        5.1.6.0 (2010/05/01) caption 属性が使われていないため、削除する。

    - #### create

          public java.lang.String create(int startNo,
                                         int pageSize)

      DBTableModel から HTML文字列を作成して返します。 startNo(表示開始位置)から、pageSize(表示件数)までのView文字列を作成します。 表示残りデータが pageSize 以下の場合は,残りのデータをすべて出力します。
      パラメータ:
        `startNo` - 表示開始位置
        `pageSize` - 表示件数
      戻り値:
        DBTableModelから作成された HTML文字列
      変更履歴:

        3.5.2.0 (2003/10/20) ヘッダー繰り返し属性( headerSkipCount )を採用
        3.5.3.1 (2003/10/31) skip属性を採用。headerLine のキャッシュクリア
        3.5.5.0 (2004/03/12) No 欄そのものの作成判断ロジックを追加
        3.5.6.4 (2004/07/16) ヘッダーとボディー部をJavaScriptで分離
        3.7.0.3 (2005/03/01) getBgColorCycleClass に、選択行マーカーを採用
        4.3.1.0 (2008/09/08) 編集行のみを表示する属性(isSkipNoEdit)追加
        4.3.3.0 (2008/10/01) noTransition属性対応
        6.8.1.1 (2017/07/22) ckboxTD変数は、<td> から <td に変更します(タグの最後が記述されていない状態でもらう)。

      このメソッドは、nullを返しません

    - #### makeCheckbox

          protected java.lang.String makeCheckbox(java.lang.String ckboxTD,
                                                  int row,
                                                  int blc)

      選択用のチェックボックスと行番号と変更タイプ(A,C,D)を表示します。 行番号の個別に、class="S9" を入れる処理を行うための新しいメソッドを作成しました。 互換性を保つためのメソッドを追加します。
      パラメータ:
        `ckboxTD` - チェックボックスのタグ(マルチカラム時のrowspan対応)
        `row` - 行番号
        `blc` - バックラインカウント(先頭へ戻るリンク間隔)
      戻り値:
        tdタグで囲まれたチェックボックスのHTML文字列
      変更履歴:

        6.8.1.1 (2017/07/22) 互換性を保つためのメソッド

      このメソッドは、nullを返しません

    - #### makeCheckbox

          protected java.lang.String makeCheckbox(java.lang.String ckboxTD,
                                                  int row,
                                                  int blc,
                                                  boolean useS9)

      選択用のチェックボックスと行番号と変更タイプ(A,C,D)を表示します。 ﾌｫｰﾏｯﾄ系のViewに、makeNthChild を適用すると、思わぬ所で、副作用が発生します。 その場合は、データ量は増えますが、個々の行番号欄に、class="S9" を入れていくのが もっとも確実な方法です。その切替を、useS9 変数で行います。
      パラメータ:
        `ckboxTD` - チェックボックスのタグ(マルチカラム時のrowspan対応)
        `row` - 行番号
        `blc` - バックラインカウント(先頭へ戻るリンク間隔)
        `useS9` - trueにすると、行番号のtdに、class="S9" を個別に入れます。
      戻り値:
        tdタグで囲まれたチェックボックスのHTML文字列
      変更履歴:

        3.5.1.0 (2003/10/03) Noカラムに、numberType 属性を追加
        3.5.4.0 (2003/11/25) Formatter をローカル変数に変更
        3.5.4.1 (2003/12/01) table オブジェクトのセット廃止
        3.5.5.5 (2004/04/23) Attributes オブジェクトのセット廃止
        3.6.0.0 (2004/09/17) ガントチャートの移動時にチェックするためのIDを追加
        3.6.0.0 (2004/09/17) チェック済みの行の先頭に、フォーカスを当てる処理を追加
        3.8.6.1 (2006/10/20) popup 用の値を設定する機能を追加
        6.4.3.4 (2016/03/11) Formatterに新しいコンストラクターを追加する。
        6.8.1.1 (2017/07/22) ckboxTD変数は、<td> から <td に変更します(タグの最後が記述されていない状態でもらう)。
        6.8.1.1 (2017/07/22) 行番号のtdに、個別に class="S9" を追加するための useS9 変数を追加。

      このメソッドは、nullを返しません

    - #### getHeader

          protected java.lang.String getHeader()

      DBTableModel から テーブルのヘッダータグ文字列を作成して返します。
      戻り値:
        テーブルのヘッダータグ文字列
      変更履歴:

        3.5.2.0 (2003/10/20) ヘッダーそのもののキャッシュはしない。

      このメソッドは、nullを返しません

    - #### getTableFoot

          protected java.lang.String getTableFoot(TableFormatter footerFormat)

      DBTableModel から テーブルのタグ文字列を作成して返します。
      パラメータ:
        `footerFormat` - TableFormatterオブジェクト
      戻り値:
        テーブルのタグ文字列
      変更履歴:

        3.5.0.0 (2003/09/17) <tr>属性は、元のフォーマットのまま使用します。
        3.5.1.0 (2003/10/03) Noカラムに、numberType 属性を追加
        3.5.4.0 (2003/11/25) TableFormatter クラスを使用するように変更。
        3.5.4.7 (2004/02/06) ヘッダーにソート機能用のリンクを追加します。
        3.5.5.0 (2004/03/12) systemFormat(例：[KEY.カラム名]形式等)の対応
        3.5.5.0 (2004/03/12) No 欄そのものの作成判断ロジックを追加
        6.2.0.0 (2015/02/27) フォーマット系の noDisplay 対応
        6.3.9.0 (2015/11/06) 引数にTableFormatterを渡して、処理の共有化を図る。

      このメソッドは、nullを返しません

    - #### getTableTag

          protected java.lang.String getTableTag()

      DBTableModel から テーブルのタグ文字列を作成して返します。
      戻り値:
        テーブルのタグ文字列
      変更履歴:

        3.5.6.4 (2004/07/16) ヘッダーとボディー部をJavaScriptで分離
        3.6.0.0 (2004/09/17) ヘッダー固定スクロールの簡素化(スクロールバーを右に出す)
        3.6.0.5 (2004/10/18) 印刷時の罫線出力関連機能の追加。id 属性を出力します。
        4.0.0.0 (2005/08/31) テーブル表示の CSSファイル利用の有無
        5.1.6.0 (2010/05/01) caption 属性が使われていないため、削除する。
        5.2.3.0 (2010/12/01) テーブル罫線対応
        5.3.4.0 (2011/04/01) テーブル罫線の初期値チェック変更

      このメソッドは、nullを返しません

    - #### makeNthChild

          protected java.lang.StringBuilder makeNthChild(java.lang.StringBuilder buf,
                                                         int ad,
                                                         java.lang.String dbType)

      HTML5 で colgroup が効かない暫定対応の、処理をまとめるメソッド #viewTable td:nth-child(n) { text-align:right; } CSSを出力するメソッドをまとめました。 呼び出し元の、getTableHead() のコードをすっきりさせるためのメソッドです。
      パラメータ:
        `buf` - タグ文字列をappendしていくStringBuilder
        `ad` - TDタグの番号 nth-child(n)設置する場合の n の値
        `dbType` - text-alignを決めるためのDBTYPE (R,S9,X9→text-align:right; , BIT→text-align:center; , 他素通り)
      戻り値:
        テーブルのタグ文字列(入力と同じStringBuilder)
      関連項目:
        `getTableHead()`
      変更履歴:

        5.7.5.0 (2014/04/04) 新規追加
        6.1.2.0 (2015/01/24) 他のクラスでも使用する為、protected化します。
        5.9.5.3 (2016/02/26) viewTableにtableIdのクラスを追加する対応
        6.4.4.1 (2016/03/18) StringBuilderのappend部分の見直し。
        6.4.4.2 (2016/04/01) className に BIT が指定された場合の対応。
        6.4.6.1 (2016/06/03) tableId 廃止(利用目的を明確にするため、パラメータ名をviewClassに変更)
        6.4.6.1 (2016/06/03) DbType とClassName が複雑化しているため、とりあえずの暫定対策。

      このメソッドは、nullを返しません

    - #### getTableHead

          protected java.lang.String getTableHead()

      DBTableModel から テーブルのタグ文字列を作成して返します。
      戻り値:
        テーブルのタグ文字列
      変更履歴:

        3.5.1.0 (2003/10/03) Noカラムに、numberType 属性を追加
        3.5.2.0 (2003/10/20) ヘッダー繰り返し部をgetHeadLine()へ移動
        3.5.3.1 (2003/10/31) VERCHAR2 を VARCHAR2 に修正。
        3.5.5.0 (2004/03/12) No 欄そのものの作成判断ロジックを追加
        3.5.6.5 (2004/08/09) thead に、id="header" を追加
        4.0.0.0 (2005/01/31) DBColumn の 属性(CLS_NM)から、DBTYPEに変更
        4.0.0.0 (2005/01/31) 新規作成(getColumnClassName ⇒ getColumnDbType)
        5.7.5.0 (2014/04/04) HTML5 で colgroup が効かない暫定対応(真の原因不明)
        5.9.1.2 (2015/10/23) 自己終了警告対応
        6.4.4.1 (2016/03/18) NUMBER_DISPLAYを、static final 定数化します。
        6.4.5.0 (2016/04/08) メソッド変更( getColumnDbType(int) → getClassName(int) )
        6.4.6.1 (2016/06/03) DbType とClassName が複雑化しているため、とりあえずの暫定対策。
        6.8.1.0 (2017/07/14) HTML5対応ヘッダー出力設定時に、ブラウザを互換設定したときの対応。

      このメソッドは、nullを返しません

    - #### getHeadLine

          protected java.lang.String getHeadLine()

      ヘッダー繰り返し部を、getTableHead()メソッドから分離。
      戻り値:
        テーブルのタグ文字列
      変更履歴:

        3.5.4.5 (2004/01/23) 実装をgetHeadLine( String thTag )に移動
        6.1.2.0 (2015/01/24) キャッシュを返すのを、#getHeadLine() に移動。

      このメソッドは、nullを返しません

    - #### getHeadLine

          protected java.lang.String getHeadLine(java.lang.String thTag)

      ヘッダー繰り返し部を、getTableHead()メソッドから分離。
      パラメータ:
        `thTag` - タグの文字列
      戻り値:
        テーブルのタグ文字列
      変更履歴:

        3.5.2.0 (2003/10/20) 新規作成
        3.5.4.3 (2004/01/05) useCheckControl 属性の機能を追加
        3.5.4.5 (2004/01/23) thタグの属性設定出来る様に新規追加。
        3.5.4.6 (2004/01/30) numberType="none" 時の処理を追加(Noラベルを出さない)
        3.5.4.7 (2004/02/06) ヘッダーにソート機能用のリンクを追加します。
        3.7.0.1 (2005/01/31) 全件チェックコントロール処理変更
        6.1.2.0 (2015/01/24) キャッシュを返すのを、#getHeadLine() に移動。

      このメソッドは、nullを返しません

    - #### canUseFormat

          public boolean canUseFormat()

      フォーマットメソッドを使用できるかどうかを問い合わせます。
      戻り値:
        使用可能(true)/ 使用不可能(false)

    - #### setPopupReturnKeys

          public void setPopupReturnKeys(java.lang.String rtnKeys)

      ogPopup で検索結果の値を返すキーを、CSV形式で指定します。 popup の検索結果を返す画面で、結果のラジオボタンにイベントセットします。 この場合、オープンもとのwindow に値を返しますが、そのキーをCSV形式で 指定します。なお、設定は、init 以降(つまり、DBTableModelは設定済み)の 状態で呼び出してください。(エラーにしません) なお、このメソッドは、一覧表示(HTMLTable)関係のビューのみでサポートして いますが、チェックメソッドの関係で、それ以外のビューに適用しても素通り するようにします。(エラーにしません)
      定義:
        `setPopupReturnKeys` インタフェース内 `ViewForm`
      オーバーライド:
        `setPopupReturnKeys` クラス内 `AbstractViewForm`
      パラメータ:
        `rtnKeys` - ogPopupで値を返すカラム文字列(CSV形式)
      変更履歴:

        3.8.6.1 (2006/10/20) 新規追加

    - #### getColumnLabel

          protected java.lang.String getColumnLabel(int column)

      カラムのラベル名(短)を返します。 カラムの項目名に対して,見える形の文字列を返します。 一般には,リソースバンドルと組合せて,各国ロケール毎にラベルを 切替えます。
      オーバーライド:
        `getColumnLabel` クラス内 `AbstractViewForm`
      パラメータ:
        `column` - カラム番号
      戻り値:
        カラムのラベル名(短)
      変更履歴:

        4.0.0.0 (2005/01/31) 新規追加( shortLabel を返します。)

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