パッケージ com.osboffice.osbxl

クラス WorkSheetWrapper

java.lang.Object
com.osboffice.osbxl.WorkSheetWrapper
public class WorkSheetWrapper extends Object
Excelのワークシートを取り扱うクラスです。

  • メソッドの詳細

    • getRange

      public RangeWrapper getRange(String A1C1)
      セル範囲クラスを取得します。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      セル範囲クラス

    • getCells

      public RangeWrapper getCells(int row, int col)
      セル範囲クラスを取得します。

      セル範囲A1は、row=1,col=1です。

      パラメータ:
      row - 行番号 1から始まります。
      col - 列番号 1から始まります。
      戻り値:
      セル範囲クラス

    • getCells

      public RangeWrapper getCells(int startRow, int startCol, int endRow, int endCol)
      セル範囲クラスを取得します。

      セル範囲A1:B2は、startRow=1,startCol=1,endRow=2,endCol=2です。

      パラメータ:
      startRow - 先頭行 1から始まります。
      startCol - 先頭列 1から始まります。
      endRow - 末尾行 1から始まります。
      endCol - 末尾列 1から始まります。
      戻り値:
      セル範囲クラス

    • getRow

      public RowWrapper getRow(int rowNum)
      行クラスを取得します。
      パラメータ:
      rowNum - 行番号 1から始まります。
      戻り値:
      行クラスインスタンス

    • getCol

      public ColWrapper getCol(int colNum)
      列クラスを取得します。

      A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

      パラメータ:
      colNum - 列番号
      戻り値:
      列クラスインスタンス
      関連項目:
      • AppWrapper.App.convertToColumnNumber(java.lang.String)

    • getFormatConditions

      public FormatConditionsWrapper getFormatConditions()
      条件付き書式クラスを取得します。
      戻り値:
      条件付き書式クラスのインスタンス

    • getAutoFilter

      public AutoFilterWrapper getAutoFilter(String A1C1, boolean firstRowAsHeader)
      オートフィルタークラスを取得します。

      オートフィルターは、シート単位で、１セル範囲となります。

      パラメータ:
      A1C1 - セル範囲(A1C1)
      firstRowAsHeader - true: 先頭行をヘッダとみなす false: ヘッダとみなさない
      戻り値:
      オートフィルタークラス

    • getAutoFilter

      public AutoFilterWrapper getAutoFilter(String A1C1)
      オートフィルタークラスを取得します(先頭行はヘッダとみなします)。

      オートフィルターは、シート単位で、１セル範囲となります。

      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      オートフィルタークラス

    • getSort

      public SortWrapper getSort(String A1C1, boolean firstRowAsHeader)
      並び替えクラスを取得します。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      firstRowAsHeader - true: 先頭行をヘッダとみなす false: ヘッダとみなさない
      戻り値:
      並び替えクラス

    • getSort

      public SortWrapper getSort(String A1C1)
      並び替えクラスを取得します(先頭行はヘッダとみなしません)。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      並び替えクラス

    • getComments

      public CommentsWrapper getComments()
      コメント/メモクラスを取得します。
      戻り値:
      コメント/メモクラス

    • getHyperLinks

      public HyperLinksWrapper getHyperLinks()
      ハイパーリンククラスを取得します。
      戻り値:
      ハイパーリンククラス

    • getListObjects

      public ListObjectsWrapper getListObjects()
      テーブル取得/生成クラスを取得します。
      戻り値:
      テーブル取得/生成クラス

    • getHPageBreaks

      public HPageBreaksWrapper getHPageBreaks()
      水平方向改行クラスを取得します。
      戻り値:
      水平方向改行クラス

    • getVPageBreaks

      public VPageBreaksWrapper getVPageBreaks()
      垂直方向改行クラスを取得します。
      戻り値:
      垂直方向改行クラス

    • getWindow

      public WindowWrapper getWindow()
      外観情報クラスを取得します。
      戻り値:
      外観情報クラス

    • getPivotTables

      public PivotTablesWrapper getPivotTables()
      PivotTable取得/生成クラスを取得します。
      戻り値:
      PivotTable取得/生成クラス

    • getShapes

      public ShapesWrapper getShapes()
      図形クラスを取得します。
      戻り値:
      図形クラス

    • getChartObject

      public ChartObjectWrapper getChartObject(int index)
      チャート図形クラスを取得します。 オブジェクトインデックスは、1から始まります。
      パラメータ:
      index - オブジェクトインデックス
      戻り値:
      チャート図形クラス

    • getChartObject

      public ChartObjectWrapper getChartObject(String chartName)
      チャート図形クラスを取得します。
      パラメータ:
      chartName - チャート名
      戻り値:
      チャート図形クラス

    • addChartObject

      public ChartObjectWrapper addChartObject(String chartName, double left, double top, double width, double height)
      チャート図形クラスを追加し、そのインスタンスを取得します。
      パラメータ:
      chartName - チャート名。空文字で設定すると、チャート名は、自動生成されます。
      left - 左端(単位:ポイント数)
      top - 上端(単位:ポイント数)
      width - 幅(単位:ポイント数)
      height - 高さ(単位:ポイント数)
      戻り値:
      追加したチャート図形クラス

    • deleteChartObject

      public void deleteChartObject(String chartName)
      チャート図形クラスを削除します。
      パラメータ:
      chartName - チャート名

    • deleteChartObject

      public void deleteChartObject(int index)
      チャート図形クラスを削除します。
      パラメータ:
      index - チャートインデックス 1から始まります。

    • getPageSetupObject

      public PageSetupObjectWrapper getPageSetupObject()
      ワークシートの印刷情報(ページマージン等の情報)を取得します。
      戻り値:
      印刷情報クラスのインスタンス

    • setPageSetupObject

      public void setPageSetupObject(PageSetupObjectWrapper pageSetupObject)
      ワークシートの印刷情報(ページマージン等の情報)を設定します。
      パラメータ:
      pageSetupObject - 印刷情報クラス

    • getActiveCell

      public String getActiveCell()
      ワークシートのアクティブな(選択されている)セル範囲の取得を行います。
      戻り値:
      セル範囲(A1C1)

    • setActiveCell

      public void setActiveCell(String A1C1)
      ワークシートのアクティブな(選択する)セル範囲の設定を行います。
      パラメータ:
      A1C1 - セル範囲(A1C1)

    • isActive

      public boolean isActive()
      ワークシートがアクティブかどうか(現在のワークシートのタブが起動時の表示項目か)を取得します。
      戻り値:
      true:アクティブ false:非アクティブ

    • activate

      public void activate(boolean isActive)
      ワークシートのタブのアクティブ/非アクティブ(起動時の表示項目か否か)を設定します。

      アクティブのタブを一つにするには、現在アクティブなタブを非アクティブにして、現在のシートをアクティブに設定します。

      パラメータ:
      isActive - true:アクティブ false:非アクティブ

    • insertRow

      public void insertRow(int startRowNumber, int numOfRows)
      ワークシート上の行の挿入を行います。
      パラメータ:
      startRowNumber - 挿入位置(行)
      numOfRows - 挿入行数

    • insertCol

      public void insertCol(int startColNumber, int numOfCols)
      ワークシート上の列の挿入を行います。

      A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

      パラメータ:
      startColNumber - 挿入位置(列)
      numOfCols - 挿入列数
      関連項目:
      • AppWrapper.App.convertToColumnNumber(java.lang.String)

    • deleteRow

      public void deleteRow(int startRowNumber, int numOfRows)
      ワークシート上の行の削除を行います。
      パラメータ:
      startRowNumber - 削除位置(行)
      numOfRows - 削除行数

    • deleteCol

      public void deleteCol(int startColNumber, int numOfCols)
      ワークシート上の列の削除を行います。

      A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

      パラメータ:
      startColNumber - 削除位置(列)
      numOfCols - 削除列数
      関連項目:
      • AppWrapper.App.convertToColumnNumber(java.lang.String)

    • clearRow

      public void clearRow(int startRowNumber, int numOfRows)
      ワークシート上の行をワークシート初期値に戻します。
      パラメータ:
      startRowNumber - 位置(行)
      numOfRows - 行数

    • clearCol

      public void clearCol(int startColNumber, int numOfCols)
      ワークシート上の列をワークシート初期値に戻します。

      A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

      パラメータ:
      startColNumber - 位置(列)
      numOfCols - 列数
      関連項目:
      • AppWrapper.App.convertToColumnNumber(java.lang.String)

    • insertCell

      public void insertCell(String A1C1, XlInsertDirection direction)
      ワークシート上のセル範囲の挿入を行います。
      パラメータ:
      A1C1 - 挿入セル範囲(A1C1)
      direction - 挿入方向(右 or 下) その他の挿入方向(左 or 上)を設定すると、例外が投げられます。

    • deleteCell

      public void deleteCell(String A1C1, XlInsertDirection direction)
      ワークシート上のセル範囲の削除を行います。
      パラメータ:
      A1C1 - 削除セル範囲(A1C1)
      direction - 削除方向(左 or 上) その他の挿入方向(右 or 下)を設定すると、例外が投げられます。

    • clearCell

      public void clearCell(String A1C1)
      ワークシート上のセルをワークシート初期値に戻します。
      パラメータ:
      A1C1 - クリアセル範囲(A1C1)

    • copyRow

      public void copyRow(String copyFromSheetName, int copyFromRowNumber, int numOfRows, int copyToRowNumber, XlCopyContentType copyType)
      行の上書きコピーを行います。

      osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

      パラメータ:
      copyFromSheetName - コピー元シート名
      copyFromRowNumber - コピー元開始行
      numOfRows - コピー行数
      copyToRowNumber - 現在ワークシートの適用行
      copyType - コピー対象

    • copyRow

      public void copyRow(String copyFromSheetName, int copyFromRowNumber, int numOfRows, int copyToRowNumber)
      行の上書きコピーを行います(コピー対象: CopyContentTypeAll)。

      osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

      パラメータ:
      copyFromSheetName - コピー元シート名
      copyFromRowNumber - コピー元開始行
      numOfRows - コピー行数
      copyToRowNumber - 現在ワークシートの適用行

    • copyCol

      public void copyCol(String copyFromSheetName, int copyFromColNumber, int numOfCols, int copyToColNumber, XlCopyContentType copyType)
      列のコピーを行います。
      1. osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。
      2. copyFromColNumberは、A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。
      パラメータ:
      copyFromSheetName - コピー元シート名
      copyFromColNumber - コピー元開始列
      numOfCols - コピー列数
      copyToColNumber - 現在ワークシートの適用列
      copyType - コピー対象
      関連項目:
      • AppWrapper.App.convertToColumnNumber(java.lang.String)

    • copyCol

      public void copyCol(String copyFromSheetName, int copyFromColNumber, int numOfCols, int copyToColNumber)
      列のコピーを行います(コピー対象: CopyContentTypeAll)。
      1. osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。
      2. copyFromColNumberは、A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。
      パラメータ:
      copyFromSheetName - コピー元シート名
      copyFromColNumber - コピー元開始列
      numOfCols - コピー列数
      copyToColNumber - 現在ワークシートの適用列
      関連項目:
      • AppWrapper.App.convertToColumnNumber(java.lang.String)

    • copyCell

      public void copyCell(String copyFromSheetName, String fromA1C1, String copyToA1, XlCopyContentType copyType)
      セル範囲の上書きコピーを行います。

      osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

      パラメータ:
      copyFromSheetName - コピー元シート名
      fromA1C1 - コピーセル範囲(A1C1)
      copyToA1 - 現在ワークシートの適用範囲の先頭セル(左上のセル)
      copyType - コピー対象

    • copyCell

      public void copyCell(String copyFromSheetName, String fromA1C1, String copyToA1)
      セル範囲の上書きコピーを行います(コピー対象: CopyContentTypeAll)。

      osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

      パラメータ:
      copyFromSheetName - コピー元シート名
      fromA1C1 - コピーセル範囲(A1C1)
      copyToA1 - 現在ワークシートの適用範囲の先頭セル(左上のセル)

    • getName

      public String getName()
      シート名称の取得を行います。
      戻り値:
      シート名称

    • setName

      public void setName(String name)
      シート名称の設定を行います。
      パラメータ:
      name - シート名称

    • setRowOutline

      public void setRowOutline(int startRow, int endRow, int outlineLevel)
      行方向のアウトラインを設定します。
      パラメータ:
      startRow - 開始行
      endRow - 終了行
      outlineLevel - アウトラインレベル(1～7) 。1は初期状態となります。

    • clearRowOutline

      public void clearRowOutline(int outlineLevel)
      行方向のアウトラインのクリアを行います。
      パラメータ:
      outlineLevel - アウトラインレベル(1～7) 。1は初期状態となります。

    • setColOutline

      public void setColOutline(int startCol, int endCol, int outlineLevel)
      列方向のアウトラインを設定します。

      startCol,endColは、A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

      パラメータ:
      startCol - 開始列
      endCol - 終了列
      outlineLevel - アウトラインレベル(1～7) 。1は初期状態となります。
      関連項目:
      • AppWrapper.App.convertToColumnNumber(java.lang.String)

    • clearColOutline

      public void clearColOutline(int outlineLevel)
      列方向のアウトラインのクリアを行います。
      パラメータ:
      outlineLevel - アウトラインレベル(1～7) 。1は初期状態となります。

    • setFormulaArray

      public void setFormulaArray(List<InputFormulaObjectWrapper> formulas)
      関数の一括入力を行います。
      パラメータ:
      formulas - List＜入力する関数オブジェクト＞

    • setValueArray

      public void setValueArray(List<InputValueObjectWrapper> values)
      セル値の一括入力を行います。
      パラメータ:
      values - List＜入力するセル値オブジェクト＞