Package org.apache.poi.ss.usermodel
Interface PrintSetup
-
- All Known Implementing Classes:
HSSFPrintSetup
public interface PrintSetup
-
-
Field Summary
Fields Modifier and Type Field Description static shortA3_PAPERSIZEA3 - 297x420 mmstatic shortA4_EXTRA_PAPERSIZEA4 Extra - 9.27 x 12.69 instatic shortA4_PAPERSIZEA4 - 210x297 mmstatic shortA4_PLUS_PAPERSIZEA4 Plus - 210x330 mmstatic shortA4_ROTATED_PAPERSIZEA4 Rotated - 297x210 mmstatic shortA4_SMALL_PAPERSIZEA4 Small - 210x297 mmstatic shortA4_TRANSVERSE_PAPERSIZEA4 Transverse - 210x297 mmstatic shortA5_PAPERSIZEA5 - 148x210 mmstatic shortB4_PAPERSIZEB4 (JIS) 250x354 mmstatic shortB5_PAPERSIZEB5 (JIS) 182x257 mmstatic shortELEVEN_BY_SEVENTEEN_PAPERSIZE11 x 17 instatic shortENVELOPE_10_PAPERSIZEUS Envelope #10 4 1/8 x 9 1/2static shortENVELOPE_9_PAPERSIZEUS Envelope #9 3 7/8 x 8 7/8static shortENVELOPE_C3_PAPERSIZEEnvelope C3 324x458 mmstatic shortENVELOPE_C4_PAPERSIZEEnvelope C4 229x324 mmstatic shortENVELOPE_C5_PAPERSIZEstatic shortENVELOPE_C6_PAPERSIZEEnvelope C6 114x162 mmstatic shortENVELOPE_CS_PAPERSIZEEnvelope C5 162x229 mmstatic shortENVELOPE_DL_PAPERSIZEEnvelope DL 110x220 mmstatic shortENVELOPE_MONARCH_PAPERSIZEstatic shortEXECUTIVE_PAPERSIZEUS Executive 7 1/4 x 10 1/2 instatic shortFOLIO8_PAPERSIZEFolio 8 1/2 x 13 instatic shortLEDGER_PAPERSIZEUS Ledger 17 x 11 instatic shortLEGAL_PAPERSIZEUS Legal 8 1/2 x 14 instatic shortLETTER_PAPERSIZEUS Letter 8 1/2 x 11 instatic shortLETTER_ROTATED_PAPERSIZEUS Letter Rotated 11 x 8 1/2 instatic shortLETTER_SMALL_PAGESIZEUS Letter Small 8 1/2 x 11 instatic shortNOTE8_PAPERSIZEUS Note 8 1/2 x 11 instatic shortPRINTER_DEFAULT_PAPERSIZEWhatever the printer's default paper size isstatic shortQUARTO_PAPERSIZEQuarto 215x275 mmstatic shortSTATEMENT_PAPERSIZEUS Statement 5 1/2 x 8 1/2 instatic shortTABLOID_PAPERSIZEUS Tabloid 11 x 17 instatic shortTEN_BY_FOURTEEN_PAPERSIZE10 x 14 in
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description shortgetCopies()Returns the number of copies.booleangetDraft()Returns the draft mode.shortgetFitHeight()Returns the number of pages high to fit the sheet in.shortgetFitWidth()Returns the number of pages wide to fit sheet in.doublegetFooterMargin()Returns the footer margin.doublegetHeaderMargin()Returns the header margin.shortgetHResolution()Returns the horizontal resolution.booleangetLandscape()Returns the landscape mode.booleangetLeftToRight()Returns the left to right print order.booleangetNoColor()Returns the black and white setting.booleangetNoOrientation()Returns the no orientation.booleangetNotes()Returns the print notes.shortgetPageStart()Returns the page start.shortgetPaperSize()Returns the paper size.shortgetScale()Returns the scale.booleangetUsePage()Returns the use page numbers.booleangetValidSettings()Returns the valid settings.shortgetVResolution()Returns the vertical resolution.voidsetCopies(short copies)Sets the number of copies.voidsetDraft(boolean d)Set whether it is in draft modevoidsetFitHeight(short height)Set the number of pages high to fit the sheet invoidsetFitWidth(short width)Set the number of pages wide to fit the sheet invoidsetFooterMargin(double footermargin)Sets the footer margin.voidsetHeaderMargin(double headermargin)Sets the header margin.voidsetHResolution(short resolution)Sets the horizontal resolution.voidsetLandscape(boolean ls)Set whether to print in landscapevoidsetLeftToRight(boolean ltor)Set whether to go left to right or top down in orderingvoidsetNoColor(boolean mono)Set whether it is black and whitevoidsetNoOrientation(boolean orientation)Set no orientation.voidsetNotes(boolean printnotes)Print the include notesvoidsetPageStart(short start)Set the page numbering start.voidsetPaperSize(short size)Set the paper size.voidsetScale(short scale)Set the scale.voidsetUsePage(boolean page)Set whether to use page startvoidsetValidSettings(boolean valid)Valid settings.voidsetVResolution(short resolution)Sets the vertical resolution.
-
-
-
Field Detail
-
PRINTER_DEFAULT_PAPERSIZE
static final short PRINTER_DEFAULT_PAPERSIZE
Whatever the printer's default paper size is- See Also:
- Constant Field Values
-
LETTER_PAPERSIZE
static final short LETTER_PAPERSIZE
US Letter 8 1/2 x 11 in- See Also:
- Constant Field Values
-
LETTER_SMALL_PAGESIZE
static final short LETTER_SMALL_PAGESIZE
US Letter Small 8 1/2 x 11 in- See Also:
- Constant Field Values
-
TABLOID_PAPERSIZE
static final short TABLOID_PAPERSIZE
US Tabloid 11 x 17 in- See Also:
- Constant Field Values
-
LEDGER_PAPERSIZE
static final short LEDGER_PAPERSIZE
US Ledger 17 x 11 in- See Also:
- Constant Field Values
-
LEGAL_PAPERSIZE
static final short LEGAL_PAPERSIZE
US Legal 8 1/2 x 14 in- See Also:
- Constant Field Values
-
STATEMENT_PAPERSIZE
static final short STATEMENT_PAPERSIZE
US Statement 5 1/2 x 8 1/2 in- See Also:
- Constant Field Values
-
EXECUTIVE_PAPERSIZE
static final short EXECUTIVE_PAPERSIZE
US Executive 7 1/4 x 10 1/2 in- See Also:
- Constant Field Values
-
A3_PAPERSIZE
static final short A3_PAPERSIZE
A3 - 297x420 mm- See Also:
- Constant Field Values
-
A4_PAPERSIZE
static final short A4_PAPERSIZE
A4 - 210x297 mm- See Also:
- Constant Field Values
-
A4_SMALL_PAPERSIZE
static final short A4_SMALL_PAPERSIZE
A4 Small - 210x297 mm- See Also:
- Constant Field Values
-
A5_PAPERSIZE
static final short A5_PAPERSIZE
A5 - 148x210 mm- See Also:
- Constant Field Values
-
B4_PAPERSIZE
static final short B4_PAPERSIZE
B4 (JIS) 250x354 mm- See Also:
- Constant Field Values
-
B5_PAPERSIZE
static final short B5_PAPERSIZE
B5 (JIS) 182x257 mm- See Also:
- Constant Field Values
-
FOLIO8_PAPERSIZE
static final short FOLIO8_PAPERSIZE
Folio 8 1/2 x 13 in- See Also:
- Constant Field Values
-
QUARTO_PAPERSIZE
static final short QUARTO_PAPERSIZE
Quarto 215x275 mm- See Also:
- Constant Field Values
-
TEN_BY_FOURTEEN_PAPERSIZE
static final short TEN_BY_FOURTEEN_PAPERSIZE
10 x 14 in- See Also:
- Constant Field Values
-
ELEVEN_BY_SEVENTEEN_PAPERSIZE
static final short ELEVEN_BY_SEVENTEEN_PAPERSIZE
11 x 17 in- See Also:
- Constant Field Values
-
NOTE8_PAPERSIZE
static final short NOTE8_PAPERSIZE
US Note 8 1/2 x 11 in- See Also:
- Constant Field Values
-
ENVELOPE_9_PAPERSIZE
static final short ENVELOPE_9_PAPERSIZE
US Envelope #9 3 7/8 x 8 7/8- See Also:
- Constant Field Values
-
ENVELOPE_10_PAPERSIZE
static final short ENVELOPE_10_PAPERSIZE
US Envelope #10 4 1/8 x 9 1/2- See Also:
- Constant Field Values
-
ENVELOPE_DL_PAPERSIZE
static final short ENVELOPE_DL_PAPERSIZE
Envelope DL 110x220 mm- See Also:
- Constant Field Values
-
ENVELOPE_CS_PAPERSIZE
static final short ENVELOPE_CS_PAPERSIZE
Envelope C5 162x229 mm- See Also:
- Constant Field Values
-
ENVELOPE_C5_PAPERSIZE
static final short ENVELOPE_C5_PAPERSIZE
- See Also:
- Constant Field Values
-
ENVELOPE_C3_PAPERSIZE
static final short ENVELOPE_C3_PAPERSIZE
Envelope C3 324x458 mm- See Also:
- Constant Field Values
-
ENVELOPE_C4_PAPERSIZE
static final short ENVELOPE_C4_PAPERSIZE
Envelope C4 229x324 mm- See Also:
- Constant Field Values
-
ENVELOPE_C6_PAPERSIZE
static final short ENVELOPE_C6_PAPERSIZE
Envelope C6 114x162 mm- See Also:
- Constant Field Values
-
ENVELOPE_MONARCH_PAPERSIZE
static final short ENVELOPE_MONARCH_PAPERSIZE
- See Also:
- Constant Field Values
-
A4_EXTRA_PAPERSIZE
static final short A4_EXTRA_PAPERSIZE
A4 Extra - 9.27 x 12.69 in- See Also:
- Constant Field Values
-
A4_TRANSVERSE_PAPERSIZE
static final short A4_TRANSVERSE_PAPERSIZE
A4 Transverse - 210x297 mm- See Also:
- Constant Field Values
-
A4_PLUS_PAPERSIZE
static final short A4_PLUS_PAPERSIZE
A4 Plus - 210x330 mm- See Also:
- Constant Field Values
-
LETTER_ROTATED_PAPERSIZE
static final short LETTER_ROTATED_PAPERSIZE
US Letter Rotated 11 x 8 1/2 in- See Also:
- Constant Field Values
-
A4_ROTATED_PAPERSIZE
static final short A4_ROTATED_PAPERSIZE
A4 Rotated - 297x210 mm- See Also:
- Constant Field Values
-
-
Method Detail
-
setPaperSize
void setPaperSize(short size)
Set the paper size.- Parameters:
size- the paper size.
-
setScale
void setScale(short scale)
Set the scale.- Parameters:
scale- the scale to use
-
setPageStart
void setPageStart(short start)
Set the page numbering start.- Parameters:
start- the page numbering start
-
setFitWidth
void setFitWidth(short width)
Set the number of pages wide to fit the sheet in- Parameters:
width- the number of pages
-
setFitHeight
void setFitHeight(short height)
Set the number of pages high to fit the sheet in- Parameters:
height- the number of pages
-
setLeftToRight
void setLeftToRight(boolean ltor)
Set whether to go left to right or top down in ordering- Parameters:
ltor- left to right
-
setLandscape
void setLandscape(boolean ls)
Set whether to print in landscape- Parameters:
ls- landscape
-
setValidSettings
void setValidSettings(boolean valid)
Valid settings. I'm not for sure.- Parameters:
valid- Valid
-
setNoColor
void setNoColor(boolean mono)
Set whether it is black and white- Parameters:
mono- Black and white
-
setDraft
void setDraft(boolean d)
Set whether it is in draft mode- Parameters:
d- draft
-
setNotes
void setNotes(boolean printnotes)
Print the include notes- Parameters:
printnotes- print the notes
-
setNoOrientation
void setNoOrientation(boolean orientation)
Set no orientation. ?- Parameters:
orientation- Orientation.
-
setUsePage
void setUsePage(boolean page)
Set whether to use page start- Parameters:
page- Use page start
-
setHResolution
void setHResolution(short resolution)
Sets the horizontal resolution.- Parameters:
resolution- horizontal resolution
-
setVResolution
void setVResolution(short resolution)
Sets the vertical resolution.- Parameters:
resolution- vertical resolution
-
setHeaderMargin
void setHeaderMargin(double headermargin)
Sets the header margin.- Parameters:
headermargin- header margin
-
setFooterMargin
void setFooterMargin(double footermargin)
Sets the footer margin.- Parameters:
footermargin- footer margin
-
setCopies
void setCopies(short copies)
Sets the number of copies.- Parameters:
copies- number of copies
-
getPaperSize
short getPaperSize()
Returns the paper size.- Returns:
- paper size
-
getScale
short getScale()
Returns the scale.- Returns:
- scale
-
getPageStart
short getPageStart()
Returns the page start.- Returns:
- page start
-
getFitWidth
short getFitWidth()
Returns the number of pages wide to fit sheet in.- Returns:
- number of pages wide to fit sheet in
-
getFitHeight
short getFitHeight()
Returns the number of pages high to fit the sheet in.- Returns:
- number of pages high to fit the sheet in
-
getLeftToRight
boolean getLeftToRight()
Returns the left to right print order.- Returns:
- left to right print order
-
getLandscape
boolean getLandscape()
Returns the landscape mode.- Returns:
- landscape mode
-
getValidSettings
boolean getValidSettings()
Returns the valid settings.- Returns:
- valid settings
-
getNoColor
boolean getNoColor()
Returns the black and white setting.- Returns:
- black and white setting
-
getDraft
boolean getDraft()
Returns the draft mode.- Returns:
- draft mode
-
getNotes
boolean getNotes()
Returns the print notes.- Returns:
- print notes
-
getNoOrientation
boolean getNoOrientation()
Returns the no orientation.- Returns:
- no orientation
-
getUsePage
boolean getUsePage()
Returns the use page numbers.- Returns:
- use page numbers
-
getHResolution
short getHResolution()
Returns the horizontal resolution.- Returns:
- horizontal resolution
-
getVResolution
short getVResolution()
Returns the vertical resolution.- Returns:
- vertical resolution
-
getHeaderMargin
double getHeaderMargin()
Returns the header margin.- Returns:
- header margin
-
getFooterMargin
double getFooterMargin()
Returns the footer margin.- Returns:
- footer margin
-
getCopies
short getCopies()
Returns the number of copies.- Returns:
- number of copies
-
-