パッケージ com.osboffice.osbxl

クラス ListObjectsWrapper

java.lang.Object
com.osboffice.osbxl.ListObjectsWrapper
public class ListObjectsWrapper extends Object
ワークシートのテーブル一覧を表すクラスです。テーブルクラスの追加、削除、取得、テーブル範囲変更が可能です。

  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    TableWrapper
    addList(String tableName, String A1C1, boolean useFirstRowAsHeader, boolean insertTotals)
    ワークシートにテーブルを追加します。
    TableWrapper
    addListFromRange(String tableName, String topA1, String A1C1, boolean useFirstRowAsHeader, boolean insertTotals)
    ワークシートのテーブル作成をデータコピーと共に行います。
    TableWrapper
    getList(String tableName)
    テーブルクラスを取得します。
    void
    removeList(String tableName)
    ワークシートからのテーブルの削除を行います(データの削除も行います)。
    void
    removeList(String tableName, boolean deleteData)
    ワークシートからのテーブルの削除を行います。

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

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • メソッドの詳細

    • getList

      public TableWrapper getList(String tableName)
      テーブルクラスを取得します。
      パラメータ:
      tableName - テーブル名
      戻り値:
      テーブルクラス

    • addList

      public TableWrapper addList(String tableName, String A1C1, boolean useFirstRowAsHeader, boolean insertTotals)
      ワークシートにテーブルを追加します。
      1. `useFirstRowAsHeader`がtrueの時、1行目をテーブルのヘッダとして使います。falseの時は、テーブルヘッダを自動生成します。
      2. `insertTotals`がtrueの時、末尾に、集計行を自動生成し、追加します。falseの時は、末尾に追加しません。
      パラメータ:
      tableName - テーブル名
      A1C1 - 追加テーブルのセル範囲(現在のワークシート)
      useFirstRowAsHeader - true:1行目をテーブルヘッダとする false: 1行目をテーブルヘッダとしない(テーブルヘッダを自動生成しない)
      insertTotals - true:末尾に集計行を追加する false:末尾に集計行を追加する
      戻り値:
      追加したテーブルのテーブルクラス

    • addListFromRange

      public TableWrapper addListFromRange(String tableName, String topA1, String A1C1, boolean useFirstRowAsHeader, boolean insertTotals)
      ワークシートのテーブル作成をデータコピーと共に行います。
      1. `useFirstRowAsHeader`がtrueの時、1行目をテーブルのヘッダとして使います。falseの時は、テーブルヘッダを自動生成します。（`A1C1`にテーブル名を設定した場合、常にtrueの扱いとなります)
      2. `insertTotals`がtrueの時、末尾に、合計行を自動生成し、追加します。falseの時は、末尾に追加しません。
      パラメータ:
      tableName - テーブル名
      topA1 - 作成するテーブルの左上のセル(単一セル)
      A1C1 - 作成テーブルにコピーするデータのセル範囲またはテーブル名(他シートからも可能です。他シートの場合、Sheet2!A1:C1のようなシート名を付加した表記となります)
      useFirstRowAsHeader - true:1行目をテーブルヘッダとする false: 1行目をテーブルヘッダとしない(テーブルヘッダを自動生成しない)
      insertTotals - true:末尾に集計行を追加する false: false:末尾に集計行を追加する
      戻り値:
      追加したテーブルのテーブルクラス

    • removeList

      public void removeList(String tableName, boolean deleteData)
      ワークシートからのテーブルの削除を行います。
      パラメータ:
      tableName - テーブル名
      deleteData - true: データの削除を行う false:データを残す

    • removeList

      public void removeList(String tableName)
      ワークシートからのテーブルの削除を行います(データの削除も行います)。
      パラメータ:
      tableName - テーブル名