XSSFPrintSetup (POI API Documentation)

java.lang.Object
- org.apache.poi.xssf.usermodel.XSSFPrintSetup

All Implemented Interfaces:

PrintSetup
```
public class XSSFPrintSetup
extends java.lang.Object
implements PrintSetup
```
Page setup and page margins settings for the worksheet. (工作表的页面设置和页边距设置。)

Field Summary
- Fields inherited from interface org.apache.poi.ss.usermodel.PrintSetup
  A3_PAPERSIZE, A4_EXTRA_PAPERSIZE, A4_PAPERSIZE, A4_PLUS_PAPERSIZE, A4_ROTATED_PAPERSIZE, A4_SMALL_PAPERSIZE, A4_TRANSVERSE_PAPERSIZE, A5_PAPERSIZE, B4_PAPERSIZE, B5_PAPERSIZE, ELEVEN_BY_SEVENTEEN_PAPERSIZE, ENVELOPE_10_PAPERSIZE, ENVELOPE_9_PAPERSIZE, ENVELOPE_C3_PAPERSIZE, ENVELOPE_C4_PAPERSIZE, ENVELOPE_C5_PAPERSIZE, ENVELOPE_C6_PAPERSIZE, ENVELOPE_CS_PAPERSIZE, ENVELOPE_DL_PAPERSIZE, ENVELOPE_MONARCH_PAPERSIZE, EXECUTIVE_PAPERSIZE, FOLIO8_PAPERSIZE, LEDGER_PAPERSIZE, LEGAL_PAPERSIZE, LETTER_PAPERSIZE, LETTER_ROTATED_PAPERSIZE, LETTER_SMALL_PAGESIZE, NOTE8_PAPERSIZE, PRINTER_DEFAULT_PAPERSIZE, QUARTO_PAPERSIZE, STATEMENT_PAPERSIZE, TABLOID_PAPERSIZE, TEN_BY_FOURTEEN_PAPERSIZE

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`XSSFPrintSetup(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getBottomMargin()` Returns the bottom margin. (返回下边距。)
`PrintCellComments`	`getCellComment()`
`short`	`getCopies()` Returns the number of copies. (返回份数。)
`boolean`	`getDraft()` Returns the draft mode. (返回草稿模式。)
`short`	`getFitHeight()` Returns the number of pages high to fit the sheet in. (返回适合工作表的页数。)
`short`	`getFitWidth()` Returns the number of pages wide to fit sheet in. (返回适合工作表的页数。)
`double`	`getFooterMargin()` Returns the footer margin. (返回页脚边距。)
`double`	`getHeaderMargin()` Returns the header margin. (返回页眉边距。)
`short`	`getHResolution()` Returns the horizontal resolution. (返回水平分辨率。)
`boolean`	`getLandscape()` Returns the landscape mode. (返回横向模式。)
`double`	`getLeftMargin()` Returns the left margin. (返回左边距。)
`boolean`	`getLeftToRight()` Returns the left to right print order. (返回从左到右的打印顺序。)
`boolean`	`getNoColor()` Returns the black and white setting. (返回黑白设置。)
`boolean`	`getNoOrientation()` Returns the no orientation. (返回无方向。)
`boolean`	`getNotes()` Returns the print notes. (返回打印注释。)
`PrintOrientation`	`getOrientation()` Orientation of the page: landscape - portrait. (页面方向：横向 - 纵向。)
`PageOrder`	`getPageOrder()` get print page order. (获取打印页面顺序。)
`short`	`getPageStart()` Set the page numbering start. (设置页码开始。)
`short`	`getPaperSize()` Returns the paper size. (返回纸张尺寸。)
`PaperSize`	`getPaperSizeEnum()` Returns the paper size as enum. (以枚举形式返回纸张大小。)
`double`	`getRightMargin()` Returns the right margin. (返回右边距。)
`short`	`getScale()` Returns the scale. (返回比例。)
`double`	`getTopMargin()` Returns the top margin. (返回上边距。)
`boolean`	`getUsePage()` Returns the use page numbers. (返回使用页码。)
`boolean`	`getValidSettings()` Use the printer's defaults settings for page setup values and don't use the default values specified in the schema. (对页面设置值使用打印机的默认设置，不要使用架构中指定的默认值。)
`short`	`getVResolution()` Returns the vertical resolution. (返回垂直分辨率。)
`void`	`setBottomMargin(double bottomMargin)` Sets the bottom margin. (设置下边距。)
`void`	`setCopies(short copies)` Sets the number of copies. (设置份数。)
`void`	`setDraft(boolean d)` Set whether it is in draft mode (设置是否处于草稿模式)
`void`	`setFitHeight(short height)` Set the number of pages high to fit the sheet in (将页数设置为高以适合纸张)
`void`	`setFitWidth(short width)` Set the number of pages wide to fit the sheet in (设置页数以适合纸张)
`void`	`setFooterMargin(double footerMargin)` Sets the footer margin. (设置页脚边距。)
`void`	`setHeaderMargin(double headerMargin)` Sets the header margin. (设置页眉边距。)
`void`	`setHResolution(short resolution)` Sets the horizontal resolution. (设置水平分辨率。)
`void`	`setLandscape(boolean ls)` Set whether to print in landscape (设置是否横向打印)
`void`	`setLeftMargin(double leftMargin)` Sets the left margin. (设置左边距。)
`void`	`setLeftToRight(boolean leftToRight)` Set whether to go left to right or top down in ordering (设置顺序是从左到右还是自上而下)
`void`	`setNoColor(boolean mono)` Set whether it is black and white (设置是否为黑白)
`void`	`setNoOrientation(boolean orientation)` Set no orientation. (不设置方向。)
`void`	`setNotes(boolean printNotes)` Print the include notes (打印包含注释)
`void`	`setOrientation(PrintOrientation orientation)` Orientation of the page: landscape - portrait. (页面方向：横向 - 纵向。)
`void`	`setPageOrder(PageOrder pageOrder)` Set print page order. (设置打印页面顺序。)
`void`	`setPageStart(short start)` Set the page numbering start. (设置页码开始。)
`void`	`setPaperSize(PaperSize size)` Set the paper size as enum value. (将纸张大小设置为枚举值。)
`void`	`setPaperSize(short size)` Set the paper size. (设置纸张尺寸。)
`void`	`setRightMargin(double rightMargin)` Sets the right margin. (设置右边距。)
`void`	`setScale(short scale)` Set the scale. (设置比例。)
`void`	`setTopMargin(double topMargin)` Sets the top margin. (设置上边距。)
`void`	`setUsePage(boolean page)` Set whether to use page start (设置是否使用页面启动)
`void`	`setValidSettings(boolean valid)` Use the printer's defaults settings for page setup values and don't use the default values specified in the schema. (对页面设置值使用打印机的默认设置，不要使用架构中指定的默认值。)
`void`	`setVResolution(short resolution)` Sets the vertical resolution. (设置垂直分辨率。)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XSSFPrintSetup
```
protected XSSFPrintSetup(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet)
```
- Method Detail
  - setPaperSize
```
public void setPaperSize(short size)
```
    Set the paper size. (设置纸张尺寸。)
    
    Specified by:
    
    setPaperSize in interface PrintSetup (接口 PrintSetup 中的 setPaperSize)
    
    Parameters:
    
    size - the paper size. (size - 纸张大小。)
  - setPaperSize
```
public void setPaperSize(PaperSize size)
```
    Set the paper size as enum value. (将纸张大小设置为枚举值。)
    
    Parameters:
    
    size - value for the paper size. (size - 纸张尺寸的值。)
  - setScale
```
public void setScale(short scale)
```
    Set the scale. Valid values range from 10 to 400. This setting is overridden when fitToWidth and/or fitToHeight are in use (设置比例。有效值范围为 10 到 400。当使用 fitToWidth 和/或 fitToHeight 时，此设置将被覆盖)
    
    Specified by:
    
    setScale in interface PrintSetup (接口 PrintSetup 中的 setScale)
    
    Parameters:
    
    scale - the scale to use (scale - 要使用的比例)
  - setPageStart
```
public void setPageStart(short start)
```
    Set the page numbering start. Page number for first printed page. If no value is specified, then 'automatic' is assumed. (设置页码开始。第一个打印页的页码。如果未指定任何值，则假定为“自动”。)
    
    Specified by:
    
    setPageStart in interface PrintSetup (接口 PrintSetup 中的 setPageStart)
    
    Parameters:
    
    start - the page numbering start (start - 页码开始)
  - setFitWidth
