Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.PrintSetupRecord

Field Summary

Modifier and Type	Field and Description
private static final BitField	draft
private double	field_10_footermargin
private short	field_11_copies
private short	field_1_paper_size Constants for this are held in `PrintSetup`
private short	field_2_scale
private short	field_3_page_start
private short	field_4_fit_width
private short	field_5_fit_height
private short	field_6_options
private short	field_7_hresolution
private short	field_8_vresolution
private double	field_9_headermargin
private static final BitField	landscape
private static final BitField	lefttoright
private static final BitField	nocolor
private static final BitField	noOrientation
private static final BitField	notes
public static final short	sid
private static final BitField	usepage
private static final BitField	validsettings

Constructor Summary

Access	Constructor and Description
public	PrintSetupRecord()
public	PrintSetupRecord(PrintSetupRecord other)
public	PrintSetupRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public PrintSetupRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public short	getCopies()
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public boolean	getDraft()
public short	getFitHeight()
public short	getFitWidth()
public double	getFooterMargin()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public double	getHeaderMargin()
public short	getHResolution()
public boolean	getLandscape()
public boolean	getLeftToRight()
public boolean	getNoColor()
public boolean	getNoOrientation()
public boolean	getNotes()
public short	getOptions()
public short	getPageStart()
public short	getPaperSize()
public short	getScale()
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public boolean	getUsePage()
public boolean	getValidSettings()
public short	getVResolution()
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setCopies(short copies)
public void	setDraft(boolean d)
public void	setFitHeight(short height)
public void	setFitWidth(short width)
public void	setFooterMargin(double footermargin)
public void	setHeaderMargin(double headermargin)
public void	setHResolution(short resolution)
public void	setLandscape(boolean ls)
public void	setLeftToRight(boolean ltor)
public void	setNoColor(boolean mono)
public void	setNoOrientation(boolean orientation)
public void	setNotes(boolean printnotes)
public void	setOptions(short options)
public void	setPageStart(short start)
public void	setPaperSize(short size)
public void	setScale(short scale)
public void	setUsePage(boolean page)
public void	setValidSettings(boolean valid)
public void	setVResolution(short resolution)

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

draft	back to summary
private static final BitField draft

field_10_footermargin	back to summary
private double field_10_footermargin

field_11_copies	back to summary
private short field_11_copies

field_1_paper_size	back to summary
private short field_1_paper_size Constants for this are held in `PrintSetup`

field_2_scale	back to summary
private short field_2_scale

field_3_page_start	back to summary
private short field_3_page_start

field_4_fit_width	back to summary
private short field_4_fit_width

field_5_fit_height	back to summary
private short field_5_fit_height

field_6_options	back to summary
private short field_6_options

field_7_hresolution	back to summary
private short field_7_hresolution

field_8_vresolution	back to summary
private short field_8_vresolution

field_9_headermargin	back to summary
private double field_9_headermargin

landscape	back to summary
private static final BitField landscape

lefttoright	back to summary
private static final BitField lefttoright

nocolor	back to summary
private static final BitField nocolor

noOrientation	back to summary
private static final BitField noOrientation

notes	back to summary
private static final BitField notes

sid	back to summary
public static final short sid

usepage	back to summary
private static final BitField usepage

validsettings	back to summary
private static final BitField validsettings

Constructor Detail

PrintSetupRecord	back to summary
public PrintSetupRecord()

PrintSetupRecord	back to summary
public PrintSetupRecord(PrintSetupRecord other)

PrintSetupRecord	back to summary
public PrintSetupRecord(RecordInputStream in)

Method Detail

copy	back to summary
public PrintSetupRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:PrintSetupRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public PrintSetupRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:PrintSetupRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getCopies	back to summary
public short getCopies()

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getDraft	back to summary
public boolean getDraft()

getFitHeight	back to summary
public short getFitHeight()

getFitWidth	back to summary
public short getFitWidth()

getFooterMargin	back to summary
public double getFooterMargin()

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getHeaderMargin	back to summary
public double getHeaderMargin()

getHResolution	back to summary
public short getHResolution()

getLandscape	back to summary
public boolean getLandscape()

getLeftToRight	back to summary
public boolean getLeftToRight()

getNoColor	back to summary
public boolean getNoColor()

getNoOrientation	back to summary
public boolean getNoOrientation()

getNotes	back to summary
public boolean getNotes()

getOptions	back to summary
public short getOptions()

getPageStart	back to summary
public short getPageStart()

getPaperSize	back to summary
public short getPaperSize()

getScale	back to summary
public short getScale()

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short: he id for this record

getUsePage	back to summary
public boolean getUsePage()

getValidSettings	back to summary
public boolean getValidSettings()

getVResolution	back to summary
public short getVResolution()

serialize back to summary

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

setCopies	back to summary
public void setCopies(short copies)

setDraft	back to summary
public void setDraft(boolean d)

setFitHeight	back to summary
public void setFitHeight(short height)

setFitWidth	back to summary
public void setFitWidth(short width)

setFooterMargin	back to summary
public void setFooterMargin(double footermargin)

setHeaderMargin	back to summary
public void setHeaderMargin(double headermargin)

setHResolution	back to summary
public void setHResolution(short resolution)

setLandscape	back to summary
public void setLandscape(boolean ls)

setLeftToRight	back to summary
public void setLeftToRight(boolean ltor)

setNoColor	back to summary
public void setNoColor(boolean mono)

setNoOrientation	back to summary
public void setNoOrientation(boolean orientation)

setNotes	back to summary
public void setNotes(boolean printnotes)

setOptions	back to summary
public void setOptions(short options)

setPageStart	back to summary
public void setPageStart(short start)

setPaperSize	back to summary
public void setPaperSize(short size)

setScale	back to summary
public void setScale(short scale)

setUsePage	back to summary
public void setUsePage(boolean page)

setValidSettings	back to summary
public void setValidSettings(boolean valid)

setVResolution	back to summary
public void setVResolution(short resolution)

public final Class PrintSetupRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail