library-wpoi
b2007093001

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

java.lang.Object
  拡張org.phosphoresce.library.wpoi.adapter.PoiRange
すべての実装インタフェース:
java.io.Serializable

public final class PoiRange
extends java.lang.Object
implements java.io.Serializable

セル範囲保持クラス。
org.apache.poi.hssf.util.Region同等クラスだがPOI操作パッケージ階層を 同一にする為、別途設けたもの。

作成者:
last modified by: Kitagawa
LastUpdate: 2005/11/21
関連項目:
直列化された形式

コンストラクタの概要
PoiRange()
          コンストラクタ
再左上端のセルを選択範囲としてクラスを初期化します。
PoiRange(int rowFrom, short colFrom, int rowTo, short colTo)
          コンストラクタ
指定された範囲のクラスとして初期化します。
PoiRange(PoiRange range)
          コンストラクタ
指定されたPoiRangeオブジェクトと範囲のクラスとして初期化します。
 
メソッドの概要
 short getColFrom()
          colFromを取得します。
 short getColTo()
          colToを取得します。
 int getHeight()
          範囲情報の高さを取得します(最小値=1)。
 int getRowFrom()
          rowFromを取得します。
 int getRowTo()
          rowToを取得します。
 short getWidth()
          範囲情報の幅を取得します(最小値=1)。
 void setColFrom(short colFrom)
          colFromを設定します。
 void setColTo(short colTo)
          colToを設定します。
 void setRowFrom(int rowFrom)
          rowFromを設定します。
 void setRowTo(int rowTo)
          rowToを設定します。
 void shift(int row, short col)
          指定された行方向、カラム方向にシフト範囲のシフト処理を行います。
 java.lang.String toString()
          クラス情報を文字列で取得します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

PoiRange

public PoiRange()
コンストラクタ
再左上端のセルを選択範囲としてクラスを初期化します。


PoiRange

public PoiRange(PoiRange range)
         throws PoiException
コンストラクタ
指定されたPoiRangeオブジェクトと範囲のクラスとして初期化します。

パラメータ:
range - PoiRangeオブジェクト
例外:
PoiException - フィールドの値が負数となってしまう場合に発生

PoiRange

public PoiRange(int rowFrom,
                short colFrom,
                int rowTo,
                short colTo)
         throws PoiException
コンストラクタ
指定された範囲のクラスとして初期化します。

パラメータ:
rowFrom - 行位置(開始)
colFrom - カラム位置(開始)
rowTo - 行位置(終了)
colTo - カラム位置(終了)
例外:
PoiException - フィールドの値が負数となってしまう場合に発生
メソッドの詳細

getColFrom

public short getColFrom()
colFromを取得します。

戻り値:
colFrom

setColFrom

public void setColFrom(short colFrom)
                throws PoiException
colFromを設定します。
位置を設定したタイミングで整合性を取る為の処理が行われ終了位置よりも開始位置値が 小さくなるように補正されます。

パラメータ:
colFrom - colFrom
例外:
PoiException - フィールドの値が負数となってしまう場合に発生

getColTo

public short getColTo()
colToを取得します。

戻り値:
colTo

setColTo

public void setColTo(short colTo)
              throws PoiException
colToを設定します。
位置を設定したタイミングで整合性を取る為の処理が行われ終了位置よりも開始位置値が 小さくなるように補正されます。

パラメータ:
colTo - colTo
例外:
PoiException - フィールドの値が負数となってしまう場合に発生

getRowFrom

public int getRowFrom()
rowFromを取得します。

戻り値:
rowFrom

setRowFrom

public void setRowFrom(int rowFrom)
                throws PoiException
rowFromを設定します。
位置を設定したタイミングで整合性を取る為の処理が行われ終了位置よりも開始位置値が 小さくなるように補正されます。

パラメータ:
rowFrom - rowFrom
例外:
PoiException - フィールドの値が負数となってしまう場合に発生

getRowTo

public int getRowTo()
rowToを取得します。

戻り値:
rowTo

setRowTo

public void setRowTo(int rowTo)
              throws PoiException
rowToを設定します。
位置を設定したタイミングで整合性を取る為の処理が行われ終了位置よりも開始位置値が 小さくなるように補正されます。

パラメータ:
rowTo - rowTo
例外:
PoiException - フィールドの値が負数となってしまう場合に発生

getHeight

public int getHeight()
範囲情報の高さを取得します(最小値=1)。

戻り値:
範囲情報の高さ

getWidth

public short getWidth()
範囲情報の幅を取得します(最小値=1)。

戻り値:
範囲情報の幅

shift

public void shift(int row,
                  short col)
           throws PoiException
指定された行方向、カラム方向にシフト範囲のシフト処理を行います。
位置を設定したタイミングで整合性を取る為の処理が行われ終了位置よりも開始位置値が 小さくなるように補正されます。

パラメータ:
row - 行方向シフト値
col - カラム方向シフト値
例外:
PoiException - フィールドの値が負数となってしまう場合に発生

toString

public java.lang.String toString()
クラス情報を文字列で取得します。

戻り値:
クラス情報
関連項目:
Object.toString()

library-wpoi
b2007093001