```
public void setFitWidth(short width)
```
    Set the number of pages wide to fit the sheet in (设置页数以适合纸张)
    
    Specified by:
    
    setFitWidth in interface PrintSetup (接口 PrintSetup 中的 setFitWidth)
    
    Parameters:
    
    width - the number of pages (宽度 - 页数)
  - setFitHeight
```
public void setFitHeight(short height)
```
    Set the number of pages high to fit the sheet in (将页数设置为高以适合纸张)
    
    Specified by:
    
    setFitHeight in interface PrintSetup (接口 PrintSetup 中的 setFitHeight)
    
    Parameters:
    
    height - the number of pages (高度 - 页数)
  - setLeftToRight
```
public void setLeftToRight(boolean leftToRight)
```
    Set whether to go left to right or top down in ordering (设置顺序是从左到右还是自上而下)
    
    Specified by:
    
    setLeftToRight in interface PrintSetup (接口 PrintSetup 中的 setLeftToRight)
    
    Parameters:
    
    leftToRight - left to right (leftToRight - 从左到右)
  - setLandscape
```
public void setLandscape(boolean ls)
```
    Set whether to print in landscape (设置是否横向打印)
    
    Specified by:
    
    setLandscape in interface PrintSetup (PrintSetup 界面中的 setLandscape)
    
    Parameters:
    
    ls - landscape (ls - 风景)
  - setValidSettings
```
public void setValidSettings(boolean valid)
```
    Use the printer's defaults settings for page setup values and don't use the default values specified in the schema. For example, if dpi is not present or specified in the XML, the application shall not assume 600dpi as specified in the schema as a default and instead shall let the printer specify the default dpi. (对页面设置值使用打印机的默认设置，不要使用架构中指定的默认值。例如，如果 XML 中不存在或未指定 dpi，则应用程序不应假定模式中指定的 600dpi 作为默认值，而是应让打印机指定默认 dpi。)
    
    Specified by:
    
    setValidSettings in interface PrintSetup (接口 PrintSetup 中的 setValidSettings)
    
    Parameters:
    
    valid - Valid (有效 - 有效)
  - setNoColor
```
public void setNoColor(boolean mono)
```
    Set whether it is black and white (设置是否为黑白)
    
    Specified by:
    
    setNoColor in interface PrintSetup (接口 PrintSetup 中的 setNoColor)
    
    Parameters:
    
    mono - Black and white (单色 - 黑白)
  - setDraft
```
public void setDraft(boolean d)
```
    Set whether it is in draft mode (设置是否处于草稿模式)
    
    Specified by:
    
    setDraft in interface PrintSetup (接口 PrintSetup 中的 setDraft)
    
    Parameters:
    
    d - draft (d - 草稿)
  - setNotes
```
public void setNotes(boolean printNotes)
```
    Print the include notes (打印包含注释)
    
    Specified by:
    
    setNotes in interface PrintSetup (接口 PrintSetup 中的 setNotes)
    
    Parameters:
    
    printNotes - print the notes (printNotes - 打印笔记)
  - setNoOrientation
```
public void setNoOrientation(boolean orientation)
```
    Set no orientation. (不设置方向。)
    
    Specified by:
    
    setNoOrientation in interface PrintSetup (接口 PrintSetup 中的 setNoOrientation)
    
    Parameters:
    
    orientation - Orientation. (方向 - 方向。)
  - setUsePage
