jp.co.nissy.jpicosheet.core
クラス Book

java.lang.Object
  上位を拡張 jp.co.nissy.jpicosheet.core.Book

public class Book
extends java.lang.Object

複数のシートを持つことのできる"ブック"です。
シートの保持だけでなく、保持しているシートの自動再計算の制御やセル間の参照関係を維持する機能も保持しています。

作成者:
yusuke nishikawa

コンストラクタの概要
Book(java.lang.String bookName)
          ブック名を指定してブックを作成します
 
メソッドの概要
 Sheet addSheet(java.lang.String sheetName)
          シートを追加します。
 void deleteSheet(java.lang.String sheetName)
          引数に指定したシートを削除します。
 java.lang.String[] getFunctionNames()
          利用可能な関数名の配列を返します。
 java.lang.String getName()
          ブック名を返します
 Resolver getResolver()
          リゾルバを返します。
 Sheet getSheet(java.lang.String sheetName)
          引数に指定したシートオブジェクトを返します。
 java.util.List<Sheet> getSheets()
          このブックが保持するすべてのシートへの参照を返します
 boolean isRecalcEnable()
          ブックに対する自動計算が有効か否かを返します。
 void recalcDisable()
          ブックに対する自動再計算を無効にします。
 void recalcEnable()
          ブックに対する自動再計算を有効にします。
 void renameSheet(java.lang.String sheetName, java.lang.String newSheetName)
          既存のシートのシート名を変更します。
 void setName(java.lang.String bookName)
          ブック名をセットします
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

Book

public Book(java.lang.String bookName)
     throws java.lang.IllegalArgumentException
ブック名を指定してブックを作成します

パラメータ:
bookName - ブック名
例外:
java.lang.IllegalArgumentException - ブック名が正しくない場合
メソッドの詳細

getName

public java.lang.String getName()
ブック名を返します

戻り値:
ブック名

setName

public void setName(java.lang.String bookName)
ブック名をセットします

パラメータ:
bookName - ブック名
例外:
java.lang.IllegalArgumentException - ブック名が正しくない場合

getResolver

public Resolver getResolver()
リゾルバを返します。

戻り値:
リゾルバ

addSheet

public Sheet addSheet(java.lang.String sheetName)
シートを追加します。
指定したシート名がすでに存在する場合、既存のシートオブジェクトを返します。

パラメータ:
sheetName - シート名
戻り値:
追加したシートオブジェクト

getSheets

public java.util.List<Sheet> getSheets()
このブックが保持するすべてのシートへの参照を返します

戻り値:
このブックが保持するシートへの参照

renameSheet

public void renameSheet(java.lang.String sheetName,
                        java.lang.String newSheetName)
既存のシートのシート名を変更します。
変更対象のシートが存在しない場合、ReferenceNotFoundExceptionが発生します。
変更後のシート名を持つシートがすでに存在していた場合、そのシートオブジェクトは削除されます。
名前を変更したのがデフォルトシートだった場合、名前を変更してもデフォルトシートはそのシートのままです。

パラメータ:
sheetName - 変更対象のシート名
newSheetName - 変更後のシート名

deleteSheet

public void deleteSheet(java.lang.String sheetName)
引数に指定したシートを削除します。
指定したシートが存在しない場合、ReferenceNotFoundExceptionが発生します。

パラメータ:
sheetName - 削除対象のシート名

getSheet

public Sheet getSheet(java.lang.String sheetName)
引数に指定したシートオブジェクトを返します。
指定したシートが存在しない場合、ReferenceNotFoundExceptionが発生します。

パラメータ:
sheetName - シート名
戻り値:
シートオブジェクト

recalcEnable

public void recalcEnable()
ブックに対する自動再計算を有効にします。
同時に、すべてのセルを再計算します。


recalcDisable

public void recalcDisable()
ブックに対する自動再計算を無効にします。


isRecalcEnable

public boolean isRecalcEnable()
ブックに対する自動計算が有効か否かを返します。

戻り値:
自動再計算が有効の場合true、無効の場合false

getFunctionNames

public java.lang.String[] getFunctionNames()
利用可能な関数名の配列を返します。

戻り値:
関数名の配列