Top Description Fields Constructors Methods
org.apache.poi.hssf.usermodel

public Class HSSFPrintSetup

extends Object
implements PrintSetup
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.PrintSetup
Imports
org.apache.poi.hssf.record.PrintSetupRecord, org.apache.poi.ss.usermodel.PrintSetup
Used to modify the print setup.

Paper size constants have been added for the ones I have access to. They follow as:
public static final short PRINTER_DEFAULT_PAPERSIZE = 0;
public static final short LETTER_PAPERSIZE = 1;
public static final short LEGAL_PAPERSIZE = 5;
public static final short EXECUTIVE_PAPERSIZE = 7;
public static final short A4_PAPERSIZE = 9;
public static final short A5_PAPERSIZE = 11;
public static final short ENVELOPE_10_PAPERSIZE = 20;
public static final short ENVELOPE_DL_PAPERSIZE = 27;
public static final short ENVELOPE_CS_PAPERSIZE = 28;
public static final short ENVELOPE_MONARCH_PAPERSIZE = 37;

Field Summary

Modifier and TypeField and Description
pack-priv PrintSetupRecord
printSetupRecord

Constructor Summary

AccessConstructor and Description
protected
HSSFPrintSetup(PrintSetupRecord
the low level print setup record
printSetupRecord)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public short

Returns:

number of copies
getCopies()

Implements org.apache.poi.ss.usermodel.PrintSetup.getCopies.

Returns the number of copies.

public boolean

Returns:

draft mode
getDraft()

Implements org.apache.poi.ss.usermodel.PrintSetup.getDraft.

Returns the draft mode.

public short

Returns:

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

Implements org.apache.poi.ss.usermodel.PrintSetup.getFitHeight.

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

public short

Returns:

number of pages wide to fit sheet in
getFitWidth()

Implements org.apache.poi.ss.usermodel.PrintSetup.getFitWidth.

Returns the number of pages wide to fit sheet in.

public double

Returns:

footer margin
getFooterMargin()

Implements org.apache.poi.ss.usermodel.PrintSetup.getFooterMargin.

Returns the footer margin.

public double

Returns:

header margin
getHeaderMargin()

Implements org.apache.poi.ss.usermodel.PrintSetup.getHeaderMargin.

Returns the header margin.

public short

Returns:

horizontal resolution
getHResolution()

Implements org.apache.poi.ss.usermodel.PrintSetup.getHResolution.

Returns the horizontal resolution.

public boolean

Returns:

landscape mode
getLandscape()

Implements org.apache.poi.ss.usermodel.PrintSetup.getLandscape.

Returns the landscape mode.

public boolean

Returns:

left to right print order
getLeftToRight()

Implements org.apache.poi.ss.usermodel.PrintSetup.getLeftToRight.

Returns the left to right print order.

public boolean

Returns:

black and white setting
getNoColor()

Implements org.apache.poi.ss.usermodel.PrintSetup.getNoColor.

Returns the black and white setting.

public boolean

Returns:

no orientation
getNoOrientation()

Implements org.apache.poi.ss.usermodel.PrintSetup.getNoOrientation.

Returns the no orientation.

public boolean

Returns:

print notes
getNotes()

Implements org.apache.poi.ss.usermodel.PrintSetup.getNotes.

Returns the print notes.

public short

Returns:

bit flags for the options
getOptions()

Returns the bit flags for the options.

public short

Returns:

page start
getPageStart()

Implements org.apache.poi.ss.usermodel.PrintSetup.getPageStart.

Returns the page start.

public short

Returns:

paper size
getPaperSize()

Implements org.apache.poi.ss.usermodel.PrintSetup.getPaperSize.

Returns the paper size.

public short

Returns:

scale
getScale()

Implements org.apache.poi.ss.usermodel.PrintSetup.getScale.

Returns the scale.

public boolean

Returns:

use page numbers
getUsePage()

Implements org.apache.poi.ss.usermodel.PrintSetup.getUsePage.

Returns the use page numbers.

public boolean

Returns:

valid settings
getValidSettings()

Implements org.apache.poi.ss.usermodel.PrintSetup.getValidSettings.

Returns the valid settings.

public short

Returns:

vertical resolution
getVResolution()

Implements org.apache.poi.ss.usermodel.PrintSetup.getVResolution.

Returns the vertical resolution.

public void
setCopies(short
number of copies
copies)

Implements org.apache.poi.ss.usermodel.PrintSetup.setCopies.

Sets the number of copies.

public void
setDraft(boolean
draft
d)

Implements org.apache.poi.ss.usermodel.PrintSetup.setDraft.

Set whether it is in draft mode

public void
setFitHeight(short
the number of pages
height)

Implements org.apache.poi.ss.usermodel.PrintSetup.setFitHeight.

Set the number of pages high to fit the sheet in

public void
setFitWidth(short
the number of pages
width)