```
public void setUsePage(boolean page)
```
    Set whether to use page start (设置是否使用页面启动)
    
    Specified by:
    
    setUsePage in interface PrintSetup (接口 PrintSetup 中的 setUsePage)
    
    Parameters:
    
    page - Use page start (page - 使用页面开始)
  - setHResolution
```
public void setHResolution(short resolution)
```
    Sets the horizontal resolution. (设置水平分辨率。)
    
    Specified by:
    
    setHResolution in interface PrintSetup (PrintSetup 界面中的 setHResolution)
    
    Parameters:
    
    resolution - horizontal resolution (分辨率 - 水平分辨率)
  - setVResolution
```
public void setVResolution(short resolution)
```
    Sets the vertical resolution. (设置垂直分辨率。)
    
    Specified by:
    
    setVResolution in interface PrintSetup (接口 PrintSetup 中的 setVResolution)
    
    Parameters:
    
    resolution - vertical resolution (分辨率 - 垂直分辨率)
  - setHeaderMargin
```
public void setHeaderMargin(double headerMargin)
```
    Sets the header margin. (设置页眉边距。)
    
    Specified by:
    
    setHeaderMargin in interface PrintSetup (接口 PrintSetup 中的 setHeaderMargin)
    
    Parameters:
    
    headerMargin - header margin (headerMargin - 标题页边距)
  - setFooterMargin
```
public void setFooterMargin(double footerMargin)
```
    Sets the footer margin. (设置页脚边距。)
    
    Specified by:
    
    setFooterMargin in interface PrintSetup (接口 PrintSetup 中的 setFooterMargin)
    
    Parameters:
    
    footerMargin - footer margin (footerMargin - 页脚边距)
  - setCopies
```
public void setCopies(short copies)
```
    Sets the number of copies. (设置份数。)
    
    Specified by:
    
    setCopies in interface PrintSetup (接口 PrintSetup 中的 setCopies)
    
    Parameters:
    
    copies - number of copies (份数 - 份数)
  - setOrientation
```
public void setOrientation(PrintOrientation orientation)
```
    Orientation of the page: landscape - portrait. (页面方向：横向 - 纵向。)
    
    Parameters:
    
    orientation - - Orientation of the page (方向 - - 页面的方向)
    
    See Also:
    
    PrintOrientation
  - getOrientation
```
public PrintOrientation getOrientation()
```
    Orientation of the page: landscape - portrait. (页面方向：横向 - 纵向。)
    
    Returns:
    
    Orientation of the page (页面方向)
    
    See Also:
    
    PrintOrientation
  - getCellComment
```
public PrintCellComments getCellComment()
```
  - setPageOrder
```
public void setPageOrder(PageOrder pageOrder)
```
    Set print page order. (设置打印页面顺序。)
    
    Parameters:
    
    pageOrder - An enum indicating the wanted ordering of printed pages (pageOrder - 一个枚举，指示打印页面的所需顺序)
  - getPageOrder
```
public PageOrder getPageOrder()
```
    get print page order. (获取打印页面顺序。)
    
    Returns:
    
    The currently set ordering of printed pages (当前设置的打印页面顺序)
  - getPaperSize
```
public short getPaperSize()
```
    Returns the paper size. (返回纸张尺寸。)
    
    Specified by:
    
    getPaperSize in interface PrintSetup (接口 PrintSetup 中的 getPaperSize)
    
    Returns:
    
    short - paper size (短纸张尺寸)
  - getPaperSizeEnum
```
public PaperSize getPaperSizeEnum()
```
    Returns the paper size as enum. (以枚举形式返回纸张大小。)
    
    Returns:
    
    PaperSize paper size (PaperSize 纸张尺寸)
    
    See Also:
    
    PaperSize
  - getScale
```
public short getScale()
```
    Returns the scale. (返回比例。)
    
    Specified by:
    
    getScale in interface PrintSetup (接口 PrintSetup 中的 getScale)
    
    Returns:
    
    short - scale (小规模)
  - getPageStart
