public class XSSFPrintSetup extends java.lang.Object implements 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
Modifier | Constructor and Description |
---|---|
protected |
XSSFPrintSetup(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet) |
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.
|
protected XSSFPrintSetup(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet)
public void setPaperSize(short size)
setPaperSize
in interface PrintSetup
size
- the paper size.public void setPaperSize(PaperSize size)
size
- value for the paper size.public void setScale(short scale)
setScale
in interface PrintSetup
scale
- the scale to usepublic void setPageStart(short start)
setPageStart
in interface PrintSetup
start
- the page numbering startpublic void setFitWidth(short width)
setFitWidth
in interface PrintSetup
width
- the number of pagespublic void setFitHeight(short height)
setFitHeight
in interface PrintSetup
height
- the number of pagespublic void setLeftToRight(boolean leftToRight)
setLeftToRight
in interface PrintSetup
leftToRight
- left to rightpublic void setLandscape(boolean ls)
setLandscape
in interface PrintSetup
ls
- landscapepublic void setValidSettings(boolean valid)
setValidSettings
in interface PrintSetup
valid
- Validpublic void setNoColor(boolean mono)
setNoColor
in interface PrintSetup
mono
- Black and whitepublic void setDraft(boolean d)
setDraft
in interface PrintSetup
d
- draftpublic void setNotes(boolean printNotes)
setNotes
in interface PrintSetup
printNotes
- print the notespublic void setNoOrientation(boolean orientation)
setNoOrientation
in interface PrintSetup
orientation
- Orientation.public void setUsePage(boolean page)
setUsePage
in interface PrintSetup
page
- Use page startpublic void setHResolution(short resolution)
setHResolution
in interface PrintSetup
resolution
- horizontal resolutionpublic void setVResolution(short resolution)
setVResolution
in interface PrintSetup
resolution
- vertical resolutionpublic void setHeaderMargin(double headerMargin)
setHeaderMargin
in interface PrintSetup
headerMargin
- header marginpublic void setFooterMargin(double footerMargin)
setFooterMargin
in interface PrintSetup
footerMargin
- footer marginpublic void setCopies(short copies)
setCopies
in interface PrintSetup
copies
- number of copiespublic void setOrientation(PrintOrientation orientation)
orientation
- - Orientation of the pagePrintOrientation
public PrintOrientation getOrientation()
PrintOrientation
public PrintCellComments getCellComment()
public void setPageOrder(PageOrder pageOrder)
pageOrder
- An enum indicating the wanted ordering of printed pagespublic PageOrder getPageOrder()
public short getPaperSize()
getPaperSize
in interface PrintSetup
public PaperSize getPaperSizeEnum()
PaperSize
public short getScale()
getScale
in interface PrintSetup
public short getPageStart()
getPageStart
in interface PrintSetup
public short getFitWidth()
getFitWidth
in interface PrintSetup
public short getFitHeight()
getFitHeight
in interface PrintSetup
public boolean getLeftToRight()
getLeftToRight
in interface PrintSetup
public boolean getLandscape()
getLandscape
in interface PrintSetup
public boolean getValidSettings()
getValidSettings
in interface PrintSetup
public boolean getNoColor()
getNoColor
in interface PrintSetup
public boolean getDraft()
getDraft
in interface PrintSetup
public boolean getNotes()
getNotes
in interface PrintSetup
public boolean getNoOrientation()
getNoOrientation
in interface PrintSetup
public boolean getUsePage()
getUsePage
in interface PrintSetup
public short getHResolution()
getHResolution
in interface PrintSetup
public short getVResolution()
getVResolution
in interface PrintSetup
public double getHeaderMargin()
getHeaderMargin
in interface PrintSetup
public double getFooterMargin()
getFooterMargin
in interface PrintSetup
public short getCopies()
getCopies
in interface PrintSetup
public void setTopMargin(double topMargin)
topMargin
- top marginpublic double getTopMargin()
public void setBottomMargin(double bottomMargin)
bottomMargin
- bottom marginpublic double getBottomMargin()
public void setLeftMargin(double leftMargin)
leftMargin
- left marginpublic double getLeftMargin()
public void setRightMargin(double rightMargin)
rightMargin
- right marginpublic double getRightMargin()
Copyright 2020 The Apache Software Foundation or its licensors, as applicable.