Top Fields Methods
org.apache.poi.ss.usermodel

public Interface PrintSetup

Known Direct Implementers
org.apache.poi.hssf.usermodel.HSSFPrintSetup

Field Summary

Modifier and TypeField and Description
public static final short
A3_PAPERSIZE

A3 - 297x420 mm

public static final short
A4_EXTRA_PAPERSIZE

A4 Extra - 9.27 x 12.69 in

public static final short
A4_PAPERSIZE

A4 - 210x297 mm

public static final short
A4_PLUS_PAPERSIZE

A4 Plus - 210x330 mm

public static final short
A4_ROTATED_PAPERSIZE

A4 Rotated - 297x210 mm

public static final short
A4_SMALL_PAPERSIZE

A4 Small - 210x297 mm

public static final short
A4_TRANSVERSE_PAPERSIZE

A4 Transverse - 210x297 mm

public static final short
A5_PAPERSIZE

A5 - 148x210 mm

public static final short
B4_PAPERSIZE

B4 (JIS) 250x354 mm

public static final short
B5_PAPERSIZE

B5 (JIS) 182x257 mm

public static final short
ELEVEN_BY_SEVENTEEN_PAPERSIZE

11 x 17 in

public static final short
ENVELOPE_10_PAPERSIZE

US Envelope #10 4 1/8 x 9 1/2

public static final short
ENVELOPE_9_PAPERSIZE

US Envelope #9 3 7/8 x 8 7/8

public static final short
ENVELOPE_C3_PAPERSIZE

Envelope C3 324x458 mm

public static final short
ENVELOPE_C4_PAPERSIZE

Envelope C4 229x324 mm

public static final short
ENVELOPE_C5_PAPERSIZE

public static final short
ENVELOPE_C6_PAPERSIZE

Envelope C6 114x162 mm

public static final short
ENVELOPE_CS_PAPERSIZE

Envelope C5 162x229 mm

public static final short
ENVELOPE_DL_PAPERSIZE

Envelope DL 110x220 mm

public static final short
ENVELOPE_MONARCH_PAPERSIZE

public static final short
EXECUTIVE_PAPERSIZE

US Executive 7 1/4 x 10 1/2 in

public static final short
FOLIO8_PAPERSIZE

Folio 8 1/2 x 13 in

public static final short
LEDGER_PAPERSIZE

US Ledger 17 x 11 in

public static final short
LETTER_PAPERSIZE

US Letter 8 1/2 x 11 in

public static final short
LETTER_ROTATED_PAPERSIZE

US Letter Rotated 11 x 8 1/2 in

public static final short
LETTER_SMALL_PAGESIZE

US Letter Small 8 1/2 x 11 in

public static final short
NOTE8_PAPERSIZE

US Note 8 1/2 x 11 in

public static final short
PRINTER_DEFAULT_PAPERSIZE

Whatever the printer's default paper size is

public static final short
QUARTO_PAPERSIZE

Quarto 215x275 mm

public static final short
STATEMENT_PAPERSIZE

US Statement 5 1/2 x 8 1/2 in

public static final short
TABLOID_PAPERSIZE

US Tabloid 11 x 17 in

public static final short
TEN_BY_FOURTEEN_PAPERSIZE

10 x 14 in

Method Summary

Modifier and TypeMethod and Description
public short

Returns:

number of copies
getCopies()

Returns the number of copies.

public boolean

Returns:

draft mode
getDraft()

Returns the draft mode.

public short

Returns:

number of pages high to fit the sheet in
getFitHeight()

Returns the number of pages high to fit the sheet in.

public short

Returns:

number of pages wide to fit sheet in
getFitWidth()

Returns the number of pages wide to fit sheet in.

public double

Returns:

footer margin
getFooterMargin()

Returns the footer margin.

public double

Returns:

header margin
getHeaderMargin()

Returns the header margin.

public short

Returns:

horizontal resolution
getHResolution()

Returns the horizontal resolution.

public boolean

Returns:

landscape mode
getLandscape()

Returns the landscape mode.

public boolean

Returns:

left to right print order
getLeftToRight()

Returns the left to right print order.

public boolean

Returns:

black and white setting
getNoColor()

Returns the black and white setting.

public boolean

Returns:

no orientation
getNoOrientation()

Returns the no orientation.

public boolean

Returns:

print notes
getNotes()

Returns the print notes.

public short

Returns:

page start
getPageStart()

Returns the page start.

public short

Returns:

paper size
getPaperSize()

Returns the paper size.

public short

Returns:

scale
getScale()

Returns the scale.

public boolean

Returns:

use page numbers
getUsePage()

Returns the use page numbers.

public boolean

Returns:

valid settings
getValidSettings()

Returns the valid settings.

public short

Returns:

vertical resolution
getVResolution()

Returns the vertical resolution.

public void
setCopies(short
number of copies
copies)

Sets the number of copies.

public void
setDraft(boolean
draft
d)

Set whether it is in draft mode

public void
setFitHeight(short
the number of pages
height)

Set the number of pages high to fit the sheet in

public void
setFitWidth(short
the number of pages
width)

Set the number of pages wide to fit the sheet in

