Modifier and Type	Class and Description
private static class	PageSettingsBlock.PLSAggregate PLS is potentially a continued record, but is currently uninterpreted by POI

Modifier and Type	Field and Description
private Record	_bitmap
private BottomMarginRecord	_bottomMargin
private PageBreakRecord	_columnBreaksRecord
private FooterRecord	_footer
private HCenterRecord	_hCenter
private HeaderRecord	_header
private HeaderFooterRecord	_headerFooter
private LeftMarginRecord	_leftMargin
private final List<PageSettingsBlock.PLSAggregate>	_plsRecords
private PrintSetupRecord	_printSetup
private Record	_printSize
private RightMarginRecord	_rightMargin
private PageBreakRecord	_rowBreaksRecord
private final List<HeaderFooterRecord>	_sviewHeaderFooters HeaderFooterRecord records belonging to preceding CustomViewSettingsRecordAggregates.
private TopMarginRecord	_topMargin
private VCenterRecord	_vCenter

Access	Constructor and Description
public	PageSettingsBlock(RecordStream rs)
public	PageSettingsBlock() Creates a PageSettingsBlock with default settings

Method Summary

Modifier and Type	Method and Description
public void	addLateHeaderFooter(HeaderFooterRecord the HeaderFooterRecord to set rec) HEADERFOOTER is new in 2007.
public void	addLateRecords(RecordStream the RecordStream to read from rs) This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered.
private void	checkNotPresent(Record rec)
private static HCenterRecord	createHCenter() creates the HCenter Record and sets it to false (don't horizontally center)
private static PrintSetupRecord	Returns: record containing a PrintSetupRecord createPrintSetup() creates the PrintSetup Record and sets it to defaults and marks it invalid
private static VCenterRecord	createVCenter() creates the VCenter Record and sets it to false (don't horizontally center)
public int[]	Returns: all the column page breaks, never `null` getColumnBreaks()
private PageBreakRecord	getColumnBreaksRecord()
public FooterRecord	Returns: FooterRecord for the sheet. getFooter() Returns the FooterRecord.
public HCenterRecord	getHCenter()
public HeaderRecord	Returns: HeaderRecord for the sheet. getHeader() Returns the HeaderRecord.
public double	Returns: the size of the margin getMargin(short which margin to get margin) Gets the size of the margin in inches.
private Margin	getMarginRec(int marginIndex)
public int	Returns: the number of column page breaks getNumColumnBreaks()
public int	Returns: the number of row page breaks getNumRowBreaks()
public PrintSetupRecord	Returns: PrintSetupRecord for the sheet. getPrintSetup() Returns the PrintSetupRecord.
public int[]	Returns: all the horizontal page breaks, never `null` getRowBreaks()
private PageBreakRecord	getRowBreaksRecord()
public VCenterRecord	getVCenter()
public boolean	Returns: `true` if the specified column has a page break isColumnBroken(int the column to check for column) Queries if the specified column has a page break
public static boolean	Returns: `true` if the specified Record sid is one belonging to the 'Page Settings Block'. isComponentRecord(int the record sid sid)
public boolean	Returns: true if the specified row has a page break isRowBroken(int the row to check for row) Queries if the specified row has a page break
public void	positionRecords(List<RecordBase> the list of sheet records read so far sheetRecords) Some apps can define multiple HeaderFooterRecord records for a sheet.
private boolean	readARecord(RecordStream rs)
public void	removeColumnBreak(int the column to check for page breaks column) Removes a page break at the indicated column
public void	removeRowBreak(int the row row) Removes a page break at the indicated row
public void	setColumnBreak(short the column to add page breaks to column, short the starting row fromRow, short the ending row toRow) Sets a page break at the indicated column
public void	setFooter(FooterRecord The new FooterRecord for the sheet. newFooter) Sets the FooterRecord.
public void	setHeader(HeaderRecord The new HeaderRecord for the sheet. newHeader) Sets the HeaderRecord.
public void	setMargin(short which margin to get margin, double the size of the margin size) Sets the size of the margin in inches.
public void	setPrintSetup(PrintSetupRecord The new PrintSetupRecord for the sheet. newPrintSetup) Sets the PrintSetupRecord.
public void	setRowBreak(int the row row, short the starting column fromCol, short the ending column toCol) Sets a page break at the indicated row
private static void	shiftBreaks(PageBreakRecord The page record to be shifted breaks, int Starting "main" value to shift breaks start, int Ending "main" value to shift breaks stop, int number of units (rows/columns) to shift by count) Shifts all the page breaks in the range "count" number of rows/columns
public void	shiftColumnBreaks(short the starting column startingCol, short the ending column endingCol, short the number of columns to shift by count) Shifts the vertical page breaks for the indicated count
public void	shiftRowBreaks(int the starting row startingRow, int the ending row endingRow, int the number of rows to shift by count) Shifts the horizontal page breaks for the indicated count
public void	visitContainedRecords(RecordAggregate.RecordVisitor The visitor to use for callbacks while walking this object rv) Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords. Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file.
private static void	visitIfPresent(Record r, RecordAggregate.RecordVisitor rv)
private static void	visitIfPresent(PageBreakRecord r, RecordAggregate.RecordVisitor rv)

Inherited from org.apache.poi.hssf.record.aggregates.RecordAggregate:: getRecordSize serialize

Field Detail

_bitmap	back to summary
private Record _bitmap

_bottomMargin	back to summary
private BottomMarginRecord _bottomMargin

_columnBreaksRecord	back to summary
private PageBreakRecord _columnBreaksRecord

_footer	back to summary
private FooterRecord _footer

_hCenter	back to summary
private HCenterRecord _hCenter

_header	back to summary
private HeaderRecord _header

_headerFooter	back to summary
private HeaderFooterRecord _headerFooter

_leftMargin	back to summary
private LeftMarginRecord _leftMargin

_plsRecords	back to summary
private final List<PageSettingsBlock.PLSAggregate> _plsRecords

_printSetup	back to summary
private PrintSetupRecord _printSetup

_printSize	back to summary
private Record _printSize

_rightMargin	back to summary
private RightMarginRecord _rightMargin

_rowBreaksRecord	back to summary
private PageBreakRecord _rowBreaksRecord

_sviewHeaderFooters	back to summary
private final List<HeaderFooterRecord> _sviewHeaderFooters HeaderFooterRecord records belonging to preceding CustomViewSettingsRecordAggregates. The indicator of such records is a non-zero GUID, see `org.apache.poi.hssf.record.HeaderFooterRecord#getGuid()`

_topMargin	back to summary
private TopMarginRecord _topMargin

_vCenter	back to summary
private VCenterRecord _vCenter

Constructor Detail

PageSettingsBlock	back to summary
public PageSettingsBlock(RecordStream rs)

PageSettingsBlock	back to summary
public PageSettingsBlock() Creates a PageSettingsBlock with default settings

Method Detail

addLateHeaderFooter back to summary

addLateHeaderFooter	back to summary
public void addLateHeaderFooter(HeaderFooterRecord rec) HEADERFOOTER is new in 2007. Some apps seem to have scattered this record long after the `PageSettingsBlock` where it belongs. Parameters rec:HeaderFooterRecord the HeaderFooterRecord to set

public void addLateHeaderFooter(HeaderFooterRecord rec)

HEADERFOOTER is new in 2007. Some apps seem to have scattered this record long after the PageSettingsBlock where it belongs.

Parameters

rec:HeaderFooterRecord: the HeaderFooterRecord to set

addLateRecords	back to summary
public void addLateRecords(RecordStream rs) This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered. As each record is read, it is incorporated into this PageSettingsBlock. The latest Excel version seems to write the PageSettingsBlock uninterrupted. However there are several examples (that Excel reads OK) where these records are not written together: HEADER_FOOTER(0x089C) after WINDOW2 - This record is new in 2007. Some apps seem to have scattered this record long after the PageSettingsBlock where it belongs test samples: SharedFormulaTest.xls, ex44921-21902.xls, ex42570-20305.xls PLS, WSBOOL, PageSettingsBlock - WSBOOL is not a PSB record. This happens in the test sample file "NoGutsRecords.xls" and "WORKBOOK_in_capitals.xls" Margins after DIMENSION - All of PSB should be before DIMENSION. (Bug-47199) These were probably written by other applications (or earlier versions of Excel). It was decided to not write specific code for detecting each of these cases. POI now tolerates PageSettingsBlock records scattered all over the sheet record stream, and in any order, but does not allow duplicates of any of those records. Note - when POI writes out this PageSettingsBlock, the records will always be written in one consolidated block (in the standard ordering) regardless of how scattered the records were when they were originally read. Parameters rs:RecordStream the RecordStream to read from Exceptions RecordFormatException: if any PSB record encountered has the same type (sid) as a record that is already part of this PageSettingsBlock

addLateRecords

back to summary

public void addLateRecords(RecordStream rs)

This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered. As each record is read, it is incorporated into this PageSettingsBlock.

The latest Excel version seems to write the PageSettingsBlock uninterrupted. However there are several examples (that Excel reads OK) where these records are not written together:

HEADER_FOOTER(0x089C) after WINDOW2 - This record is new in 2007. Some apps seem to have scattered this record long after the PageSettingsBlock where it belongs test samples: SharedFormulaTest.xls, ex44921-21902.xls, ex42570-20305.xls
PLS, WSBOOL, PageSettingsBlock - WSBOOL is not a PSB record. This happens in the test sample file "NoGutsRecords.xls" and "WORKBOOK_in_capitals.xls"
Margins after DIMENSION - All of PSB should be before DIMENSION. (Bug-47199)

These were probably written by other applications (or earlier versions of Excel). It was decided to not write specific code for detecting each of these cases. POI now tolerates PageSettingsBlock records scattered all over the sheet record stream, and in any order, but does not allow duplicates of any of those records.

Note

- when POI writes out this PageSettingsBlock, the records will always be written in one consolidated block (in the standard ordering) regardless of how scattered the records were when they were originally read.

Parameters

rs:RecordStream: the RecordStream to read from

Exceptions

RecordFormatException:: if any PSB record encountered has the same type (sid) as a record that is already part of this PageSettingsBlock

checkNotPresent	back to summary
private void checkNotPresent(Record rec)

createHCenter	back to summary
private static HCenterRecord createHCenter() creates the HCenter Record and sets it to false (don't horizontally center)

createPrintSetup back to summary

createPrintSetup	back to summary
private static PrintSetupRecord createPrintSetup() creates the PrintSetup Record and sets it to defaults and marks it invalid Returns:PrintSetupRecord record containing a PrintSetupRecord See Also `org.apache.poi.hssf.record.PrintSetupRecord`, `org.apache.poi.hssf.record.Record`

private static PrintSetupRecord createPrintSetup()

creates the PrintSetup Record and sets it to defaults and marks it invalid

Returns:PrintSetupRecord: record containing a PrintSetupRecord
See Also: org.apache.poi.hssf.record.PrintSetupRecord, org.apache.poi.hssf.record.Record

createVCenter	back to summary
private static VCenterRecord createVCenter() creates the VCenter Record and sets it to false (don't horizontally center)

getColumnBreaks	back to summary
public int[] getColumnBreaks() Returns:int[] all the column page breaks, never `null`

getColumnBreaksRecord	back to summary
private PageBreakRecord getColumnBreaksRecord()

getFooter	back to summary
public FooterRecord getFooter() Returns the FooterRecord. Returns:FooterRecord FooterRecord for the sheet.

getFooter

back to summary

public FooterRecord getFooter()

Returns the FooterRecord.

Returns:FooterRecord: FooterRecord for the sheet.

getHCenter	back to summary
public HCenterRecord getHCenter()

getHeader	back to summary
public HeaderRecord getHeader() Returns the HeaderRecord. Returns:HeaderRecord HeaderRecord for the sheet.

getHeader

back to summary

public HeaderRecord getHeader()

Returns the HeaderRecord.

Returns:HeaderRecord: HeaderRecord for the sheet.

getMargin	back to summary
public double getMargin(short margin) Gets the size of the margin in inches. Parameters margin:short which margin to get Returns:double the size of the margin

getMargin

back to summary

public double getMargin(short margin)

Gets the size of the margin in inches.

Parameters

margin:short: which margin to get

Returns:double

the size of the margin

getMarginRec	back to summary
private Margin getMarginRec(int marginIndex)

getNumColumnBreaks	back to summary
public int getNumColumnBreaks() Returns:int the number of column page breaks

getNumRowBreaks	back to summary
public int getNumRowBreaks() Returns:int the number of row page breaks

getPrintSetup	back to summary
public PrintSetupRecord getPrintSetup() Returns the PrintSetupRecord. Returns:PrintSetupRecord PrintSetupRecord for the sheet.

getPrintSetup

back to summary

public PrintSetupRecord getPrintSetup()

Returns the PrintSetupRecord.

Returns:PrintSetupRecord: PrintSetupRecord for the sheet.

getRowBreaks	back to summary
public int[] getRowBreaks() Returns:int[] all the horizontal page breaks, never `null`

getRowBreaksRecord	back to summary
private PageBreakRecord getRowBreaksRecord()

getVCenter	back to summary
public VCenterRecord getVCenter()

isColumnBroken back to summary

isColumnBroken	back to summary
public boolean isColumnBroken(int column) Queries if the specified column has a page break Parameters column:int the column to check for Returns:boolean `true` if the specified column has a page break

public boolean isColumnBroken(int column)

Queries if the specified column has a page break

Parameters

column:int: the column to check for

Returns:boolean

true if the specified column has a page break

isComponentRecord	back to summary
public static boolean isComponentRecord(int sid) Parameters sid:int the record sid Returns:boolean `true` if the specified Record sid is one belonging to the 'Page Settings Block'.

isRowBroken	back to summary
public boolean isRowBroken(int row) Queries if the specified row has a page break Parameters row:int the row to check for Returns:boolean true if the specified row has a page break

isRowBroken

back to summary

public boolean isRowBroken(int row)

Queries if the specified row has a page break

Parameters

row:int: the row to check for

Returns:boolean

true if the specified row has a page break

positionRecords	back to summary
public void positionRecords(List<RecordBase> sheetRecords) Some apps can define multiple HeaderFooterRecord records for a sheet. When saving such a file Excel 2007 re-positions them according to the following rules: - take a HeaderFooterRecord and read 16-byte GUID at offset 12. If it is zero, it means the current sheet and the given HeaderFooterRecord belongs to this PageSettingsBlock - If GUID is not zero then search in preceding CustomViewSettingsRecordAggregates. Compare first 16 bytes of UserSViewBegin with the HeaderFooterRecord's GUID. If match, then append the HeaderFooterRecord to this CustomViewSettingsRecordAggregates Parameters sheetRecords:List<RecordBase> the list of sheet records read so far

positionRecords

back to summary

public void positionRecords(List<RecordBase> sheetRecords)

Some apps can define multiple HeaderFooterRecord records for a sheet. When saving such a file Excel 2007 re-positions them according to the following rules: - take a HeaderFooterRecord and read 16-byte GUID at offset 12. If it is zero, it means the current sheet and the given HeaderFooterRecord belongs to this PageSettingsBlock - If GUID is not zero then search in preceding CustomViewSettingsRecordAggregates. Compare first 16 bytes of UserSViewBegin with the HeaderFooterRecord's GUID. If match, then append the HeaderFooterRecord to this CustomViewSettingsRecordAggregates

Parameters

sheetRecords:List<RecordBase>: the list of sheet records read so far

readARecord	back to summary
private boolean readARecord(RecordStream rs)

removeColumnBreak	back to summary
public void removeColumnBreak(int column) Removes a page break at the indicated column Parameters column:int the column to check for page breaks

removeColumnBreak

back to summary

public void removeColumnBreak(int column)

Removes a page break at the indicated column

Parameters

column:int: the column to check for page breaks

removeRowBreak	back to summary
public void removeRowBreak(int row) Removes a page break at the indicated row Parameters row:int the row

removeRowBreak

back to summary

public void removeRowBreak(int row)

Removes a page break at the indicated row

Parameters

row:int: the row

setColumnBreak	back to summary
public void setColumnBreak(short column, short fromRow, short toRow) Sets a page break at the indicated column Parameters column:short the column to add page breaks to fromRow:short the starting row toRow:short the ending row

setColumnBreak

back to summary

public void setColumnBreak(short column, short fromRow, short toRow)

Sets a page break at the indicated column

Parameters

column:short: the column to add page breaks to
fromRow:short: the starting row
toRow:short: the ending row

setFooter	back to summary
public void setFooter(FooterRecord newFooter) Sets the FooterRecord. Parameters newFooter:FooterRecord The new FooterRecord for the sheet.

setFooter

back to summary

public void setFooter(FooterRecord newFooter)

Sets the FooterRecord.

Parameters

newFooter:FooterRecord: The new FooterRecord for the sheet.

setHeader

back to summary

public void setHeader(HeaderRecord newHeader)

Sets the HeaderRecord.

Parameters

newHeader:HeaderRecord: The new HeaderRecord for the sheet.

setMargin

back to summary

public void setMargin(short margin, double size)

Sets the size of the margin in inches.

Parameters

margin:short: which margin to get
size:double: the size of the margin

setPrintSetup

back to summary

public void setPrintSetup(PrintSetupRecord newPrintSetup)

Sets the PrintSetupRecord.

Parameters

newPrintSetup:PrintSetupRecord: The new PrintSetupRecord for the sheet.

setRowBreak

back to summary

public void setRowBreak(int row, short fromCol, short toCol)

Sets a page break at the indicated row

Parameters

row:int: the row
fromCol:short: the starting column
toCol:short: the ending column

shiftBreaks

back to summary

private static void shiftBreaks(PageBreakRecord breaks, int start, int stop, int count)

Shifts all the page breaks in the range "count" number of rows/columns

Parameters

breaks:PageBreakRecord: The page record to be shifted
start:int: Starting "main" value to shift breaks
stop:int: Ending "main" value to shift breaks
count:int: number of units (rows/columns) to shift by

shiftColumnBreaks

back to summary

public void shiftColumnBreaks(short startingCol, short endingCol, short count)

Shifts the vertical page breaks for the indicated count

Parameters

startingCol:short: the starting column
endingCol:short: the ending column
count:short: the number of columns to shift by

shiftRowBreaks

back to summary

public void shiftRowBreaks(int startingRow, int endingRow, int count)

Shifts the horizontal page breaks for the indicated count

Parameters

startingRow:int: the starting row
endingRow:int: the ending row
count:int: the number of rows to shift by

visitContainedRecords back to summary

public void visitContainedRecords(RecordAggregate.RecordVisitor rv)

Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Doc from org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file. Implementors may or may not return the actual Records being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify those Records after cloning

Parameters

rv:RecordAggregate.RecordVisitor: The visitor to use for callbacks while walking this object

Annotations

@Override

visitIfPresent	back to summary
private static void visitIfPresent(Record r, RecordAggregate.RecordVisitor rv)

visitIfPresent	back to summary
private static void visitIfPresent(PageBreakRecord r, RecordAggregate.RecordVisitor rv)

org.apache.poi.hssf.record.aggregates back to summary

private final Class PageSettingsBlock.PLSAggregate

Class Inheritance

extends RecordAggregate

java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.aggregates.RecordAggregate
org.apache.poi.hssf.record.aggregates.PageSettingsBlock.PLSAggregate

PLS is potentially a continued record, but is currently uninterpreted by POI

Field Summary

Modifier and Type	Field and Description
private final Record	_pls
private ContinueRecord[]	_plsContinues holds any continue records found after the PLS record.
private static final ContinueRecord[]	EMPTY_CONTINUE_RECORD_ARRAY

Constructor Summary

Access	Constructor and Description
public	PLSAggregate(RecordStream rs)

Method Summary

Modifier and Type	Method and Description
public void	visitContainedRecords(RecordAggregate.RecordVisitor The visitor to use for callbacks while walking this object rv) Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords. Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file.

Inherited from org.apache.poi.hssf.record.aggregates.RecordAggregate:: getRecordSize serialize

Field Detail

_pls	back to summary
private final Record _pls

_plsContinues	back to summary
private ContinueRecord[] _plsContinues holds any continue records found after the PLS record. This would not be required if PLS was properly interpreted. Currently, PLS is an `UnknownRecord` and does not automatically include any trailing `ContinueRecord`s.

EMPTY_CONTINUE_RECORD_ARRAY	back to summary
private static final ContinueRecord[] EMPTY_CONTINUE_RECORD_ARRAY

Constructor Detail

PLSAggregate	back to summary
public PLSAggregate(RecordStream rs)

Method Detail

visitContainedRecords back to summary

public void visitContainedRecords(RecordAggregate.RecordVisitor rv)

Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Doc from org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Parameters

rv:RecordAggregate.RecordVisitor: The visitor to use for callbacks while walking this object

Annotations

@Override

public final Class PageSettingsBlock

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PageSettingsBlock.PLSAggregate

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail