パッケージ com.osboffice.osbxl.dto

クラス PageSetupObjectWrapper

java.lang.Object
com.osboffice.osbxl.dto.PageSetupObjectWrapper
public class PageSetupObjectWrapper extends Object
印刷情報設定オブジェクトです。

  • コンストラクタの詳細

    • PageSetupObjectWrapper

      public PageSetupObjectWrapper()
      コンストラクタ

      インスタンスを作成します。

  • メソッドの詳細

    • getAlignMarginsHeaderFooter

      public boolean getAlignMarginsHeaderFooter()
      ヘッダーとフッターを余白に合わせて配置するかどうか取得します。
      戻り値:
      true: ヘッダーとフッターを余白に合わせて配置する false: ヘッダーとフッターを余白に合わせて配置しない

    • getBlackAndWhilte

      public boolean getBlackAndWhilte()
      白黒印刷するかどうか取得します。
      戻り値:
      true: 白黒印刷する false:白黒印刷しない

    • getBottomMargin

      public double getBottomMargin()
      下のマージンを取得します。
      戻り値:
      下のマージン 単位はcmです。

    • getCenterHorizontally

      public boolean getCenterHorizontally()
      シートがページ上の横方向の中央位置に配置されているかどうか取得します。
      戻り値:
      true: 中央位置に配置されている false: 中央位置に配置されていない

    • getCenterVertically

      public boolean getCenterVertically()
      シートが印刷時にシートがページの垂直方向の中央に配置されているかどうか取得します。
      戻り値:
      true: 垂直方向の中央に配置されている false: 垂直方向の中央に配置されていない

    • getDifferentFirstPageHeaderFooter

      public boolean getDifferentFirstPageHeaderFooter()
      別のヘッダーやフッターが先頭ページに使用されるかどうか取得します。
      戻り値:
      true: 先頭ページに使用される false: 先頭ページに使用されない

    • getDraft

      public boolean getDraft()
      ドラフトクオリティかどうか取得します。
      戻り値:
      true: ドラフトクオリティ false: ドラフトクオリティでない

    • getEvenFooter

      public FooterObjectWrapper getEvenFooter()
      偶数ページのフッタオブジェクトを取得します。
      戻り値:
      偶数ページのフッタオブジェクト

    • getEvenHeader

      public HeaderObjectWrapper getEvenHeader()
      偶数ページのヘッダオブジェクトを取得します。
      戻り値:
      偶数ページのヘッダオブジェクト

    • getOddFooter

      public FooterObjectWrapper getOddFooter()
      奇数ページのフッタオブジェクトを取得します。
      戻り値:
      奇数ページのフッタオブジェクト

    • getOddHeader

      public HeaderObjectWrapper getOddHeader()
      奇数ページのヘッダオブジェクトを取得します。
      戻り値:
      奇数ページのヘッダオブジェクト

    • getFirstFooter

      public FooterObjectWrapper getFirstFooter()
      最初のページのフッタオブジェクトを取得します。
      戻り値:
      最初のページのフッタオブジェクト

    • getFirstHeader

      public HeaderObjectWrapper getFirstHeader()
      最初のページのヘッダオブジェクトを取得します。
      戻り値:
      最初のページのヘッダオブジェクト

    • getFirstPageNumber

      public int getFirstPageNumber()
      このシートの印刷時に使用される最初のページ番号を取得します。
      戻り値:
      最初のページ番号 既定値の0は自動を意味します

    • getFitToPagesTall

      public int getFitToPagesTall()
      ワークシートの印刷時に拡大縮小する高さのページ数を取得します。
      戻り値:
      拡大縮小する高さのページ数

    • getFitToPagesWide

      public int getFitToPagesWide()
      ワークシートの印刷時に拡大縮小する幅のページ数を取得します。
      戻り値:
      拡大縮小する幅のページ数

    • getFooterMargin

      public double getFooterMargin()
      フッダのマージンを取得します。
      戻り値:
      フッダのマージン 単位はcmです。

    • getHeaderMargin

      public double getHeaderMargin()
      ヘッダのマージンを取得します。
      戻り値:
      ヘッダのマージン 単位はcmです。

    • getLeftMargin

      public double getLeftMargin()
      左のマージンを取得します。
      戻り値:
      左のマージン 単位はcmです。

    • getOddAndEvenPagesHeaderFooter

      public boolean getOddAndEvenPagesHeaderFooter()
      奇数ページと偶数ページに異なるヘッダとフッタを取得します。
      戻り値:
      true: 奇数ページと偶数ページが異なるフッタ false: 通常

    • getOrder

      public XlOrder getOrder()
      大きなワークシートの印刷時のページ番号の印刷の順序を取得します。
      戻り値:
      印刷の順序

    • getOrientation

      public XlPageOrientation getOrientation()
      印刷の向きを取得します。
      戻り値:
      印刷の向き

    • getPaperSize

      public XlPaperSize getPaperSize()
      印刷の用紙サイズを取得します。
      戻り値:
      印刷の用紙サイズ

    • getPrintArea

      public String getPrintArea()
      印刷範囲を取得します。A1C1表記で取得します。
      戻り値:
      印刷範囲(A1C1)

    • getPrintComments

      public XlPrintLocation getPrintComments()
      シートにコメントを印刷する方法を取得します。
      戻り値:
      コメントを印刷する方法

    • getPrintErrors

      public XlPrintErrors getPrintErrors()
      表示される印刷エラーの種類の設定を取得します。
      戻り値:
      印刷エラーの種類

    • getPrintGridlines

      public boolean getPrintGridlines()
      セルの枠線をページ上に印刷するかどうかを取得します。
      戻り値:
      true: セルの枠線をページ上に印刷する false: セルの枠線をページ上に印刷しない

    • getPrintHeadings

      public boolean getPrintHeadings()
      行見出しと列見出しをこのページで印刷するかどうかを取得します。
      戻り値:
      true: 行見出しと列見出しを印刷する false: 行見出しと列見出しを印刷しない

    • getPrintNotes

      public boolean getPrintNotes()
      セルノートはシートと一緒に終了ノートとして印刷するかどうかを取得します。
      戻り値:
      true: セルノートはシートと一緒に終了ノートとして印刷する false: セルノートはシートと一緒に終了ノートとして印刷しない

    • getHorizontalPrintQuality

      public int getHorizontalPrintQuality()
      水平方向のDPIを取得します。
      戻り値:
      水平方向のDPI

    • getVerticalPrintQuality

      public int getVerticalPrintQuality()
      垂直方向のDPIを取得します。
      戻り値:
      垂直方向のDPI

    • getPrintTitleColumnsFromCol

      public int getPrintTitleColumnsFromCol()
      印刷タイトルの列方向の開始列を取得します。
      戻り値:
      印刷タイトルの列方向の開始列 0は印刷タイトルなしを意味します。

    • getPrintTitleColumnsToCol

      public int getPrintTitleColumnsToCol()
      印刷タイトルの列方向の終了列を取得します。
      戻り値:
      印刷タイトルの列方向の終了列 0は印刷タイトルなしを意味します。

    • getPrintTitleRowsFromRow

      public int getPrintTitleRowsFromRow()
      印刷タイトルの行方向の開始行を取得します。
      戻り値:
      印刷タイトルの行方向の開始行 0は印刷タイトルなしを意味します。

    • getPrintTitleRowsToRow

      public int getPrintTitleRowsToRow()
      印刷タイトルの行方向の終了行を取得します。
      戻り値:
      印刷タイトルの行方向の終了行 0は印刷タイトルなしを意味します。

    • getRightMargin

      public double getRightMargin()
      右のマージンを取得します。
      戻り値:
      右のマージン 単位はcmです。

    • getScaleWithDocHeaderFooter

      public boolean getScaleWithDocHeaderFooter()
      ヘッダとフッタを文書と一緒に拡大縮小する必要があるかどうかを取得します。
      戻り値:
      true:ヘッダとフッタを文書と一緒に拡大縮小する false:ヘッダとフッタを文書と一緒に拡大縮小しない

    • getTopMargin

      public double getTopMargin()
      上のマージンを取得します。
      戻り値:
      上のマージン 単位はcmです。

    • getZoom

      public int getZoom()
      ズーム値を取得します(パーセント)。
      戻り値:
      ズームの許容値は、10から400パーセントです。

    • setAlignMarginsHeaderFooter

      public void setAlignMarginsHeaderFooter(boolean apply)
      ヘッダとフッタを余白に合わせて配置するかどうか設定します。
      パラメータ:
      apply - true: ヘッダとフッタを余白に合わせて配置する false: ヘッダとフッタを余白に合わせて配置しない

    • setBlackAndWhilte

      public void setBlackAndWhilte(boolean apply)
      白黒印刷するかどうか設定します。
      パラメータ:
      apply - true:白黒印刷 false:通常印刷

    • setBottomMargin

      public void setBottomMargin(double margin)
      下のマージンを設定します。
      パラメータ:
      margin - 下のマージン 単位はcmです。

    • setCenterHorizontally

      public void setCenterHorizontally(boolean apply)
      シートがページ上の横方向の中央位置に配置するかどうか設定します。
      パラメータ:
      apply - true: 横方向の中央位置に配置する false: 横方向の中央位置に配置しない

    • setCenterVertically

      public void setCenterVertically(boolean apply)
      シートが印刷時にシートがページの垂直方向の中央に配置するかどうか設定します。
      パラメータ:
      apply - true: 垂直方向の中央に配置する false: 垂直方向の中央に配置しない

    • setDraft

      public void setDraft(boolean apply)
      ドラフトクオリティかどうか設定します。
      パラメータ:
      apply - true: ドラフトクオリティ false: 通常

    • setHeader

      public void setHeader(HeaderObjectWrapper header)
      ヘッダーオブジェクトを設定します。
      パラメータ:
      header - ヘッダーオブジェクト

    • setOddAndEvenHeader

      public void setOddAndEvenHeader(HeaderObjectWrapper oddHeader, HeaderObjectWrapper evenHeader)
      奇数、偶数ページに別のヘッダーオブジェクトを設定します。
      パラメータ:
      oddHeader - 奇数ページのヘッダーオブジェクト
      evenHeader - 偶数ページのヘッダーオブジェクト

    • setHeaderAndFirstHeader

      public void setHeaderAndFirstHeader(HeaderObjectWrapper header, HeaderObjectWrapper firstHeader)
      初ページに別のヘッダーオブジェクトを設定します。
      パラメータ:
      header - ヘッダーオブジェクト
      firstHeader - 初ページのヘッダーオブジェクト

    • setFirstAndOddAndEvenHeader

      public void setFirstAndOddAndEvenHeader(HeaderObjectWrapper firstHeader, HeaderObjectWrapper oddHeader, HeaderObjectWrapper evenHeader)
      初ページ、奇数、偶数ページに別のヘッダーオブジェクトを設定します。
      パラメータ:
      firstHeader - 初ページのヘッダーオブジェクト
      oddHeader - 奇数ページのヘッダーオブジェクト
      evenHeader - 偶数ページのヘッダーオブジェクト

    • setFooter

      public void setFooter(FooterObjectWrapper footer)
      フッダーオブジェクトを設定します。
      パラメータ:
      footer - フッダーオブジェクト

    • setOddAndEvenFooter

      public void setOddAndEvenFooter(FooterObjectWrapper oddFooter, FooterObjectWrapper evenFooter)
      奇数、偶数ページに別のフッダーオブジェクトを設定します。
      パラメータ:
      oddFooter - 奇数ページのフッダーオブジェクト
      evenFooter - 偶数ページのフッダーオブジェクト

    • setFooterAndFirstFooter

      public void setFooterAndFirstFooter(FooterObjectWrapper footer, FooterObjectWrapper firstFooter)
      初ページに別のフッダーオブジェクトを設定します。
      パラメータ:
      footer - 通常のフッダーオブジェクト
      firstFooter - 初ページのフッダーオブジェクト

    • setFirstAndOddAndEvenFooter

      public void setFirstAndOddAndEvenFooter(FooterObjectWrapper firstFooter, FooterObjectWrapper oddFooter, FooterObjectWrapper evenFooter)
      初ページ、奇数、偶数ページに別のフッダーオブジェクトを設定します。
      パラメータ:
      firstFooter - 初ページのフッダーオブジェクト
      oddFooter - 奇数ページのフッダーオブジェクト
      evenFooter - 偶数ページのフッダーオブジェクト

    • setFirstPageNumber

      public void setFirstPageNumber(int num)
      このシートの印刷時に使用される最初のページ番号を設定します。
      パラメータ:
      num - 最初のページ番号 0は自動を意味します。

    • setFitToPages

      public void setFitToPages(int numTall, int numWide)
      ワークシートの印刷時に拡大縮小するページ数を設定します。
      1. `setZoom`メソッドで、ズームを設定すると、0になります。
      パラメータ:
      numTall - 拡大縮小する縦方向のページ数 0は自動を意味します。
      numWide - 拡大縮小する横方向のページ数 0は自動を意味します。

    • setFooterMargin

      public void setFooterMargin(double margin)
      フッダのマージンを取得します。
      パラメータ:
      margin - フッダのマージン 単位はcmです。

    • setHeaderMargin

      public void setHeaderMargin(double margin)
      ヘッダーのマージンを設定します。
      パラメータ:
      margin - ヘッダーのマージン 単位は、cmです。

    • setLeftMargin

      public void setLeftMargin(double margin)
      左のマージンを設定します。
      パラメータ:
      margin - 左のマージン 単位は、cmです。

    • setOrder

      public void setOrder(XlOrder order)
      大きなワークシートの印刷時のページ番号の印刷の順序を設定します。
      パラメータ:
      order - 印刷の順序

    • setOrientation

      public void setOrientation(XlPageOrientation orientation)
      印刷の向きを取得します。
      パラメータ:
      orientation - 印刷の向き

    • setPaperSize

      public void setPaperSize(XlPaperSize paperSize)
      印刷の用紙サイズを設定します。
      パラメータ:
      paperSize - 用紙サイズ

    • setPrintArea

      public void setPrintArea(String A1C1)
      印刷領域を設定します。
      パラメータ:
      A1C1 - 印刷領域(A1C1)

    • setPrintComments

      public void setPrintComments(XlPrintLocation location)
      シートにコメントを印刷する方法を設定します。
      パラメータ:
      location - コメントを印刷する方法

    • setPrintErrors

      public void setPrintErrors(XlPrintErrors errors)

    • setPrintGridlines

      public void setPrintGridlines(boolean apply)
      セルの枠線をページ上に印刷するかどうかを設定します。
      パラメータ:
      apply - true: セルの枠線をページ上に印刷する false: セルの枠線をページ上に印刷しない

    • setPrintHeadings

      public void setPrintHeadings(boolean apply)
      行見出しと列見出しをこのページで印刷するかどうかを設定します。
      パラメータ:
      apply - true 行見出しと列見出しを印刷する false: 行見出しと列見出しを印刷しない

    • setPrintNotes

      public void setPrintNotes(boolean apply)
      セルノートをシートと一緒に終了ノートとして印刷するかどうかを設定します。
      パラメータ:
      apply - true: セルノートを印刷する false: セルノートを印刷しない

    • setHorizontalPrintQuality

      public void setHorizontalPrintQuality(int dpi)
      水平方向のDPIを設定します。
      パラメータ:
      dpi - 水平方向のDPI

    • setVerticalPrintQuality

      public void setVerticalPrintQuality(int dpi)
      垂直方向のDPIを設定します。
      パラメータ:
      dpi - 垂直方向のDPI

    • setPrintTitleColumns

      public void setPrintTitleColumns(int fromCol, int toCol)
      各ページの左側で繰り返されるセルを含む列を設定します。
      パラメータ:
      fromCol - 開始列
      toCol - 終了列

    • setPrintTitleRows

      public void setPrintTitleRows(int fromRow, int toRow)
      各ページの上側で繰り返されるセルを含む行を設定します。
      パラメータ:
      fromRow - 開始行
      toRow - 終了行

    • setRightMargin

      public void setRightMargin(double margin)
      右のマージンを設定します。
      パラメータ:
      margin - 右のマージン 単位は、cmです。

    • setScaleWithDocHeaderFooter

      public void setScaleWithDocHeaderFooter(boolean apply)
      ヘッダとフッタを文書と一緒に拡大縮小するかどうかを設定します。
      パラメータ:
      apply - true: ヘッダとフッタを文書と一緒に拡大縮小する false: ヘッダとフッタを文書と一緒に拡大縮小しない

    • setTopMargin

      public void setTopMargin(double margin)
      上のマージンを設定します。
      パラメータ:
      margin - 上のマージン 単位は、cmです。

    • setZoom

      public void setZoom(int percent)
      ズームを設定します。パーセントにて設定します。
      1. `setFitToPages` は0に設定された状態になります。
      パラメータ:
      percent - ズーム(10～400)。 単位はパーセントです。