public void
setFooterMargin(double
footer margin
footermargin)

Sets the footer margin.

public void
setHeaderMargin(double
header margin
headermargin)

Sets the header margin.

public void
setHResolution(short
horizontal resolution
resolution)

Sets the horizontal resolution.

public void
setLandscape(boolean
landscape
ls)

Set whether to print in landscape

public void
setLeftToRight(boolean
left to right
ltor)

Set whether to go left to right or top down in ordering

public void
setNoColor(boolean
Black and white
mono)

Set whether it is black and white

public void
setNoOrientation(boolean
Orientation.
orientation)

Set no orientation.

public void
setNotes(boolean
print the notes
printnotes)

Print the include notes

public void
setPageStart(short
the page numbering start
start)

Set the page numbering start.

public void
setPaperSize(short
the paper size.
size)

Set the paper size.

public void
setScale(short
the scale to use
scale)

Set the scale.

public void
setUsePage(boolean
Use page start
page)

Set whether to use page start

public void
setValidSettings(boolean
Valid
valid)

Valid settings.

public void
setVResolution(short
vertical resolution
resolution)

Sets the vertical resolution.

Field Detail

A3_PAPERSIZEback to summary
public static final short A3_PAPERSIZE

A3 - 297x420 mm

A4_EXTRA_PAPERSIZEback to summary
public static final short A4_EXTRA_PAPERSIZE

A4 Extra - 9.27 x 12.69 in

A4_PAPERSIZEback to summary
public static final short A4_PAPERSIZE

A4 - 210x297 mm

A4_PLUS_PAPERSIZEback to summary
public static final short A4_PLUS_PAPERSIZE

A4 Plus - 210x330 mm

A4_ROTATED_PAPERSIZEback to summary
public static final short A4_ROTATED_PAPERSIZE

A4 Rotated - 297x210 mm

A4_SMALL_PAPERSIZEback to summary
public static final short A4_SMALL_PAPERSIZE

A4 Small - 210x297 mm

A4_TRANSVERSE_PAPERSIZEback to summary
public static final short A4_TRANSVERSE_PAPERSIZE

A4 Transverse - 210x297 mm

A5_PAPERSIZEback to summary
public static final short A5_PAPERSIZE

A5 - 148x210 mm

B4_PAPERSIZEback to summary
public static final short B4_PAPERSIZE

B4 (JIS) 250x354 mm

B5_PAPERSIZEback to summary
public static final short B5_PAPERSIZE

B5 (JIS) 182x257 mm

ELEVEN_BY_SEVENTEEN_PAPERSIZEback to summary
public static final short ELEVEN_BY_SEVENTEEN_PAPERSIZE

11 x 17 in

ENVELOPE_10_PAPERSIZEback to summary
public static final short ENVELOPE_10_PAPERSIZE

US Envelope #10 4 1/8 x 9 1/2

ENVELOPE_9_PAPERSIZEback to summary
public static final short ENVELOPE_9_PAPERSIZE

US Envelope #9 3 7/8 x 8 7/8

ENVELOPE_C3_PAPERSIZEback to summary
public static final short ENVELOPE_C3_PAPERSIZE

Envelope C3 324x458 mm

ENVELOPE_C4_PAPERSIZEback to summary
public static final short ENVELOPE_C4_PAPERSIZE

Envelope C4 229x324 mm

ENVELOPE_C5_PAPERSIZEback to summary
public static final short ENVELOPE_C5_PAPERSIZE
ENVELOPE_C6_PAPERSIZEback to summary
public static final short ENVELOPE_C6_PAPERSIZE

Envelope C6 114x162 mm

ENVELOPE_CS_PAPERSIZEback to summary
public static final short ENVELOPE_CS_PAPERSIZE

Envelope C5 162x229 mm

ENVELOPE_DL_PAPERSIZEback to summary
public static final short ENVELOPE_DL_PAPERSIZE

Envelope DL 110x220 mm

ENVELOPE_MONARCH_PAPERSIZEback to summary
public static final short ENVELOPE_MONARCH_PAPERSIZE
EXECUTIVE_PAPERSIZEback to summary
public static final short EXECUTIVE_PAPERSIZE

US Executive 7 1/4 x 10 1/2 in

FOLIO8_PAPERSIZEback to summary
public static final short FOLIO8_PAPERSIZE

Folio 8 1/2 x 13 in

LEDGER_PAPERSIZEback to summary
public static final short LEDGER_PAPERSIZE

US Ledger 17 x 11 in

LETTER_PAPERSIZEback to summary
public static final short LETTER_PAPERSIZE

US Letter 8 1/2 x 11 in

LETTER_ROTATED_PAPERSIZEback to summary
public static final short LETTER_ROTATED_PAPERSIZE

US Letter Rotated 11 x 8 1/2 in

LETTER_SMALL_PAGESIZEback to summary
public static final short LETTER_SMALL_PAGESIZE

US Letter Small 8 1/2 x 11 in

NOTE8_PAPERSIZEback to summary
public static final short NOTE8_PAPERSIZE

US Note 8 1/2 x 11 in

