Package org.apache.poi.hssf.record
Class PrintSetupRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.PrintSetupRecord
-
- All Implemented Interfaces:
Duplicatable,GenericRecord
public final class PrintSetupRecord extends StandardRecord
Stores print setup options -- bogus for HSSF (and marked as such)- Since:
- 2.0-pre
-
-
Field Summary
Fields Modifier and Type Field Description static shortsid
-
Constructor Summary
Constructors Constructor Description PrintSetupRecord()PrintSetupRecord(PrintSetupRecord other)PrintSetupRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrintSetupRecordcopy()shortgetCopies()protected intgetDataSize()booleangetDraft()booleangetEndNotes()intgetErrors()shortgetFitHeight()shortgetFitWidth()doublegetFooterMargin()Map<String,Supplier<?>>getGenericProperties()HSSFRecordTypesgetGenericRecordType()doublegetHeaderMargin()shortgetHResolution()booleangetLandscape()booleangetLeftToRight()booleangetNoColor()booleangetNoOrientation()booleangetNotes()shortgetOptions()shortgetPageStart()shortgetPaperSize()shortgetScale()shortgetSid()return the non static version of the id for this record.booleangetUsePage()booleangetValidSettings()shortgetVResolution()voidserialize(LittleEndianOutput out)Write the data content of this BIFF record.voidsetCopies(short copies)voidsetDraft(boolean d)voidsetEndNotes(boolean flag)voidsetErrors(int mode)voidsetFitHeight(short height)voidsetFitWidth(short width)voidsetFooterMargin(double footermargin)voidsetHeaderMargin(double headermargin)voidsetHResolution(short resolution)voidsetLandscape(boolean ls)voidsetLeftToRight(boolean ltor)voidsetNoColor(boolean mono)voidsetNoOrientation(boolean orientation)voidsetNotes(boolean printnotes)voidsetOptions(short options)voidsetPageStart(short start)voidsetPaperSize(short size)voidsetScale(short scale)voidsetUsePage(boolean page)voidsetValidSettings(boolean valid)voidsetVResolution(short resolution)-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PrintSetupRecord
public PrintSetupRecord()
-
PrintSetupRecord
public PrintSetupRecord(PrintSetupRecord other)
-
PrintSetupRecord
public PrintSetupRecord(RecordInputStream in)
-
-
Method Detail
-
setPaperSize
public void setPaperSize(short size)
-
setScale
public void setScale(short scale)
-
setPageStart
public void setPageStart(short start)
-
setFitWidth
public void setFitWidth(short width)
-
setFitHeight
public void setFitHeight(short height)
-
setOptions
public void setOptions(short options)
-
setLeftToRight
public void setLeftToRight(boolean ltor)
-
setLandscape
public void setLandscape(boolean ls)
-
setValidSettings
public void setValidSettings(boolean valid)
-
setNoColor
public void setNoColor(boolean mono)
-
setDraft
public void setDraft(boolean d)
-
setNotes
public void setNotes(boolean printnotes)
-
setNoOrientation
public void setNoOrientation(boolean orientation)
-
setUsePage
public void setUsePage(boolean page)
-
setHResolution
public void setHResolution(short resolution)
-
setVResolution
public void setVResolution(short resolution)
-
setHeaderMargin
public void setHeaderMargin(double headermargin)
-
setFooterMargin
public void setFooterMargin(double footermargin)
-
setCopies
public void setCopies(short copies)
-
getPaperSize
public short getPaperSize()
-
getScale
public short getScale()
-
getPageStart
public short getPageStart()
-
getFitWidth
public short getFitWidth()
-
getFitHeight
public short getFitHeight()
-
getOptions
public short getOptions()
-
getLeftToRight
public boolean getLeftToRight()
-
getLandscape
public boolean getLandscape()
-
getValidSettings
public boolean getValidSettings()
-
getNoColor
public boolean getNoColor()
-
getDraft
public boolean getDraft()
-
getNotes
public boolean getNotes()
-
getNoOrientation
public boolean getNoOrientation()
-
getUsePage
public boolean getUsePage()
-
getHResolution
public short getHResolution()
-
getVResolution
public short getVResolution()
-
getHeaderMargin
public double getHeaderMargin()
-
getFooterMargin
public double getFooterMargin()
-
getCopies
public short getCopies()
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecordWrite 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
RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serializein classStandardRecord- Parameters:
out- the output object
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSizein classStandardRecord
-
getSid
public short getSid()
Description copied from class:Recordreturn the non static version of the id for this record.
-
copy
public PrintSetupRecord copy()
- Specified by:
copyin interfaceDuplicatable- Specified by:
copyin classStandardRecord- Returns:
- a deep copy of the implementing class / instance
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordTypein interfaceGenericRecord- Specified by:
getGenericRecordTypein classRecord
-
getEndNotes
public boolean getEndNotes()
-
getErrors
public int getErrors()
-
setEndNotes
public void setEndNotes(boolean flag)
-
setErrors
public void setErrors(int mode)
-
-