Package io.keikai.model.impl
Class PrintSetupImpl
- java.lang.Object
-
- io.keikai.model.impl.PrintSetupImpl
-
- All Implemented Interfaces:
SPrintSetup,Serializable
public class PrintSetupImpl extends Object implements SPrintSetup, Serializable
- Since:
- 3.5.0
- Author:
- Dennis
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.keikai.model.SPrintSetup
SPrintSetup.PaperSize
-
-
Constructor Summary
Constructors Constructor Description PrintSetupImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcopyFrom(PrintSetupImpl src)doublegetBottomMargin()intgetCommentsMode()intgetErrorPrintMode()SFootergetEvenFooter()SHeadergetEvenHeader()SFootergetFirstFooter()SHeadergetFirstHeader()intgetFitHeight()intgetFitWidth()SFootergetFooter()doublegetFooterMargin()SHeadergetHeader()doublegetHeaderMargin()doublegetLeftMargin()intgetPageStart()SPrintSetup.PaperSizegetPaperSize()StringgetPrintArea()CellRegiongetRepeatingColumnsTitle()CellRegiongetRepeatingRowsTitle()doublegetRightMargin()intgetScale()doublegetTopMargin()booleanisAlignWithMargins()booleanisDifferentFirstPage()booleanisDifferentOddEvenPage()booleanisHCenter()booleanisLandscape()booleanisLeftToRight()booleanisPrintGridlines()booleanisPrintHeadings()booleanisScaleWithDoc()booleanisVCenter()voidsetAlignWithMargins(boolean flag)Set true to align header/footer with page margins.voidsetBottomMargin(double bottomMargin)voidsetCommentsMode(int mode)Set how to print comments: 0: none 1: at end of sheet 2: as displayed on the sheetvoidsetDifferentFirstPage(boolean flag)Set true to print first page with special header and footer for first page; {@see #getFirstHeader()} and {@see #getFirstFooter()}.voidsetDifferentOddEvenPage(boolean flag)Set true to print even page with special header and footer for even page; {@see #getEvenHeader()} and {@see #getEvenFooter()}.voidsetErrorPrintMode(int mode)Set how to handle errors in the cell data; 0: print errors as displayed on the sheet 1: print errors as blank 2: print errors as dashes ("--") 3: print errors as "#N/A".voidsetEvenFooter(SFooter footer)Set even page footer; valid only ifSPrintSetup.isDifferentOddEvenPage()is true.voidsetEvenHeader(SHeader header)Set even page footer; valid only ifSPrintSetup.isDifferentOddEvenPage()is true.voidsetFirstFooter(SFooter footer)Set first page footer; valid only ifSPrintSetup.isDifferentFirstPage()is true.voidsetFirstHeader(SHeader header)Set first page footer; valid only ifSPrintSetup.isDifferentFirstPage()is true.voidsetFitHeight(int numPages)Set the number of pages the sheet height is fit to.voidsetFitWidth(int numPages)Set the number of pages the sheet width is fit to.voidsetFooter(SFooter footer)Set general footer or odd page footer.voidsetFooterMargin(double footerMargin)voidsetHCenter(boolean center)Set true to print sheet center horizontally on page.voidsetHeader(SHeader header)Set general Header or odd page header.voidsetHeaderMargin(double headerMargin)voidsetLandscape(boolean landscape)Set true to print in landscape orientation.voidsetLeftMargin(double leftMargin)voidsetLeftToRight(boolean flag)Set true to output multiple pages in the order of left-to-right first and then top-to-bottom; false in the order of top-to-bottom first and then left-to-right.voidsetPageStart(int start)voidsetPaperSize(SPrintSetup.PaperSize size)voidsetPrintArea(String formula)Set the print area as an area formula; e.g.voidsetPrintGridlines(boolean enable)voidsetPrintHeadings(boolean flag)Set true to also out row and column headings.voidsetRepeatingColumnsTitle(int firstCol, int lastCol)Set the first column of the repeat title columns for each left-to-right pages.voidsetRepeatingRowsTitle(int firstRow, int lastRow)Set the first row of the repeat title rows for each top-to-bottom pages.voidsetRightMargin(double rightMargin)voidsetScale(int scale)voidsetScaleWithDoc(boolean flag)Set true to scale header/footer with document.voidsetTopMargin(double topMargin)voidsetVCenter(boolean center)Set true to print sheet center vertically on page.
-
-
-
Method Detail
-
isPrintGridlines
public boolean isPrintGridlines()
- Specified by:
isPrintGridlinesin interfaceSPrintSetup
-
setPrintGridlines
public void setPrintGridlines(boolean enable)
- Specified by:
setPrintGridlinesin interfaceSPrintSetup
-
getHeaderMargin
public double getHeaderMargin()
- Specified by:
getHeaderMarginin interfaceSPrintSetup
-
setHeaderMargin
public void setHeaderMargin(double headerMargin)
- Specified by:
setHeaderMarginin interfaceSPrintSetup
-
getFooterMargin
public double getFooterMargin()
- Specified by:
getFooterMarginin interfaceSPrintSetup
-
setFooterMargin
public void setFooterMargin(double footerMargin)
- Specified by:
setFooterMarginin interfaceSPrintSetup
-
getLeftMargin
public double getLeftMargin()
- Specified by:
getLeftMarginin interfaceSPrintSetup
-
setLeftMargin
public void setLeftMargin(double leftMargin)
- Specified by:
setLeftMarginin interfaceSPrintSetup
-
getRightMargin
public double getRightMargin()
- Specified by:
getRightMarginin interfaceSPrintSetup
-
setRightMargin
public void setRightMargin(double rightMargin)
- Specified by:
setRightMarginin interfaceSPrintSetup
-
getTopMargin
public double getTopMargin()
- Specified by:
getTopMarginin interfaceSPrintSetup
-
setTopMargin
public void setTopMargin(double topMargin)
- Specified by:
setTopMarginin interfaceSPrintSetup
-
getBottomMargin
public double getBottomMargin()
- Specified by:
getBottomMarginin interfaceSPrintSetup
-
setBottomMargin
public void setBottomMargin(double bottomMargin)
- Specified by:
setBottomMarginin interfaceSPrintSetup
-
setPaperSize
public void setPaperSize(SPrintSetup.PaperSize size)
- Specified by:
setPaperSizein interfaceSPrintSetup
-
getPaperSize
public SPrintSetup.PaperSize getPaperSize()
- Specified by:
getPaperSizein interfaceSPrintSetup
-
setLandscape
public void setLandscape(boolean landscape)
Description copied from interface:SPrintSetupSet true to print in landscape orientation.- Specified by:
setLandscapein interfaceSPrintSetup
-
isLandscape
public boolean isLandscape()
- Specified by:
isLandscapein interfaceSPrintSetup
-
setScale
public void setScale(int scale)
- Specified by:
setScalein interfaceSPrintSetup- Parameters:
scale- must be between 10 ~ 400 (inclusive).
-
getScale
public int getScale()
- Specified by:
getScalein interfaceSPrintSetup
-
copyFrom
public void copyFrom(PrintSetupImpl src)
-
setHeader
public void setHeader(SHeader header)
Description copied from interface:SPrintSetupSet general Header or odd page header.- Specified by:
setHeaderin interfaceSPrintSetup
-
getHeader
public SHeader getHeader()
- Specified by:
getHeaderin interfaceSPrintSetup
-
setEvenHeader
public void setEvenHeader(SHeader header)
Description copied from interface:SPrintSetupSet even page footer; valid only ifSPrintSetup.isDifferentOddEvenPage()is true.- Specified by:
setEvenHeaderin interfaceSPrintSetup
-
getEvenHeader
public SHeader getEvenHeader()
- Specified by:
getEvenHeaderin interfaceSPrintSetup
-
setFirstHeader
public void setFirstHeader(SHeader header)
Description copied from interface:SPrintSetupSet first page footer; valid only ifSPrintSetup.isDifferentFirstPage()is true.- Specified by:
setFirstHeaderin interfaceSPrintSetup
-
getFirstHeader
public SHeader getFirstHeader()
- Specified by:
getFirstHeaderin interfaceSPrintSetup
-
setFooter
public void setFooter(SFooter footer)
Description copied from interface:SPrintSetupSet general footer or odd page footer.- Specified by:
setFooterin interfaceSPrintSetup
-
getFooter
public SFooter getFooter()
- Specified by:
getFooterin interfaceSPrintSetup
-
setEvenFooter
public void setEvenFooter(SFooter footer)
Description copied from interface:SPrintSetupSet even page footer; valid only ifSPrintSetup.isDifferentOddEvenPage()is true.- Specified by:
setEvenFooterin interfaceSPrintSetup
-
getEvenFooter
public SFooter getEvenFooter()
- Specified by:
getEvenFooterin interfaceSPrintSetup
-
setFirstFooter
public void setFirstFooter(SFooter footer)
Description copied from interface:SPrintSetupSet first page footer; valid only ifSPrintSetup.isDifferentFirstPage()is true.- Specified by:
setFirstFooterin interfaceSPrintSetup
-
getFirstFooter
public SFooter getFirstFooter()
- Specified by:
getFirstFooterin interfaceSPrintSetup
-
setScaleWithDoc
public void setScaleWithDoc(boolean flag)
Description copied from interface:SPrintSetupSet true to scale header/footer with document.- Specified by:
setScaleWithDocin interfaceSPrintSetup
-
isScaleWithDoc
public boolean isScaleWithDoc()
- Specified by:
isScaleWithDocin interfaceSPrintSetup
-
setAlignWithMargins
public void setAlignWithMargins(boolean flag)
Description copied from interface:SPrintSetupSet true to align header/footer with page margins.- Specified by:
setAlignWithMarginsin interfaceSPrintSetup
-
isAlignWithMargins
public boolean isAlignWithMargins()
- Specified by:
isAlignWithMarginsin interfaceSPrintSetup
-
setHCenter
public void setHCenter(boolean center)
Description copied from interface:SPrintSetupSet true to print sheet center horizontally on page.- Specified by:
setHCenterin interfaceSPrintSetup
-
isHCenter
public boolean isHCenter()
- Specified by:
isHCenterin interfaceSPrintSetup
-
setVCenter
public void setVCenter(boolean center)
Description copied from interface:SPrintSetupSet true to print sheet center vertically on page.- Specified by:
setVCenterin interfaceSPrintSetup
-
isVCenter
public boolean isVCenter()
- Specified by:
isVCenterin interfaceSPrintSetup
-
setPageStart
public void setPageStart(int start)
- Specified by:
setPageStartin interfaceSPrintSetup
-
getPageStart
public int getPageStart()
- Specified by:
getPageStartin interfaceSPrintSetup
-
setFitWidth
public void setFitWidth(int numPages)
Description copied from interface:SPrintSetupSet the number of pages the sheet width is fit to. MUST be less than or equal to 32767. The value 0 means use as many pages as necessary to print the columns in the sheet.- Specified by:
setFitWidthin interfaceSPrintSetup
-
getFitWidth
public int getFitWidth()
- Specified by:
getFitWidthin interfaceSPrintSetup
-
setFitHeight
public void setFitHeight(int numPages)
Description copied from interface:SPrintSetupSet the number of pages the sheet height is fit to. MUST be less than or equal to 32767. The value 0 means use as many pages as necessary to print the rows of the sheet.- Specified by:
setFitHeightin interfaceSPrintSetup
-
getFitHeight
public int getFitHeight()
- Specified by:
getFitHeightin interfaceSPrintSetup
-
setPrintArea
public void setPrintArea(String formula)
Description copied from interface:SPrintSetupSet the print area as an area formula; e.g. A1:B2- Specified by:
setPrintAreain interfaceSPrintSetup
-
getPrintArea
public String getPrintArea()
- Specified by:
getPrintAreain interfaceSPrintSetup
-
setRepeatingRowsTitle
public void setRepeatingRowsTitle(int firstRow, int lastRow)Description copied from interface:SPrintSetupSet the first row of the repeat title rows for each top-to-bottom pages.- Specified by:
setRepeatingRowsTitlein interfaceSPrintSetup
-
getRepeatingRowsTitle
public CellRegion getRepeatingRowsTitle()
- Specified by:
getRepeatingRowsTitlein interfaceSPrintSetup
-
setRepeatingColumnsTitle
public void setRepeatingColumnsTitle(int firstCol, int lastCol)Description copied from interface:SPrintSetupSet the first column of the repeat title columns for each left-to-right pages.- Specified by:
setRepeatingColumnsTitlein interfaceSPrintSetup
-
getRepeatingColumnsTitle
public CellRegion getRepeatingColumnsTitle()
- Specified by:
getRepeatingColumnsTitlein interfaceSPrintSetup
-
setPrintHeadings
public void setPrintHeadings(boolean flag)
Description copied from interface:SPrintSetupSet true to also out row and column headings.- Specified by:
setPrintHeadingsin interfaceSPrintSetup
-
isPrintHeadings
public boolean isPrintHeadings()
- Specified by:
isPrintHeadingsin interfaceSPrintSetup
-
setCommentsMode
public void setCommentsMode(int mode)
Description copied from interface:SPrintSetupSet how to print comments: 0: none 1: at end of sheet 2: as displayed on the sheet- Specified by:
setCommentsModein interfaceSPrintSetup
-
getCommentsMode
public int getCommentsMode()
- Specified by:
getCommentsModein interfaceSPrintSetup
-
setErrorPrintMode
public void setErrorPrintMode(int mode)
Description copied from interface:SPrintSetupSet how to handle errors in the cell data; 0: print errors as displayed on the sheet 1: print errors as blank 2: print errors as dashes ("--") 3: print errors as "#N/A".- Specified by:
setErrorPrintModein interfaceSPrintSetup
-
getErrorPrintMode
public int getErrorPrintMode()
- Specified by:
getErrorPrintModein interfaceSPrintSetup
-
setLeftToRight
public void setLeftToRight(boolean flag)
Description copied from interface:SPrintSetupSet true to output multiple pages in the order of left-to-right first and then top-to-bottom; false in the order of top-to-bottom first and then left-to-right.- Specified by:
setLeftToRightin interfaceSPrintSetup
-
isLeftToRight
public boolean isLeftToRight()
- Specified by:
isLeftToRightin interfaceSPrintSetup
-
setDifferentOddEvenPage
public void setDifferentOddEvenPage(boolean flag)
Description copied from interface:SPrintSetupSet true to print even page with special header and footer for even page; {@see #getEvenHeader()} and {@see #getEvenFooter()}.- Specified by:
setDifferentOddEvenPagein interfaceSPrintSetup
-
isDifferentOddEvenPage
public boolean isDifferentOddEvenPage()
- Specified by:
isDifferentOddEvenPagein interfaceSPrintSetup
-
setDifferentFirstPage
public void setDifferentFirstPage(boolean flag)
Description copied from interface:SPrintSetupSet true to print first page with special header and footer for first page; {@see #getFirstHeader()} and {@see #getFirstFooter()}.- Specified by:
setDifferentFirstPagein interfaceSPrintSetup
-
isDifferentFirstPage
public boolean isDifferentFirstPage()
- Specified by:
isDifferentFirstPagein interfaceSPrintSetup
-
-