Implements org.apache.poi.ss.usermodel.PrintSetup.setFitWidth.

Set the number of pages wide to fit the sheet in

public void
setFooterMargin(double
footer margin
footermargin)

Implements org.apache.poi.ss.usermodel.PrintSetup.setFooterMargin.

Sets the footer margin.

public void
setHeaderMargin(double
header margin
headermargin)

Implements org.apache.poi.ss.usermodel.PrintSetup.setHeaderMargin.

Sets the header margin.

public void
setHResolution(short
horizontal resolution
resolution)

Implements org.apache.poi.ss.usermodel.PrintSetup.setHResolution.

Sets the horizontal resolution.

public void
setLandscape(boolean
landscape
ls)

Implements org.apache.poi.ss.usermodel.PrintSetup.setLandscape.

Set whether to print in landscape

public void
setLeftToRight(boolean
left to right
ltor)

Implements org.apache.poi.ss.usermodel.PrintSetup.setLeftToRight.

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

public void
setNoColor(boolean
Black and white
mono)

Implements org.apache.poi.ss.usermodel.PrintSetup.setNoColor.

Set whether it is black and white

public void
setNoOrientation(boolean
Orientation.
orientation)

Implements org.apache.poi.ss.usermodel.PrintSetup.setNoOrientation.

Set no orientation.

public void
setNotes(boolean
print the notes
printnotes)

Implements org.apache.poi.ss.usermodel.PrintSetup.setNotes.

Print the include notes

public void
setOptions(short
The bit flags for the options
options)

Sets the options flags.

public void
setPageStart(short
the page numbering start
start)

Implements org.apache.poi.ss.usermodel.PrintSetup.setPageStart.

Set the page numbering start.

public void
setPaperSize(short
the paper size.
size)

Implements org.apache.poi.ss.usermodel.PrintSetup.setPaperSize.

Set the paper size.

public void
setScale(short
the scale to use
scale)

Implements org.apache.poi.ss.usermodel.PrintSetup.setScale.

Set the scale.

public void
setUsePage(boolean
Use page start
page)

Implements org.apache.poi.ss.usermodel.PrintSetup.setUsePage.

Set whether to use page start

public void
setValidSettings(boolean
Valid
valid)

Implements org.apache.poi.ss.usermodel.PrintSetup.setValidSettings.

Valid settings.

public void
setVResolution(short
vertical resolution
resolution)

Implements org.apache.poi.ss.usermodel.PrintSetup.setVResolution.

Sets the vertical resolution.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

printSetupRecordback to summary
pack-priv PrintSetupRecord printSetupRecord

Constructor Detail

HSSFPrintSetupback to summary
protected HSSFPrintSetup(PrintSetupRecord printSetupRecord)

Constructor. Takes the low level print setup record.

Parameters
printSetupRecord:PrintSetupRecord

the low level print setup record

Method Detail

getCopiesback to summary
public short getCopies()

Implements org.apache.poi.ss.usermodel.PrintSetup.getCopies.

Returns the number of copies.

Returns:short

number of copies

getDraftback to summary
public boolean getDraft()

Implements org.apache.poi.ss.usermodel.PrintSetup.getDraft.

Returns the draft mode.

Returns:boolean

draft mode

getFitHeightback to summary
public short getFitHeight()

Implements org.apache.poi.ss.usermodel.PrintSetup.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()

Implements org.apache.poi.ss.usermodel.PrintSetup.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()

Implements org.apache.poi.ss.usermodel.PrintSetup.getFooterMargin.

Returns the footer margin.

Returns:double

footer margin

getHeaderMarginback to summary
public double getHeaderMargin()

Implements org.apache.poi.ss.usermodel.PrintSetup.getHeaderMargin.

Returns the header margin.

Returns:double

header margin

getHResolutionback to summary
public short getHResolution()

Implements org.apache.poi.ss.usermodel.PrintSetup.getHResolution.

Returns the horizontal resolution.

Returns:short

horizontal resolution

getLandscapeback to summary
public boolean getLandscape()

Implements org.apache.poi.ss.usermodel.PrintSetup.getLandscape.

Returns the landscape mode.

Returns:boolean

landscape mode

getLeftToRightback to summary
public boolean getLeftToRight()

Implements org.apache.poi.ss.usermodel.PrintSetup.getLeftToRight.

Returns the left to right print order.

Returns:boolean

left to right print order

getNoColorback to summary
public boolean getNoColor()

Implements org.apache.poi.ss.usermodel.PrintSetup.getNoColor.

Returns the black and white setting.

Returns:boolean

black and white setting

getNoOrientationback to summary
public boolean getNoOrientation()

Implements org.apache.poi.ss.usermodel.PrintSetup.getNoOrientation.

Returns the no orientation.

Returns:boolean

no orientation

getNotesback to summary
public boolean getNotes()

Implements org.apache.poi.ss.usermodel.PrintSetup.getNotes.

Returns the print notes.

Returns:boolean