```
public short getPageStart()
```
    Set the page numbering start. Page number for first printed page. If no value is specified, then 'automatic' is assumed. (设置页码开始。第一个打印页的页码。如果未指定任何值，则假定为“自动”。)
    
    Specified by:
    
    getPageStart in interface PrintSetup (接口 PrintSetup 中的 getPageStart)
    
    Returns:
    
    page number for first printed page (第一个打印页的页码)
  - getFitWidth
```
public short getFitWidth()
```
    Returns the number of pages wide to fit sheet in. (返回适合工作表的页数。)
    
    Specified by:
    
    getFitWidth in interface PrintSetup (接口 PrintSetup 中的 getFitWidth)
    
    Returns:
    
    number of pages wide to fit sheet in (适合纸张的页数)
  - getFitHeight
```
public short getFitHeight()
```
    Returns the number of pages high to fit the sheet in. (返回适合工作表的页数。)
    
    Specified by:
    
    getFitHeight in interface PrintSetup (接口 PrintSetup 中的 getFitHeight)
    
    Returns:
    
    number of pages high to fit the sheet in (适合工作表的页数)
  - getLeftToRight
```
public boolean getLeftToRight()
```
    Returns the left to right print order. (返回从左到右的打印顺序。)
    
    Specified by:
    
    getLeftToRight in interface PrintSetup (接口 PrintSetup 中的 getLeftToRight)
    
    Returns:
    
    left to right print order (从左到右的打印顺序)
  - getLandscape
```
public boolean getLandscape()
```
    Returns the landscape mode. (返回横向模式。)
    
    Specified by:
    
    getLandscape in interface PrintSetup (接口 PrintSetup 中的 getLandscape)
    
    Returns:
    
    landscape mode (横向模式)
  - getValidSettings
```
public boolean getValidSettings()
```
    Use the printer's defaults settings for page setup values and don't use the default values specified in the schema. For example, if dpi is not present or specified in the XML, the application shall not assume 600dpi as specified in the schema as a default and instead shall let the printer specify the default dpi. (对页面设置值使用打印机的默认设置，不要使用架构中指定的默认值。例如，如果 XML 中不存在或未指定 dpi，则应用程序不应假定模式中指定的 600dpi 作为默认值，而是应让打印机指定默认 dpi。)
    
    Specified by:
    
    getValidSettings in interface PrintSetup (接口 PrintSetup 中的 getValidSettings)
    
    Returns:
    
    valid settings (有效设置)
  - getNoColor
```
public boolean getNoColor()
```
    Returns the black and white setting. (返回黑白设置。)
    
    Specified by:
    
    getNoColor in interface PrintSetup (接口 PrintSetup 中的 getNoColor)
    
    Returns:
    
    black and white setting (黑白设置)
  - getDraft
```
public boolean getDraft()
```
    Returns the draft mode. (返回草稿模式。)
    
    Specified by:
    
    getDraft in interface PrintSetup (接口 PrintSetup 中的 getDraft)
    
    Returns:
    
    draft mode (草稿模式)
  - getNotes
```
public boolean getNotes()
```
    Returns the print notes. (返回打印注释。)
    
    Specified by:
    
    getNotes in interface PrintSetup (接口 PrintSetup 中的 getNotes)
    
    Returns:
    
    print notes (打印笔记)
  - getNoOrientation
```
public boolean getNoOrientation()
```
    Returns the no orientation. (返回无方向。)
    
    Specified by:
    
    getNoOrientation in interface PrintSetup (接口 PrintSetup 中的 getNoOrientation)
    
    Returns:
    
    no orientation (没有方向)
  - getUsePage
```
public boolean getUsePage()
```
    Returns the use page numbers. (返回使用页码。)
    
    Specified by:
    
    getUsePage in interface PrintSetup (接口 PrintSetup 中的 getUsePage)
    
    Returns:
    
    use page numbers (使用页码)
  - getHResolution