PRINTER_DEFAULT_PAPERSIZEback to summary
public static final short PRINTER_DEFAULT_PAPERSIZE

Whatever the printer's default paper size is

QUARTO_PAPERSIZEback to summary
public static final short QUARTO_PAPERSIZE

Quarto 215x275 mm

STATEMENT_PAPERSIZEback to summary
public static final short STATEMENT_PAPERSIZE

US Statement 5 1/2 x 8 1/2 in

TABLOID_PAPERSIZEback to summary
public static final short TABLOID_PAPERSIZE

US Tabloid 11 x 17 in

TEN_BY_FOURTEEN_PAPERSIZEback to summary
public static final short TEN_BY_FOURTEEN_PAPERSIZE

10 x 14 in

Method Detail

getCopiesback to summary
public short getCopies()

Returns the number of copies.

Returns:short

number of copies

getDraftback to summary
public boolean getDraft()

Returns the draft mode.

Returns:boolean

draft mode

getFitHeightback to summary
public short getFitHeight()

Returns the number of pages high to fit the sheet in.

Returns:short

number of pages high to fit the sheet in

getFitWidthback to summary
public short getFitWidth()

Returns the number of pages wide to fit sheet in.

Returns:short

number of pages wide to fit sheet in

getFooterMarginback to summary
public double getFooterMargin()

Returns the footer margin.

Returns:double

footer margin

getHeaderMarginback to summary
public double getHeaderMargin()

Returns the header margin.

Returns:double

header margin

getHResolutionback to summary
public short getHResolution()

Returns the horizontal resolution.

Returns:short

horizontal resolution

getLandscapeback to summary
public boolean getLandscape()

Returns the landscape mode.

Returns:boolean

landscape mode

getLeftToRightback to summary
public boolean getLeftToRight()

Returns the left to right print order.

Returns:boolean

left to right print order

getNoColorback to summary
public boolean getNoColor()

Returns the black and white setting.

Returns:boolean

black and white setting

getNoOrientationback to summary
public boolean getNoOrientation()

Returns the no orientation.

Returns:boolean

no orientation

getNotesback to summary
public boolean getNotes()

Returns the print notes.

Returns:boolean

print notes

getPageStartback to summary
public short getPageStart()

Returns the page start.

Returns:short

page start

getPaperSizeback to summary
public short getPaperSize()

Returns the paper size.

Returns:short

paper size

getScaleback to summary
public short getScale()

Returns the scale.

Returns:short

scale

getUsePageback to summary
public boolean getUsePage()

Returns the use page numbers.

Returns:boolean

use page numbers

getValidSettingsback to summary
public boolean getValidSettings()

Returns the valid settings.

Returns:boolean

valid settings

getVResolutionback to summary
public short getVResolution()

Returns the vertical resolution.

Returns:short

vertical resolution

setCopiesback to summary
public void setCopies(short copies)

Sets the number of copies.

Parameters
copies:short

number of copies

setDraftback to summary
public void setDraft(boolean d)

Set whether it is in draft mode

Parameters
d:boolean

draft

setFitHeightback to summary
public void setFitHeight(short height)

Set the number of pages high to fit the sheet in

Parameters
height:short

the number of pages

setFitWidthback to summary
public void setFitWidth(short width)

Set the number of pages wide to fit the sheet in

Parameters
width:short

the number of pages

setFooterMarginback to summary
public void setFooterMargin(double footermargin)

Sets the footer margin.

Parameters
footermargin:double

footer margin

setHeaderMarginback to summary
public void setHeaderMargin(double headermargin)

Sets the header margin.

Parameters
headermargin:double

header margin

setHResolutionback to summary
public void setHResolution(short resolution)

Sets the horizontal resolution.

Parameters
resolution:short

horizontal resolution

setLandscapeback to summary
public void setLandscape(boolean ls)

Set whether to print in landscape

Parameters
ls:boolean

landscape

setLeftToRightback to summary
public void setLeftToRight(boolean ltor)

Set whether to go left to right or top down in ordering

Parameters
ltor:boolean

left to right

setNoColorback to summary
public void setNoColor(boolean mono)

Set whether it is black and white

Parameters
mono:boolean

Black and white

setNoOrientationback to summary
public void setNoOrientation(boolean orientation)

Set no orientation. ?

Parameters
orientation:boolean

Orientation.

setNotesback to summary
public void setNotes(boolean printnotes)

Print the include notes

Parameters
printnotes:boolean

print the notes

setPageStartback to summary
public void setPageStart(short start)

Set the page numbering start.

Parameters
start:short

the page numbering start

setPaperSizeback to summary
public void setPaperSize(short size)

Set the paper size.

Parameters
size:short

the paper size.

setScaleback to summary
public void setScale(short scale)

Set the scale.

Parameters
scale:short

the scale to use

setUsePageback to summary
public void setUsePage(boolean page)

Set whether to use page start

Parameters
page:boolean

Use page start

setValidSettingsback to summary
public void setValidSettings(boolean valid)

Valid settings. I'm not for sure.

Parameters
valid:boolean

Valid

setVResolutionback to summary
public void setVResolution(short resolution)

Sets the vertical resolution.

Parameters
resolution:short

vertical resolution