library-wpoi
b2007093001

org.phosphoresce.library.wpoi.adapter
クラス PoiSheet

java.lang.Object
  拡張org.phosphoresce.library.wpoi.adapter.PoiSheet

public final class PoiSheet
extends java.lang.Object

POIシート制御クラス。
org.apache.poi.hssf.usermodel.HSSFSheetの脆弱なインタフェース部分及び、 不足する情報を保持、提供することを目的としたクラス。
HSSFSheetに対する全ての制御インタフェースは実装しない為、自身が扱う HSSFSheetオブジェクトの取得メソッドは当クラスに実装される。
当クラスのインスタンスはPoiWorkbookから提供されるもので ユーザが意図的にインスタンスを生成することは想定しない。

作成者:
last modified by: Kitagawa
LastUpdate: 2005/11/21

コンストラクタの概要
protected PoiSheet(PoiWorkbook pWorkbook, org.apache.poi.hssf.usermodel.HSSFSheet hssfSheet)
          コンストラクタ
 
メソッドの概要
 void applyPrintConfig(PoiPrintConfig config)
          指定されたシート印刷環境設定オブジェクトから現在のPoiSheetが扱う HSSFSheetオブジェクトに対して設定を適用します。
 void copyPaste(PoiRange fromRange, int row, short col)
          指定されたPoiRange範囲の内容を指定された行位置、カラム位置に対して複写します。
 void deleteRow(int row)
          指定された行位置の行を削除します。
protected  org.apache.poi.hssf.usermodel.HSSFSheet getHssfSheet()
          自身が扱うHSSFSheetオブジェクトを取得します。
 short getLastColNum()
          シートが保持する最大カラム位置を取得する。
 int getLastRowNum()
          シートが保持する最大行位置を取得する。
 PoiCell getPoiCell(int row, short col)
          指定された行位置及びカラム位置のPoiCellオブジェクトを取得します。
 PoiCell getPoiCell(int row, short col, boolean fourceInstance)
          指定された行位置及びカラム位置のPoiCellオブジェクトを取得します。
 PoiRow getPoiRow(int row)
          指定された行位置のPoiRowオブジェクトを取得します。
 PoiRow getPoiRow(int row, boolean fourceInstance)
          指定された行位置のPoiRowオブジェクトを取得します。
 java.lang.String getSheetName()
          シート名を取得する。
 void insertRow(int row)
          指定された行に対して行を追加します。
 void setSheetName(java.lang.String name)
          シート名を設定する。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PoiSheet

protected PoiSheet(PoiWorkbook pWorkbook,
                   org.apache.poi.hssf.usermodel.HSSFSheet hssfSheet)
コンストラクタ

パラメータ:
pWorkbook - PoiWorkbookオブジェクト
hssfSheet - HSSFSheetオブジェクト
メソッドの詳細

getHssfSheet

protected org.apache.poi.hssf.usermodel.HSSFSheet getHssfSheet()
自身が扱うHSSFSheetオブジェクトを取得します。

戻り値:
HSSFSheetオブジェクト

applyPrintConfig

public void applyPrintConfig(PoiPrintConfig config)
指定されたシート印刷環境設定オブジェクトから現在のPoiSheetが扱う HSSFSheetオブジェクトに対して設定を適用します。

パラメータ:
config - PoiSheetConfigオブジェクト

setSheetName

public void setSheetName(java.lang.String name)
シート名を設定する。

パラメータ:
name - シート名

getSheetName

public java.lang.String getSheetName()
シート名を取得する。

戻り値:
シート名

getLastRowNum

public int getLastRowNum()
シートが保持する最大行位置を取得する。

戻り値:
シートが保持する最大行位置

getLastColNum

public short getLastColNum()
シートが保持する最大カラム位置を取得する。

戻り値:
シートが保持する最大カラム位置

getPoiRow

public PoiRow getPoiRow(int row,
                        boolean fourceInstance)
指定された行位置のPoiRowオブジェクトを取得します。
fourceInstanceにtrueが指定されていてHSSFRowがnullの場合、 新規にHSSFRowインスタンスを生成します。

パラメータ:
row - 行位置
fourceInstance - 対象の行がnullの場合に強制的にインスタンスを生成する場合はtrueを指定
戻り値:
PoiRowオブジェクト

getPoiRow

public PoiRow getPoiRow(int row)
指定された行位置のPoiRowオブジェクトを取得します。

パラメータ:
row - 行位置
戻り値:
PoiRowオブジェクト

getPoiCell

public PoiCell getPoiCell(int row,
                          short col,
                          boolean fourceInstance)
指定された行位置及びカラム位置のPoiCellオブジェクトを取得します。

パラメータ:
row - 行位置
col - カラム位置
fourceInstance - 対象の行及びセルがnullの場合に強制的にインスタンスを生成する場合はtrueを指定
戻り値:
PoiCellオブジェクト

getPoiCell

public PoiCell getPoiCell(int row,
                          short col)
指定された行位置及びカラム位置のPoiCellオブジェクトを取得します。

パラメータ:
row - 行位置
col - カラム位置
戻り値:
PoiCellオブジェクト

copyPaste

public void copyPaste(PoiRange fromRange,
                      int row,
                      short col)
               throws PoiException
指定されたPoiRange範囲の内容を指定された行位置、カラム位置に対して複写します。

パラメータ:
fromRange - 複写対象セル範囲オブジェクト
row - 複写先行位置
col - 複写先カラム位置
例外:
PoiException - 正常にカラム郡の複写が行えなかった場合に発生します

insertRow

public void insertRow(int row)
指定された行に対して行を追加します。

パラメータ:
row - 挿入対象行位置

deleteRow

public void deleteRow(int row)
指定された行位置の行を削除します。
行内容を削除するだけではなく対象の行そのものを削除して上に行を詰める処理を行います。
また、削除対象行に結合セルが存在する場合は、その結合セルも併せて詰める処理を行います。

パラメータ:
row -

library-wpoi
b2007093001