```
public short getHResolution()
```
    Returns the horizontal resolution. (返回水平分辨率。)
    
    Specified by:
    
    getHResolution in interface PrintSetup (接口 PrintSetup 中的 getHResolution)
    
    Returns:
    
    horizontal resolution (水平分辨率)
  - getVResolution
```
public short getVResolution()
```
    Returns the vertical resolution. (返回垂直分辨率。)
    
    Specified by:
    
    getVResolution in interface PrintSetup (接口 PrintSetup 中的 getVResolution)
    
    Returns:
    
    vertical resolution (垂直分辨率)
  - getHeaderMargin
```
public double getHeaderMargin()
```
    Returns the header margin. (返回页眉边距。)
    
    Specified by:
    
    getHeaderMargin in interface PrintSetup (接口 PrintSetup 中的 getHeaderMargin)
    
    Returns:
    
    header margin (页眉边距)
  - getFooterMargin
```
public double getFooterMargin()
```
    Returns the footer margin. (返回页脚边距。)
    
    Specified by:
    
    getFooterMargin in interface PrintSetup (接口 PrintSetup 中的 getFooterMargin)
    
    Returns:
    
    footer margin (页脚边距)
  - getCopies
```
public short getCopies()
```
    Returns the number of copies. (返回份数。)
    
    Specified by:
    
    getCopies in interface PrintSetup (接口 PrintSetup 中的 getCopies)
    
    Returns:
    
    number of copies (复印数量)
  - setTopMargin
```
public void setTopMargin(double topMargin)
```
    Sets the top margin. (设置上边距。)
    
    Parameters:
    
    topMargin - top margin (topMargin - 上边距)
  - getTopMargin
```
public double getTopMargin()
```
    Returns the top margin. (返回上边距。)
    
    Returns:
    
    top margin (上边距)
  - setBottomMargin
```
public void setBottomMargin(double bottomMargin)
```
    Sets the bottom margin. (设置下边距。)
    
    Parameters:
    
    bottomMargin - bottom margin (bottomMargin - 下边距)
  - getBottomMargin
```
public double getBottomMargin()
```
    Returns the bottom margin. (返回下边距。)
    
    Returns:
    
    bottom margin (下边距)
  - setLeftMargin
```
public void setLeftMargin(double leftMargin)
```
    Sets the left margin. (设置左边距。)
    
    Parameters:
    
    leftMargin - left margin (leftMargin - 左边距)
  - getLeftMargin
```
public double getLeftMargin()
```
    Returns the left margin. (返回左边距。)
    
    Returns:
    
    left margin (左边距)
  - setRightMargin
```
public void setRightMargin(double rightMargin)
```
    Sets the right margin. (设置右边距。)
    
    Parameters:
    
    rightMargin - right margin (rightMargin - 右边距)
  - getRightMargin
```
public double getRightMargin()
```
    Returns the right margin. (返回右边距。)
    
    Returns:
    
    right margin (右边距)

Class XSSFPrintSetup

Field Summary

Fields inherited from interface org.apache.poi.ss.usermodel.PrintSetup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XSSFPrintSetup

Method Detail

setPaperSize

setPaperSize

setScale

setPageStart

setFitWidth

setFitHeight

setLeftToRight

setLandscape

setValidSettings

setNoColor

setDraft

setNotes

setNoOrientation

setUsePage

setHResolution

setVResolution

setHeaderMargin

setFooterMargin

setCopies

setOrientation

getOrientation

getCellComment

setPageOrder

getPageOrder

getPaperSize

getPaperSizeEnum

getScale

getPageStart

getFitWidth

getFitHeight

getLeftToRight

getLandscape

getValidSettings

getNoColor

getDraft

getNotes

getNoOrientation

getUsePage

getHResolution

getVResolution

getHeaderMargin

getFooterMargin

getCopies

setTopMargin

getTopMargin

setBottomMargin

getBottomMargin

setLeftMargin

getLeftMargin

setRightMargin

getRightMargin