パッケージ com.osboffice.osbxl

クラス RangeWrapper

java.lang.Object
com.osboffice.osbxl.RangeWrapper
public class RangeWrapper extends Object
ワークシートのセル範囲を扱うクラスです。

  • メソッドの詳細

    • getFont

      public FontWrapper getFont()
      フォントクラスの取得を行います。
      戻り値:
      フォントクラス

    • getBorders

      public BordersWrapper getBorders()
      枠線一括クラスの取得を行います。
      戻り値:
      枠線一括クラス

    • getFill

      public FillWrapper getFill()
      塗りつぶしクラスの取得を行います。
      戻り値:
      塗りつぶしクラス

    • getAlignment

      public AlignmentWrapper getAlignment()
      セル配置クラスの取得を行います。
      戻り値:
      セル配置クラス

    • getProtection

      public ProtectionWrapper getProtection()
      セル保護クラスの取得を行います。
      戻り値:
      セル保護クラス

    • getCharacters

      public CharactersWrapper getCharacters(int start)
      文字列クラスの取得を行います。
      パラメータ:
      start - 開始位置(先頭文字=1)
      戻り値:
      文字列クラス

    • getCharacters

      public CharactersWrapper getCharacters(int start, int length)
      文字列クラスの取得を行います。
      パラメータ:
      start - 開始位置(先頭文字=1)
      length - 文字数
      戻り値:
      文字列クラス

    • getPhonetics

      public PhoneticsWrapper getPhonetics()
      フリガナクラスの取得を行います。
      戻り値:
      フリガナクラス

    • getNumberFormat

      public Map<String,String> getNumberFormat()
      セル配置のセル書式を取得します。
      戻り値:
      Map＜セル範囲(A1C1), セル書式＞

    • setNumberFormat

      public void setNumberFormat(String numberFormat)
      セル配置のセル書式を設定します。
      パラメータ:
      numberFormat - セル書式

    • clearNumberFormat

      public void clearNumberFormat()
      セル範囲のセル書式をクリアします。

    • clearAllFormat

      public void clearAllFormat()
      セル範囲の書式すべてをワークシートの初期値に戻します。

    • clearContent

      public void clearContent()
      セル範囲の値をクリアします。

    • getValue

      public Map<String,String> getValue()
      セル範囲の値を取得します。
      戻り値:
      Map＜セル範囲(A1), 値＞

    • getFormula

      public Map<String,String> getFormula()
      セル範囲の関数を取得します。
      戻り値:
      Map＜セル範囲(A1), 関数＞

    • setValue

      public void setValue(String value, boolean forceString, String numberFormat)
      セル配置の値を設定します(汎用)。
      パラメータ:
      value - 値
      forceString - true: 強制的に文字列と扱う false: 通常
      numberFormat - セルの書式 空文字の場合は、設定しません。

    • setValue

      public void setValue(String value, boolean forceString)
      セル配置の値を設定します(汎用)。
      パラメータ:
      value - 値
      forceString - true: 強制的に文字列と扱う false: 通常

    • setValue

      public void setValue(String value)
      セル配置の値を設定します(汎用)。
      パラメータ:
      value - 値

    • setNumberValue

      public void setNumberValue(double value, boolean forceString, String numberFormat)
      セル配置の値を設定します(数値)。
      パラメータ:
      value - 値
      forceString - true: 強制的に文字列と扱う false: 通常
      numberFormat - セルの書式

    • setNumberValue

      public void setNumberValue(double value, boolean forceString)
      セル配置の値を設定します(数値)。
      パラメータ:
      value - 値
      forceString - true: 強制的に文字列と扱う false: 通常

    • setNumberValue

      public void setNumberValue(double value)
      セル配置の値を設定します(数値)。
      パラメータ:
      value - 値

    • setDateValue

      public void setDateValue(DateTimeObjectWrapper value, boolean forceString, String numberFormat)
      セル配置の値を設定します(日付時刻オブジェクト)。
      パラメータ:
      value - 値
      forceString - true: 強制的に文字列と扱う false: 通常
      numberFormat - セルの書式

    • setDateValue

      public void setDateValue(DateTimeObjectWrapper value, boolean forceString)
      セル配置の値を設定します(日付時刻オブジェクト)。
      パラメータ:
      value - 値
      forceString - true: 強制的に文字列と扱う false: 通常

    • setDateValue

      public void setDateValue(DateTimeObjectWrapper value)
      セル配置の値を設定します(日付時刻オブジェクト)。
      パラメータ:
      value - 値

    • setDateStringValue

      public void setDateStringValue(String value, boolean forceString, String numberFormat)
      セル配置の値を設定します(日付/時刻設定メソッド(文字列から入力))。
      パラメータ:
      value - 値
      forceString - true: 強制的に文字列と扱う false: 通常
      numberFormat - セルの書式

    • setDateStringValue

      public void setDateStringValue(String value, boolean forceString)
      セル配置の値を設定します(日付/時刻設定メソッド(文字列から入力))。
      パラメータ:
      value - 値
      forceString - true: 強制的に文字列と扱う false: 通常

    • setDateStringValue

      public void setDateStringValue(String value)
      セル配置の値を設定します(日付/時刻設定メソッド(文字列から入力))。
      パラメータ:
      value - 値

    • setBooleanValue

      public void setBooleanValue(boolean value, boolean forceString, String numberFormat)
      セル配置の値を設定します(論理値)。
      パラメータ:
      value - 値 true: TRUE false: FALSE
      forceString - true: 強制的に文字列と扱う false: 通常
      numberFormat - セルの書式

    • setBooleanValue

      public void setBooleanValue(boolean value, boolean forceString)
      セル配置の値を設定します(論理値)。
      パラメータ:
      value - 値 true: TRUE false: FALSE
      forceString - true: 強制的に文字列と扱う false: 通常

    • setBooleanValue

      public void setBooleanValue(boolean value)
      セル配置の値を設定します(論理値)。
      パラメータ:
      value - 値 true: TRUE false: FALSE

    • setFormula

      public void setFormula(String formula, boolean isArray, boolean setAllCell)
      数式の設定を行います。
      1. ARRAY数式の場合、setAllCellは無視されます。
      2. ExcelのSpill機能をサポートしています。そのため、1セルに対して、複数セルの返却値が返されることがあります。
      3. Excel同様に、セル範囲は、相対参照、絶対参照($つき)を設定可能です。
      パラメータ:
      formula - 数式
      isArray - true: Array数式としてセル範囲全体が入力対象 false:通常数式
      setAllCell - false:対象セルのTopLeftセル(先頭セル)だけformulaを設定する true:全セルに数式を設定する

    • setFormula

      public void setFormula(String formula, boolean isArray)
      数式の設定を行います(Array数式でない場合、対象セルのTopLeftセル(先頭セル)だけformulaを設定する)。
      1. ExcelのSpill機能をサポートしています。そのため、1セルに対して、複数セルの返却値が返されることがあります。
      2. Excel同様に、セル範囲は、相対参照、絶対参照($つき)を設定可能です。
      パラメータ:
      formula - 数式
      isArray - true: Array数式としてセル範囲全体が入力対象 false:通常数式

    • setFormula

      public void setFormula(String formula)
      数式の設定を行います(通常数式 かつ 対象セルのTopLeftセル(先頭セル)だけformulaを設定する)。
      1. ExcelのSpill機能をサポートしています。そのため、1セルに対して、複数セルの返却値が返されることがあります。
      2. Excel同様に、セル範囲は、相対参照、絶対参照($つき)を設定可能です。
      パラメータ:
      formula - 数式

    • setDataTable

      public void setDataTable(String rowA1, String colA1)
      データテーブルの設定を行います。
      1. データテーブルの範囲は、Rangeのセル範囲となります。
      2. `rowA1`および`colA1`の両方に値を設定すると、複方向(行、列)のデータテーブルとなり、片方に値を設定すると、単方向(行または列)となります。
      3. 複方向の時は、計算セルは、左上のセルとなります。
      4. 単方向の時は、Rangeのセル範囲は、２行または、２列である必要があります。
      5. データーテーブルの向きが行の時は２列目の先頭セルに計算式がある必要があり、列の時は、２行目の先頭セルに計算式がある必要があります。
      パラメータ:
      rowA1 - 単方向データテーブルの向きが行の時は、空文字を設定します。
      colA1 - 方向データテーブルの向きが列の時は、空文字を設定します。

    • clearDataTable

      public void clearDataTable()
      データテーブルのクリアを行います。
      1. データテーブルを消去します。Rangeのセル範囲の中に、データテーブルの(データ部=TABLE関数)が入っていれば、消去します。

    • setBuiltinStyle

      public void setBuiltinStyle(XlBuiltInStyle builtinNumber)
      セル範囲にExcelビルトイン(組み込み)のセルスタイルを適用します。
      パラメータ:
      builtinNumber - Excelビルトイン(組み込み)のセルスタイル

    • setCustomStyle

      public void setCustomStyle(String customStyleName)
      セル範囲にカスタムセルスタイルの適用を行います。
      パラメータ:
      customStyleName - カスタムセルスタイル名

    • getTotalWidth

      public double getTotalWidth()
      セル範囲の幅の取得を行います。
      1. セル範囲のピクセル数を取得します。OSBXLでは、DPIを96DPIとした計算値を取得します。
      戻り値:
      セル範囲のピクセル数

    • getTotalColumnWidth

      public double getTotalColumnWidth()
      セル範囲の列に収まる文字数の取得を行います。
      1. セル範囲の列に収まる文字数を設定します。文字数の単位は、現在のフォントの0~9の文字の中で一番横幅が長い文字となります(Excel同様です)。
      戻り値:
      セル範囲の列に収まる文字数

    • getTotalRowHeight

      public double getTotalRowHeight()
      セル範囲の高さの取得を行います。
      1. セル範囲のポイント数を取得します。
      戻り値:
      セル範囲の高さ

    • getAddress

      public String getAddress()
      セル範囲(A1C1文字列形式)の取得を行います。
      戻り値:
      セル範囲(A1C1文字列形式)

    • merge

      public void merge(boolean mergeEachRow)
      セル範囲を結合します。
      パラメータ:
      mergeEachRow - true: 行単位に分割して結合 false:セル範囲全体を結合

    • merge

      public void merge()

    • unMerge

      public void unMerge()
      マージの解除を行います。