print notes

getOptionsback to summary
public short getOptions()

Returns the bit flags for the options.

Returns:short

bit flags for the options

getPageStartback to summary
public short getPageStart()

Implements org.apache.poi.ss.usermodel.PrintSetup.getPageStart.

Returns the page start.

Returns:short

page start

getPaperSizeback to summary
public short getPaperSize()

Implements org.apache.poi.ss.usermodel.PrintSetup.getPaperSize.

Returns the paper size.

Returns:short

paper size

getScaleback to summary
public short getScale()

Implements org.apache.poi.ss.usermodel.PrintSetup.getScale.

Returns the scale.

Returns:short

scale

getUsePageback to summary
public boolean getUsePage()

Implements org.apache.poi.ss.usermodel.PrintSetup.getUsePage.

Returns the use page numbers.

Returns:boolean

use page numbers

getValidSettingsback to summary
public boolean getValidSettings()

Implements org.apache.poi.ss.usermodel.PrintSetup.getValidSettings.

Returns the valid settings.

Returns:boolean

valid settings

getVResolutionback to summary
public short getVResolution()

Implements org.apache.poi.ss.usermodel.PrintSetup.getVResolution.

Returns the vertical resolution.

Returns:short

vertical resolution

setCopiesback to summary
public void setCopies(short copies)

Implements org.apache.poi.ss.usermodel.PrintSetup.setCopies.

Sets the number of copies.

Parameters
copies:short

number of copies

setDraftback to summary
public void setDraft(boolean d)

Implements org.apache.poi.ss.usermodel.PrintSetup.setDraft.

Set whether it is in draft mode

Parameters
d:boolean

draft

setFitHeightback to summary
public void setFitHeight(short height)

Implements org.apache.poi.ss.usermodel.PrintSetup.setFitHeight.

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)

Implements org.apache.poi.ss.usermodel.PrintSetup.setFitWidth.

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)

Implements org.apache.poi.ss.usermodel.PrintSetup.setFooterMargin.

Sets the footer margin.

Parameters
footermargin:double

footer margin

setHeaderMarginback to summary
public void setHeaderMargin(double headermargin)

Implements org.apache.poi.ss.usermodel.PrintSetup.setHeaderMargin.

Sets the header margin.

Parameters
headermargin:double

header margin

setHResolutionback to summary
public void setHResolution(short resolution)

Implements org.apache.poi.ss.usermodel.PrintSetup.setHResolution.

Sets the horizontal resolution.

Parameters
resolution:short

horizontal resolution

setLandscapeback to summary
public void setLandscape(boolean ls)

Implements org.apache.poi.ss.usermodel.PrintSetup.setLandscape.

Set whether to print in landscape

Parameters
ls:boolean

landscape

setLeftToRightback to summary
public void setLeftToRight(boolean ltor)

Implements org.apache.poi.ss.usermodel.PrintSetup.setLeftToRight.

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)

Implements org.apache.poi.ss.usermodel.PrintSetup.setNoColor.

Set whether it is black and white

Parameters
mono:boolean

Black and white

setNoOrientationback to summary
public void setNoOrientation(boolean orientation)

Implements org.apache.poi.ss.usermodel.PrintSetup.setNoOrientation.

Set no orientation. ?

Parameters
orientation:boolean

Orientation.

setNotesback to summary
public void setNotes(boolean printnotes)

Implements org.apache.poi.ss.usermodel.PrintSetup.setNotes.

Print the include notes

Parameters
printnotes:boolean

print the notes

setOptionsback to summary
public void setOptions(short options)

Sets the options flags. Not advisable to do it directly.

Parameters
options:short

The bit flags for the options

setPageStartback to summary
public void setPageStart(short start)

Implements org.apache.poi.ss.usermodel.PrintSetup.setPageStart.

Set the page numbering start.

Parameters
start:short

the page numbering start

setPaperSizeback to summary
public void setPaperSize(short size)

Implements org.apache.poi.ss.usermodel.PrintSetup.setPaperSize.

Set the paper size.

Parameters
size:short

the paper size.

setScaleback to summary
public void setScale(short scale)

Implements org.apache.poi.ss.usermodel.PrintSetup.setScale.

Set the scale.

Parameters
scale:short

the scale to use

setUsePageback to summary
public void setUsePage(boolean page)

Implements org.apache.poi.ss.usermodel.PrintSetup.setUsePage.

Set whether to use page start

Parameters
page:boolean

Use page start

setValidSettingsback to summary
public void setValidSettings(boolean valid)

Implements org.apache.poi.ss.usermodel.PrintSetup.setValidSettings.

Valid settings. I'm not for sure.

Parameters
valid:boolean

Valid

setVResolutionback to summary
public void setVResolution(short resolution)

Implements org.apache.poi.ss.usermodel.PrintSetup.setVResolution.

Sets the vertical resolution.

Parameters
resolution:short

vertical resolution